Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateInstanceStorageConfig

This API is in preview release for Amazon Connect 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.

Request Syntax


PUT /instance/InstanceId/storage-config HTTP/1.1
Content-type: application/json

{
   "ResourceType": "string",
   "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"
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ResourceType

A valid resource type. To enable streaming for real-time analysis of contacts, use the following types:

For chat contacts, use REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS.
For voice contacts, use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

Note

REAL_TIME_CONTACT_ANALYSIS_SEGMENTS is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS for voice contacts moving forward.

If you have previously associated a stream with REAL_TIME_CONTACT_ANALYSIS_SEGMENTS, no action is needed to update the stream to REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS.

Type: String

Required: Yes

StorageConfig

A valid storage type.

Type: InstanceStorageConfig object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AssociationId": "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.

AssociationId

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

Type: String

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

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

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429