Skip to content
AWS for Query.Farm

aws.bedrock_agent.get_agent_alias

Example SQL Queries

SELECT * FROM
aws.bedrock_agent.get_agent_alias
WHERE
"agent_alias_id" = 'VALUE'
AND "agent_id" = 'VALUE';

Description

Gets information about an alias of an agent.

Table Definition

Column NameColumn Data Type
agent_alias_id Required Input Column

The unique identifier of the alias for which to get information.

VARCHAR
agent_id Required Input Column

The unique identifier of the agent to which the alias to get information belongs.

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_alias

Contains information about the alias.

STRUCT(
    "agent_alias_arn" VARCHAR,
    "agent_alias_history_events" STRUCT(
        "end_date" TIMESTAMP_S,
        "routing_configuration" STRUCT(
            "agent_version" VARCHAR,
            "provisioned_throughput" VARCHAR
        )[],
        "start_date" TIMESTAMP_S
    )[],
    "agent_alias_id" VARCHAR,
    "agent_alias_name" VARCHAR,
    "agent_alias_status" VARCHAR,
    "agent_id" VARCHAR,
    "client_token" VARCHAR,
    "created_at" TIMESTAMP_S,
    "description" VARCHAR,
    "failure_reasons" VARCHAR[],
    "routing_configuration" STRUCT(
        "agent_version" VARCHAR,
        "provisioned_throughput" VARCHAR
    )[],
    "updated_at" TIMESTAMP_S
)
Show child fields
agent_alias.agent_alias_arn

The Amazon Resource Name (ARN) of the alias of the agent.

agent_alias.agent_alias_history_events[]
Show child fields
agent_alias.agent_alias_history_events[].end_date

The date that the alias stopped being associated to the version in the routingConfiguration object

agent_alias.agent_alias_history_events[].routing_configuration[]
Show child fields
agent_alias.agent_alias_history_events[].routing_configuration[].agent_version

The version of the agent with which the alias is associated.

agent_alias.agent_alias_history_events[].routing_configuration[].provisioned_throughput

Information on the Provisioned Throughput assigned to an agent alias.

agent_alias.agent_alias_history_events[].start_date

The date that the alias began being associated to the version in the routingConfiguration object.

agent_alias.agent_alias_id

The unique identifier of the alias of the agent.

agent_alias.agent_alias_name

The name of the alias of the agent.

agent_alias.agent_alias_status

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

  • CREATING – The agent alias is being created.

  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

  • FAILED – The agent alias API operation failed.

  • UPDATING – The agent alias is being updated.

  • DELETING – The agent alias is being deleted.

agent_alias.agent_id

The unique identifier of the agent.

agent_alias.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_alias.created_at

The time at which the alias of the agent was created.

agent_alias.description

The description of the alias of the agent.

agent_alias.failure_reasons[]
agent_alias.routing_configuration[]
Show child fields
agent_alias.routing_configuration[].agent_version

The version of the agent with which the alias is associated.

agent_alias.routing_configuration[].provisioned_throughput

Information on the Provisioned Throughput assigned to an agent alias.

agent_alias.updated_at

The time at which the alias was last updated.