DescribeInboundIntegrations
Returns a list of inbound integrations.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- IntegrationArn
-
The Amazon Resource Name (ARN) of the inbound integration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^arn:aws[a-z\-]*:.+:[a-z0-9\-]*:[0-9]*:integration:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Required: No
- Marker
-
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in
MaxRecords, AWS returns a value in theMarkerfield of the response. You can retrieve the next set of response records by providing the returned marker value in theMarkerparameter and retrying the request.Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- MaxRecords
-
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified
MaxRecordsvalue, a value is returned in amarkerfield of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
100Constraints: minimum 20, maximum 100.
Type: Integer
Required: No
- TargetArn
-
The Amazon Resource Name (ARN) of the target of an inbound integration.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:redshift(-serverless)?:[a-z0-9\-]+:[0-9]{12}:(namespace\/|namespace:)[a-z0-9\-]+$Required: No
Response Elements
The following elements are returned by the service.
- InboundIntegrations.InboundIntegration.N
-
A list of InboundIntegration instances.
Type: Array of InboundIntegration objects
- Marker
-
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the
Markerparameter and retrying the command. If theMarkerfield is empty, all response records have been retrieved for the request.Type: String
Length Constraints: Maximum length of 2147483647.
Errors
For information about the errors that are common to all actions, see Common Errors.
- IntegrationNotFoundFault
-
The integration can't be found.
HTTP Status Code: 404
- InvalidNamespaceFault
-
The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.
HTTP Status Code: 400
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
