DescribeInboundIntegrationsCommand

Suggest an Edit

Returns a list of inbound integrations.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, DescribeInboundIntegrationsCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, DescribeInboundIntegrationsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // DescribeInboundIntegrationsMessage
  IntegrationArn: "STRING_VALUE",
  TargetArn: "STRING_VALUE",
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeInboundIntegrationsCommand(input);
const response = await client.send(command);
// { // InboundIntegrationsMessage
//   Marker: "STRING_VALUE",
//   InboundIntegrations: [ // InboundIntegrationList
//     { // InboundIntegration
//       IntegrationArn: "STRING_VALUE",
//       SourceArn: "STRING_VALUE",
//       TargetArn: "STRING_VALUE",
//       Status: "creating" || "active" || "modifying" || "failed" || "deleting" || "syncing" || "needs_attention",
//       Errors: [ // IntegrationErrorList
//         { // IntegrationError
//           ErrorCode: "STRING_VALUE", // required
//           ErrorMessage: "STRING_VALUE",
//         },
//       ],
//       CreateTime: new Date("TIMESTAMP"),
//     },
//   ],
// };

DescribeInboundIntegrationsCommand Input

See DescribeInboundIntegrationsCommandInput for more details

Parameter
Type
Description
IntegrationArn
string | undefined

The Amazon Resource Name (ARN) of the inbound integration.

Marker
string | undefined

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, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
number | undefined

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TargetArn
string | undefined

The Amazon Resource Name (ARN) of the target of an inbound integration.

DescribeInboundIntegrationsCommand Output

See DescribeInboundIntegrationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
InboundIntegrations
InboundIntegration[] | undefined

A list of InboundIntegration instances.

Marker
string | undefined

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 Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Throws

Name
Fault
Details
IntegrationNotFoundFault
client

The integration can't be found.

InvalidNamespaceFault
client

The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.

UnsupportedOperationFault
client

The requested operation isn't supported.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.