Skip to content
AWS for Query.Farm

aws.connect.describe_authentication_profile

Example SQL Queries

SELECT * FROM
aws.connect.describe_authentication_profile
WHERE
"authentication_profile_id" = 'VALUE'
AND "instance_id" = 'VALUE';

Description

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

Describes the target authentication profile.

Table Definition

Column NameColumn Data Type
authentication_profile_id Required Input Column

A unique identifier for the authentication profile. 

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
authentication_profile

The authentication profile object being described.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "allowed_ips" VARCHAR[],
    "blocked_ips" VARCHAR[],
    "is_default" BOOLEAN,
    "created_time" TIMESTAMP_S,
    "last_modified_time" TIMESTAMP_S,
    "last_modified_region" VARCHAR,
    "periodic_session_duration" BIGINT,
    "max_session_duration" BIGINT
)
Show child fields
authentication_profile.allowed_ips[]
authentication_profile.arn

The Amazon Resource Name (ARN) for the authentication profile.

authentication_profile.blocked_ips[]
authentication_profile.created_time

The timestamp when the authentication profile was created.

authentication_profile.description

The description for the authentication profile.

authentication_profile.id

A unique identifier for the authentication profile.

authentication_profile.is_default

Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.

authentication_profile.last_modified_region

The Amazon Web Services Region where the authentication profile was last modified.

authentication_profile.last_modified_time

The timestamp when the authentication profile was last modified.

authentication_profile.max_session_duration

The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.

authentication_profile.name

The name for the authentication profile.

authentication_profile.periodic_session_duration

The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.