Skip to content
AWS for Query.Farm

aws.bedrock_agent.get_agent_action_group

Example SQL Queries

SELECT * FROM
aws.bedrock_agent.get_agent_action_group
WHERE
"action_group_id" = 'VALUE'
AND "agent_id" = 'VALUE'
AND "agent_version" = 'VALUE';

Description

Gets information about an action group for an agent.

Table Definition

Column NameColumn Data Type
action_group_id Required Input Column

The unique identifier of the action group for which to get information.

VARCHAR
agent_id Required Input Column

The unique identifier of the agent that the action group belongs to.

VARCHAR
agent_version Required Input Column

The version of the agent that the action group belongs to.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

agent_action_group

Contains details about the action group.

STRUCT(
    "action_group_executor" STRUCT(
        "custom_control" VARCHAR,
        "lambda" VARCHAR
    ),
    "action_group_id" VARCHAR,
    "action_group_name" VARCHAR,
    "action_group_state" VARCHAR,
    "agent_id" VARCHAR,
    "agent_version" VARCHAR,
    "api_schema" STRUCT(
        "payload" VARCHAR,
        "s3" STRUCT(
            "s3_bucket_name" VARCHAR,
            "s3_object_key" VARCHAR
        )
    ),
    "client_token" VARCHAR,
    "created_at" TIMESTAMP_S,
    "description" VARCHAR,
    "function_schema" STRUCT(
        "functions" STRUCT(
            "description" VARCHAR,
            "name" VARCHAR,
            "parameters" MAP(VARCHAR, STRUCT(
                    "description" VARCHAR,
                    "required" BOOLEAN,
                    "type" VARCHAR
                )),
            "require_confirmation" VARCHAR
        )[]
    ),
    "parent_action_signature" VARCHAR,
    "updated_at" TIMESTAMP_S
)
Show child fields
agent_action_group.action_group_executor

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Show child fields
agent_action_group.action_group_executor.custom_control

To return the action group invocation results directly in the InvokeAgent response, specify RETURN_CONTROL.

agent_action_group.action_group_executor.lambda

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

agent_action_group.action_group_id

The unique identifier of the action group.

agent_action_group.action_group_name

The name of the action group.

agent_action_group.action_group_state

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

agent_action_group.agent_id

The unique identifier of the agent to which the action group belongs.

agent_action_group.agent_version

The version of the agent to which the action group belongs.

agent_action_group.api_schema

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Show child fields
agent_action_group.api_schema.payload

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

agent_action_group.api_schema.s3

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

Show child fields
agent_action_group.api_schema.s3.s3_bucket_name

The name of the S3 bucket.

agent_action_group.api_schema.s3.s3_object_key

The S3 object key for the S3 resource.

agent_action_group.client_token

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

agent_action_group.created_at

The time at which the action group was created.

agent_action_group.description

The description of the action group.

agent_action_group.function_schema

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

Show child fields
agent_action_group.function_schema.functions[]
Show child fields
agent_action_group.function_schema.functions[].description

A description of the function and its purpose.

agent_action_group.function_schema.functions[].name

A name for the function.

agent_action_group.function_schema.functions[].parameters

The parameters that the agent elicits from the user to fulfill the function.

agent_action_group.function_schema.functions[].require_confirmation

Contains information if user confirmation is required to invoke the function.

agent_action_group.parent_action_signature

If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

agent_action_group.updated_at

The time at which the action group was last updated.