Redshift / Client / describe_inbound_integrations

describe_inbound_integrations#

Redshift.Client.describe_inbound_integrations(**kwargs)#

Returns a list of inbound integrations.

See also: AWS API Documentation

Request Syntax

response = client.describe_inbound_integrations(
    IntegrationArn='string',
    TargetArn='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • IntegrationArn (string) – The Amazon Resource Name (ARN) of the inbound integration.

  • TargetArn (string) – The Amazon Resource Name (ARN) of the target of an inbound integration.

  • MaxRecords (integer) –

    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.

  • Marker (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'InboundIntegrations': [
        {
            'IntegrationArn': 'string',
            'SourceArn': 'string',
            'TargetArn': 'string',
            'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
            'Errors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ],
            'CreateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      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.

    • InboundIntegrations (list) –

      A list of InboundIntegration instances.

      • (dict) –

        The content of an inbound integration.

        • IntegrationArn (string) –

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

        • SourceArn (string) –

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

        • TargetArn (string) –

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

        • Status (string) –

          The status of an inbound integration.

        • Errors (list) –

          The outstanding errors of an inbound integration. Each item is an “IntegrationError”. This is null if there is no error.

          • (dict) –

            The error of an inbound integration.

            • ErrorCode (string) –

              The error code of an inbound integration error.

            • ErrorMessage (string) –

              The error message of an inbound integration error.

        • CreateTime (datetime) –

          The creation time of an inbound integration.

Exceptions

  • Redshift.Client.exceptions.IntegrationNotFoundFault

  • Redshift.Client.exceptions.InvalidNamespaceFault

  • Redshift.Client.exceptions.UnsupportedOperationFault