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

BatchAssociateAnalyticsDataSet

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

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

Request Syntax


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

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

DataSetIds

An array of dataset identifiers to associate.

Type: Array of strings

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

{
   "Created": [ 
      { 
         "DataSetId": "string",
         "ResourceShareArn": "string",
         "ResourceShareId": "string",
         "TargetAccountId": "string"
      }
   ],
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "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.

Created

Information about associations that are successfully created: DataSetId, TargetAccountId, ResourceShareId, ResourceShareArn.

Type: Array of AnalyticsDataAssociationResult objects

Errors

A list of errors for datasets that aren't successfully associated with the target account.

Type: Array of ErrorResult objects

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