Skip to content
AWS for Query.Farm

aws.connect.describe_agent_status

Example SQL Queries

SELECT * FROM
aws.connect.describe_agent_status
WHERE
"instance_id" = 'VALUE'
AND "agent_status_id" = 'VALUE';

Description

This API is in preview release for Amazon Connect and is subject to change.

Describes an agent status.

Table Definition

Column NameColumn Data Type
agent_status_id Required Input Column

The identifier for the agent status.

VARCHAR
instance_id Required Input Column

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
agent_status

The agent status.

STRUCT(
    "agent_status_arn" VARCHAR,
    "agent_status_id" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "type" VARCHAR,
    "display_order" BIGINT,
    "state" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "last_modified_time" TIMESTAMP_S,
    "last_modified_region" VARCHAR
)
Show child fields
agent_status.agent_status_arn

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

agent_status.agent_status_id

The identifier of the agent status.

agent_status.description

The description of the agent status.

agent_status.display_order

The display order of the agent status.

agent_status.last_modified_region

The Amazon Web Services Region where this resource was last modified.

agent_status.last_modified_time

The timestamp when this resource was last modified.

agent_status.name

The name of the agent status.

agent_status.state

The state of the agent status.

agent_status.tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

agent_status.type

The type of agent status.