GetDataIntegration
Returns information about the DataIntegration.
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
GET /dataIntegrations/Identifier
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Identifier
-
A unique identifier.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
.*\S.*
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"Description": "string",
"FileConfiguration": {
"Filters": {
"string" : [ "string" ]
},
"Folders": [ "string" ]
},
"Id": "string",
"KmsKey": "string",
"Name": "string",
"ObjectConfiguration": {
"string" : {
"string" : [ "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) 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}$
- Description
-
The KMS key ARN for the DataIntegration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
.*
- FileConfiguration
-
The configuration for what files should be pulled from the source.
Type: FileConfiguration object
- 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 ARN 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\/\._\-]+$
- 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\/\._\-]+$
- 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/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\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
- 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
- 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: