Skip to content
AWS for Query.Farm

aws.chime.get_retention_settings

Example SQL Queries

SELECT * FROM
aws.chime.get_retention_settings
WHERE
"account_id" = 'VALUE';

Description

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Table Definition

Column NameColumn Data Type
account_id Required Input Column

The Amazon Chime account ID.

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.

initiate_deletion_timestamp

The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

TIMESTAMP_S
retention_settings

The retention settings.

STRUCT(
    "room_retention_settings" STRUCT(
        "retention_days" BIGINT
    ),
    "conversation_retention_settings" STRUCT(
        "retention_days" BIGINT
    )
)
Show child fields
retention_settings.conversation_retention_settings

The chat conversation retention settings.

Show child fields
retention_settings.conversation_retention_settings.retention_days

The number of days for which to retain conversation messages.

retention_settings.room_retention_settings

The chat room retention settings.

Show child fields
retention_settings.room_retention_settings.retention_days

The number of days for which to retain chat-room messages.