CreateDataIntegration - Amazon AppIntegrations

CreateDataIntegration

Creates and persists a DataIntegration resource.

Note

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.

Request Syntax

POST /dataIntegrations HTTP/1.1 Content-type: application/json { "ClientToken": "string", "Description": "string", "KmsKey": "string", "Name": "string", "ScheduleConfig": { "FirstExecutionFrom": "string", "Object": "string", "ScheduleExpression": "string" }, "SourceURI": "string", "Tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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

Description

A description of the DataIntegration.

Type: String

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

Pattern: .*

Required: No

KmsKey

The KMS key for the DataIntegration.

Type: String

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

Pattern: .*\S.*

Required: Yes

Name

The name of the DataIntegration.

Type: String

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

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

Required: Yes

ScheduleConfig

The name of the data and how often it should be pulled from the source.

Type: ScheduleConfiguration object

Required: Yes

SourceURI

The URI of the data source.

Type: String

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

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

Required: Yes

Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "ClientToken": "string", "Description": "string", "Id": "string", "KmsKey": "string", "Name": "string", "ScheduleConfiguration": { "FirstExecutionFrom": "string", "Object": "string", "ScheduleExpression": "string" }, "SourceURI": "string", "Tags": { "string" : "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.

Arn

The Amazon Resource Name (ARN)

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}$

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: .*

Description

A description of the DataIntegration.

Type: String

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

Pattern: .*

Id

A unique identifier.

Type: String

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

KmsKey

The KMS key for the DataIntegration.

Type: String

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

Pattern: .*\S.*

Name

The name of the DataIntegration.

Type: String

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

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

ScheduleConfiguration

The name of the data and how often it should be pulled from the source.

Type: ScheduleConfiguration object

SourceURI

The URI of the data source.

Type: String

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

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

Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

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

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

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

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

See Also

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