DescribeInstanceStorageConfig - Amazon Connect

DescribeInstanceStorageConfig

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.

Request Syntax

GET /instance/InstanceId/storage-config/AssociationId?resourceType=ResourceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AssociationId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

InstanceId

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

ResourceType

A valid resource type.

Valid Values: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "StorageConfig": { "AssociationId": "string", "KinesisFirehoseConfig": { "FirehoseArn": "string" }, "KinesisStreamConfig": { "StreamArn": "string" }, "KinesisVideoStreamConfig": { "EncryptionConfig": { "EncryptionType": "string", "KeyId": "string" }, "Prefix": "string", "RetentionPeriodHours": number }, "S3Config": { "BucketName": "string", "BucketPrefix": "string", "EncryptionConfig": { "EncryptionType": "string", "KeyId": "string" } }, "StorageType": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StorageConfig

A valid storage type.

Type: InstanceStorageConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: