DescribeIntegrations
Describe one or more zero-ETL integrations with Amazon Redshift.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Filters.Filter.N
-
A filter that specifies one or more resources to return.
Type: Array of Filter objects
Required: No
- IntegrationIdentifier
-
The unique identifier of the integration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_:\-\/]+
Required: No
- Marker
-
An optional pagination token provided by a previous
DescribeIntegrations
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 340.
Required: No
- MaxRecords
-
The maximum number of records to include in the response. If more records exist than the specified
MaxRecords
value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
Response Elements
The following elements are returned by the service.
- Integrations.Integration.N
-
A list of integrations.
Type: Array of Integration objects
- Marker
-
A pagination token that can be used in a later
DescribeIntegrations
request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 340.
Errors
For information about the errors that are common to all actions, see Common Errors.
- IntegrationNotFoundFault
-
The specified integration could not be found.
HTTP Status Code: 404
Examples
Example
This example illustrates one usage of DescribeIntegrations.
Sample Request
https://rds.us-east-1.amazonaws.com/
?Action=DescribeIntegration
&IntegrationIdentifier=f30acbd8-aaab-4c3c-afb5-09d51d041037
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-east-1/rds/aws4_request
&X-Amz-Date=20230110T005253Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214
Sample Response
<DescribeIntegrationsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<DescribeIntegrationsResult>
<Integrations>
<Integration>
<SourceArn>arn:aws:rds:us-east-1:123456789012:cluster:serverless-source-cluster</SourceArn>
<IntegrationName>my-integration</IntegrationName>
<IntegrationCreateTime>2023-12-14T00:15:21.358Z</IntegrationCreateTime>
<IntegrationArn>arn:aws:rds:us-east-1:123456789012:integration:f30acbd8-aaab-4c3c-afb5-09d51d041037</IntegrationArn>
<TargetArn>arn:aws:redshift-serverless:us-east-1:123456789012:namespace/0844171c-1e01-4d9f-be52-89e6c44083e5</TargetArn>
<Tags/>
<CreateTime>2023-12-14T00:15:21.358Z</CreateTime>
<KMSKeyId>arn:aws:kms:us-east-1:211223847500:key/eda7134d-cd39-4af1-b62b-ad2415b6bccc</KMSKeyId>
<Status>creating</Status>
</Integration>
</Integrations>
</DescribeIntegrationsResult>
<ResponseMetadata>
<RequestId>6e131503-e920-4c3d-b934-a401a69c3b24</RequestId>
</ResponseMetadata>
</DescribeIntegrationsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: