instance_storage_configs

Creates, updates, deletes, gets or lists an instance_storage_configs resource.

Overview

Name	instance_storage_configs
Type	Resource
Id	aws.connect.instance_storage_configs

Fields

The following fields are returned by SELECT queries:

describe_instance_storage_config

Name	Datatype	Description
association_id	string	The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
kinesis_firehose_config	object	The configuration of the Kinesis Firehose delivery stream.
kinesis_stream_config	object	The configuration of the Kinesis data stream.
kinesis_video_stream_config	object	The configuration of the Kinesis video stream.
s3_config	object	The S3 bucket configuration.
storage_type	string	A valid storage type. (S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE)

list_instance_storage_configs

Name	Datatype	Description
association_id	string	The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
kinesis_firehose_config	object	The configuration of the Kinesis Firehose delivery stream.
kinesis_stream_config	object	The configuration of the Kinesis data stream.
kinesis_video_stream_config	object	The configuration of the Kinesis video stream.
s3_config	object	The S3 bucket configuration.
storage_type	string	A valid storage type. (S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_storage_config	select	instance_id, association_id, region	resourceType	This API is in preview release for Connect Customer and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.
list_instance_storage_configs	select	instance_id, region	resourceType, nextToken, maxResults	This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.
associate_instance_storage_config	update	instance_id, region, ResourceType, StorageConfig		This API is in preview release for Connect Customer and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
update_instance_storage_config	update	instance_id, association_id, region, StorageConfig	resourceType	This API is in preview release for Connect Customer and is subject to change. Updates an existing configuration for a resource type. This API is idempotent.
disassociate_instance_storage_config	update	instance_id, association_id, region	resourceType, clientToken	This API is in preview release for Connect Customer and is subject to change. Removes the storage type configurations for the specified resource type and association ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
association_id	string	The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
instance_id	string	The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
region	string	AWS region (default: us-east-1)
clientToken	string	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
resourceType	string	A valid resource type.

SELECT examples

describe_instance_storage_config

This API is in preview release for Connect Customer and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

SELECT
association_id,
kinesis_firehose_config,
kinesis_stream_config,
kinesis_video_stream_config,
s3_config,
storage_type
FROM aws.connect.instance_storage_configs
WHERE instance_id = '{{ instance_id }}' -- required
AND association_id = '{{ association_id }}' -- required
AND region = '{{ region }}' -- required
AND resourceType = '{{ resourceType }}'
;

list_instance_storage_configs

This API is in preview release for Connect Customer and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.

SELECT
association_id,
kinesis_firehose_config,
kinesis_stream_config,
kinesis_video_stream_config,
s3_config,
storage_type
FROM aws.connect.instance_storage_configs
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND resourceType = '{{ resourceType }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

UPDATE examples

associate_instance_storage_config

This API is in preview release for Connect Customer and is subject to change. Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

UPDATE aws.connect.instance_storage_configs
SET 
ResourceType = '{{ ResourceType }}',
StorageConfig = '{{ StorageConfig }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND region = '{{ region }}' --required
AND ResourceType = '{{ ResourceType }}' --required
AND StorageConfig = '{{ StorageConfig }}' --required
RETURNING
association_id;

update_instance_storage_config

This API is in preview release for Connect Customer and is subject to change. Updates an existing configuration for a resource type. This API is idempotent.

UPDATE aws.connect.instance_storage_configs
SET 
StorageConfig = '{{ StorageConfig }}',
ClientToken = '{{ ClientToken }}'
WHERE 
instance_id = '{{ instance_id }}' --required
AND association_id = '{{ association_id }}' --required
AND region = '{{ region }}' --required
AND StorageConfig = '{{ StorageConfig }}' --required
AND resourceType = '{{ resourceType}}';

disassociate_instance_storage_config

This API is in preview release for Connect Customer and is subject to change. Removes the storage type configurations for the specified resource type and association ID.

UPDATE aws.connect.instance_storage_configs
SET 
-- No updatable properties
WHERE 
instance_id = '{{ instance_id }}' --required
AND association_id = '{{ association_id }}' --required
AND region = '{{ region }}' --required
AND resourceType = '{{ resourceType}}'
AND clientToken = '{{ clientToken}}';