Skip to content
AWS for Query.Farm

aws.chime_sdk_identity.describe_app_instance_user_endpoint

Example SQL Queries

SELECT * FROM
aws.chime_sdk_identity.describe_app_instance_user_endpoint
WHERE
"app_instance_user_arn" = 'VALUE'
AND "endpoint_id" = 'VALUE';

Description

Returns the full details of an AppInstanceUserEndpoint.

Table Definition

Column NameColumn Data Type
app_instance_user_arn Required Input Column

The ARN of the AppInstanceUser.

VARCHAR
endpoint_id Required Input Column

The unique identifier of the AppInstanceUserEndpoint.

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.

app_instance_user_endpoint

The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.

STRUCT(
    "app_instance_user_arn" VARCHAR,
    "endpoint_id" VARCHAR,
    "name" VARCHAR,
    "type" VARCHAR,
    "resource_arn" VARCHAR,
    "endpoint_attributes" STRUCT(
        "device_token" VARCHAR,
        "voip_device_token" VARCHAR
    ),
    "created_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S,
    "allow_messages" VARCHAR,
    "endpoint_state" STRUCT(
        "status" VARCHAR,
        "status_reason" VARCHAR
    )
)
Show child fields
app_instance_user_endpoint.allow_messages

Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

app_instance_user_endpoint.app_instance_user_arn

The ARN of the AppInstanceUser.

app_instance_user_endpoint.created_timestamp

The time at which an AppInstanceUserEndpoint was created.

app_instance_user_endpoint.endpoint_attributes

The attributes of an Endpoint.

Show child fields
app_instance_user_endpoint.endpoint_attributes.device_token

The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.

app_instance_user_endpoint.endpoint_attributes.voip_device_token

The VOIP device token for the APNS and APNS_SANDBOX endpoint types.

app_instance_user_endpoint.endpoint_id

The unique identifier of the AppInstanceUserEndpoint.

app_instance_user_endpoint.endpoint_state

A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:

  • ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.

  • INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.

  • INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token

  • INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.

Show child fields
app_instance_user_endpoint.endpoint_state.status

Enum that indicates the Status of an AppInstanceUserEndpoint.

app_instance_user_endpoint.endpoint_state.status_reason

The reason for the EndpointStatus.

app_instance_user_endpoint.last_updated_timestamp

The time at which an AppInstanceUserEndpoint was last updated.

app_instance_user_endpoint.name

The name of the AppInstanceUserEndpoint.

app_instance_user_endpoint.resource_arn

The ARN of the resource to which the endpoint belongs.

app_instance_user_endpoint.type

The type of the AppInstanceUserEndpoint.