RDS / Client / describe_integrations

describe_integrations

RDS.Client.describe_integrations(**kwargs)

Describe one or more zero-ETL integrations with Amazon Redshift.

See also: AWS API Documentation

Request Syntax

response = client.describe_integrations(
    IntegrationIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• IntegrationIdentifier (string) – The unique identifier of the integration.

• Filters (list) –

  A filter that specifies one or more resources to return.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribeDBRecommendations

    • DescribeDBShardGroups

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) –

• MaxRecords (integer) –

  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.

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

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'Integrations': [
        {
            'SourceArn': 'string',
            'TargetArn': 'string',
            'IntegrationName': 'string',
            'IntegrationArn': 'string',
            'KMSKeyId': 'string',
            'AdditionalEncryptionContext': {
                'string': 'string'
            },
            'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'CreateTime': datetime(2015, 1, 1),
            'Errors': [
                {
                    'ErrorCode': 'string',
                    'ErrorMessage': 'string'
                },
            ],
            'DataFilter': 'string',
            'Description': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Marker (string) –

    A pagination token that can be used in a later DescribeIntegrations request.

  • Integrations (list) –

    A list of integrations.

    • (dict) –

      A zero-ETL integration with Amazon Redshift.

      • SourceArn (string) –

        The Amazon Resource Name (ARN) of the database used as the source for replication.

      • TargetArn (string) –

        The ARN of the Redshift data warehouse used as the target for replication.

      • IntegrationName (string) –

        The name of the integration.

      • IntegrationArn (string) –

        The ARN of the integration.

      • KMSKeyId (string) –

        The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.

      • AdditionalEncryptionContext (dict) –

        The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

        • (string) –

          • (string) –

      • Status (string) –

        The current status of the integration.

      • Tags (list) –

        A list of tags.

        For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

        • (dict) –

          Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

          For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

          • Key (string) –

            A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

          • Value (string) –

            A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

      • CreateTime (datetime) –

        The time when the integration was created, in Universal Coordinated Time (UTC).

      • Errors (list) –

        Any errors associated with the integration.

        • (dict) –

          An error associated with a zero-ETL integration with Amazon Redshift.

          • ErrorCode (string) –

            The error code associated with the integration.

          • ErrorMessage (string) –

            A message explaining the error.

      • DataFilter (string) –

        Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse.

      • Description (string) –

        A description of the integration.

Exceptions

• RDS.Client.exceptions.IntegrationNotFoundFault