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

AssociateAnalyticsDataSet

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

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

Request Syntax


PUT /analytics-data/instance/InstanceId/association HTTP/1.1
Content-type: application/json

{
   "DataSetId": "string",
   "TargetAccountId": "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.

DataSetId

The identifier of the dataset to associate with the target account.

Type: String

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

Required: Yes

TargetAccountId

The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the AWS account that has the Amazon Connect instance.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DataSetId": "string",
   "ResourceShareArn": "string",
   "ResourceShareId": "string",
   "TargetAccountId": "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.

DataSetId

The identifier of the dataset that was associated.

Type: String

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

ResourceShareArn

The Amazon Resource Name (ARN) of the AWS Resource Access Manager share.

Type: String

ResourceShareId

The AWS Resource Access Manager share ID that is generated.

Type: String

TargetAccountId

The identifier of the target account.

Type: String

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