DescribeIntegrations
The API is used to retrieve a list of integrations.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"IntegrationIdentifier": "string",
"Marker": "string",
"MaxRecords": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
A list of key and values, to filter down the results. Supported keys are "Status", "IntegrationName", and "SourceArn". IntegrationName is limited to only one value.
Type: Array of IntegrationFilter objects
Required: No
- IntegrationIdentifier
-
The Amazon Resource Name (ARN) for the integration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- Marker
-
A value that indicates the starting point for the next set of response records in a subsequent request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- MaxRecords
-
The total number of items to return in the output.
Type: Integer
Required: No
Response Syntax
{
"Integrations": [
{
"AdditionalEncryptionContext": {
"string" : "string"
},
"CreateTime": number,
"DataFilter": "string",
"Description": "string",
"Errors": [
{
"ErrorCode": "string",
"ErrorMessage": "string"
}
],
"IntegrationArn": "string",
"IntegrationName": "string",
"KmsKeyId": "string",
"SourceArn": "string",
"Status": "string",
"Tags": [
{
"key": "string",
"value": "string"
}
],
"TargetArn": "string"
}
],
"Marker": "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.
- Integrations
-
A list of zero-ETL integrations.
Type: Array of Integration objects
- Marker
-
A value that indicates the starting point for the next set of response records in a subsequent request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- IntegrationNotFoundFault
-
The specified integration could not be found.
HTTP Status Code: 400
- InternalServerException
-
An internal server error occurred.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- ValidationException
-
A value could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
