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

CreateDataIntegrationAssociation

Creates and persists a DataIntegrationAssociation resource.

Request Syntax


POST /dataIntegrations/Identifier/associations HTTP/1.1
Content-type: application/json

{
   "ClientAssociationMetadata": { 
      "string" : "string" 
   },
   "ClientId": "string",
   "ClientToken": "string",
   "DestinationURI": "string",
   "ExecutionConfiguration": { 
      "ExecutionMode": "string",
      "OnDemandConfiguration": { 
         "EndTime": "string",
         "StartTime": "string"
      },
      "ScheduleConfiguration": { 
         "FirstExecutionFrom": "string",
         "Object": "string",
         "ScheduleExpression": "string"
      }
   },
   "ObjectConfiguration": { 
      "string" : { 
         "string" : [ "string" ]
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

Identifier

A unique identifier for the DataIntegration.

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

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientAssociationMetadata

The mapping of metadata to be extracted from the data.

Type: String to string map

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

Key Pattern: .*\S.*

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

Value Pattern: .*\S.*

Required: No

ClientId

The identifier for the client that is associated with the DataIntegration association.

Type: String

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

Pattern: .*

Required: No

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

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

Pattern: .*

Required: No

DestinationURI

The URI of the data destination.

Type: String

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

Pattern: ^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)

Required: No

ExecutionConfiguration

The configuration for how the files should be pulled from the source.

Type: ExecutionConfiguration object

Required: No

ObjectConfiguration

The configuration for what data should be pulled from the source.

Type: String to string to array of strings map map

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

Key Pattern: .*\S.*

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

Key Pattern: .*\S.*

Array Members: Minimum number of 1 item. Maximum number of 2048 items.

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

Pattern: ^[a-zA-Z0-9\/\._\-]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DataIntegrationArn": "string",
   "DataIntegrationAssociationId": "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.

DataIntegrationArn

The Amazon Resource Name (ARN) for the DataIntegration.

Type: String

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

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

DataIntegrationAssociationId

A unique identifier. for the DataIntegrationAssociation.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceError

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ResourceQuotaExceededException

The allowed quota for the resource has been exceeded.

HTTP Status Code: 429

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429