Skip to content
AWS for Query.Farm

aws.connect.describe_instance_storage_config

Example SQL Queries

SELECT * FROM
aws.connect.describe_instance_storage_config
WHERE
"instance_id" = 'VALUE'
AND "association_id" = 'VALUE'
AND "resource_type" = 'VALUE';

Description

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

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Table Definition

Column NameColumn Data Type
association_id Required Input Column

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

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
resource_type Required Input Column

A valid resource type.

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
storage_config

A valid storage type.

STRUCT(
    "association_id" VARCHAR,
    "storage_type" VARCHAR,
    "s3_config" STRUCT(
        "bucket_name" VARCHAR,
        "bucket_prefix" VARCHAR,
        "encryption_config" STRUCT(
            "encryption_type" VARCHAR,
            "key_id" VARCHAR
        )
    ),
    "kinesis_video_stream_config" STRUCT(
        "prefix" VARCHAR,
        "retention_period_hours" BIGINT,
        "encryption_config" STRUCT(
            "encryption_type" VARCHAR,
            "key_id" VARCHAR
        )
    ),
    "kinesis_stream_config" STRUCT(
        "stream_arn" VARCHAR
    ),
    "kinesis_firehose_config" STRUCT(
        "firehose_arn" VARCHAR
    )
)
Show child fields
storage_config.association_id

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

storage_config.kinesis_firehose_config

The configuration of the Kinesis Firehose delivery stream.

Show child fields
storage_config.kinesis_firehose_config.firehose_arn

The Amazon Resource Name (ARN) of the delivery stream.

storage_config.kinesis_stream_config

The configuration of the Kinesis data stream.

Show child fields
storage_config.kinesis_stream_config.stream_arn

The Amazon Resource Name (ARN) of the data stream.

storage_config.kinesis_video_stream_config

The configuration of the Kinesis video stream.

Show child fields
storage_config.kinesis_video_stream_config.encryption_config

The encryption configuration.

Show child fields
storage_config.kinesis_video_stream_config.encryption_config.encryption_type

The type of encryption.

storage_config.kinesis_video_stream_config.encryption_config.key_id

The full ARN of the encryption key.

Be sure to provide the full ARN of the encryption key, not just the ID.

Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .

storage_config.kinesis_video_stream_config.prefix

The prefix of the video stream.

storage_config.kinesis_video_stream_config.retention_period_hours

The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

storage_config.s3_config

The S3 bucket configuration.

Show child fields
storage_config.s3_config.bucket_name

The S3 bucket name.

storage_config.s3_config.bucket_prefix

The S3 bucket prefix.

storage_config.s3_config.encryption_config

The Amazon S3 encryption configuration.

Show child fields
storage_config.s3_config.encryption_config.encryption_type

The type of encryption.

storage_config.s3_config.encryption_config.key_id

The full ARN of the encryption key.

Be sure to provide the full ARN of the encryption key, not just the ID.

Amazon Connect supports only KMS keys with the default key spec of SYMMETRIC_DEFAULT .

storage_config.storage_type

A valid storage type.