Skip to content
AWS for Query.Farm

aws.bedrock_agent.get_agent

Example SQL Queries

SELECT * FROM
aws.bedrock_agent.get_agent
WHERE
"agent_id" = 'VALUE';

Description

Gets information about an agent.

Table Definition

Column NameColumn Data Type
agent_id Required Input Column

The unique identifier of the agent.

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

Contains details about the agent.

STRUCT(
    "agent_arn" VARCHAR,
    "agent_id" VARCHAR,
    "agent_name" VARCHAR,
    "agent_resource_role_arn" VARCHAR,
    "agent_status" VARCHAR,
    "agent_version" VARCHAR,
    "client_token" VARCHAR,
    "created_at" TIMESTAMP_S,
    "customer_encryption_key_arn" VARCHAR,
    "description" VARCHAR,
    "failure_reasons" VARCHAR[],
    "foundation_model" VARCHAR,
    "guardrail_configuration" STRUCT(
        "guardrail_identifier" VARCHAR,
        "guardrail_version" VARCHAR
    ),
    "idle_session_ttl_in_seconds" BIGINT,
    "instruction" VARCHAR,
    "memory_configuration" STRUCT(
        "enabled_memory_types" VARCHAR[],
        "storage_days" BIGINT
    ),
    "prepared_at" TIMESTAMP_S,
    "prompt_override_configuration" STRUCT(
        "override_lambda" VARCHAR,
        "prompt_configurations" STRUCT(
            "base_prompt_template" VARCHAR,
            "inference_configuration" STRUCT(
                "maximum_length" BIGINT,
                "stop_sequences" VARCHAR[],
                "temperature" DOUBLE,
                "top_k" BIGINT,
                "top_p" DOUBLE
            ),
            "parser_mode" VARCHAR,
            "prompt_creation_mode" VARCHAR,
            "prompt_state" VARCHAR,
            "prompt_type" VARCHAR
        )[]
    ),
    "recommended_actions" VARCHAR[],
    "updated_at" TIMESTAMP_S
)
Show child fields
agent.agent_arn

The Amazon Resource Name (ARN) of the agent.

agent.agent_id

The unique identifier of the agent.

agent.agent_name

The name of the agent.

agent.agent_resource_role_arn

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

agent.agent_status

The status of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent is being created.

  • PREPARING – The agent is being prepared.

  • PREPARED – The agent is prepared and ready to be invoked.

  • NOT_PREPARED – The agent has been created but not yet prepared.

  • FAILED – The agent API operation failed.

  • UPDATING – The agent is being updated.

  • DELETING – The agent is being deleted.

agent.agent_version

The version of the agent.

agent.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.created_at

The time at which the agent was created.

agent.customer_encryption_key_arn

The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

agent.description

The description of the agent.

agent.failure_reasons[]
agent.foundation_model

The foundation model used for orchestration by the agent.

agent.guardrail_configuration

Details about the guardrail associated with the agent.

Show child fields
agent.guardrail_configuration.guardrail_identifier

The unique identifier of the guardrail.

agent.guardrail_configuration.guardrail_version

The version of the guardrail.

agent.idle_session_ttl_in_seconds

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

agent.instruction

Instructions that tell the agent what it should do and how it should interact with users.

agent.memory_configuration

Contains memory configuration for the agent.

Show child fields
agent.memory_configuration.enabled_memory_types[]
agent.memory_configuration.storage_days

The number of days the agent is configured to retain the conversational context.

agent.prepared_at

The time at which the agent was last prepared.

agent.prompt_override_configuration

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

Show child fields
agent.prompt_override_configuration.override_lambda

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Agents for Amazon Bedrock.

agent.prompt_override_configuration.prompt_configurations[]
Show child fields
agent.prompt_override_configuration.prompt_configurations[].base_prompt_template

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.

agent.prompt_override_configuration.prompt_configurations[].inference_configuration

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

Show child fields
agent.prompt_override_configuration.prompt_configurations[].inference_configuration.maximum_length

The maximum number of tokens to allow in the generated response.

agent.prompt_override_configuration.prompt_configurations[].inference_configuration.stop_sequences[]
agent.prompt_override_configuration.prompt_configurations[].inference_configuration.temperature

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

agent.prompt_override_configuration.prompt_configurations[].inference_configuration.top_k

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

agent.prompt_override_configuration.prompt_configurations[].inference_configuration.top_p

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

agent.prompt_override_configuration.prompt_configurations[].parser_mode

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

agent.prompt_override_configuration.prompt_configurations[].prompt_creation_mode

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

agent.prompt_override_configuration.prompt_configurations[].prompt_state

Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

  • PRE_PROCESSING – ENABLED

  • ORCHESTRATION – ENABLED

  • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

  • POST_PROCESSING – DISABLED

agent.prompt_override_configuration.prompt_configurations[].prompt_type

The step in the agent sequence that this prompt configuration applies to.

agent.recommended_actions[]
agent.updated_at

The time at which the agent was last updated.