Redshift / Client / describe_partners

describe_partners#

Redshift.Client.describe_partners(**kwargs)#

Returns information about the partner integrations defined for a cluster.

See also: AWS API Documentation

Request Syntax

response = client.describe_partners(
    AccountId='string',
    ClusterIdentifier='string',
    DatabaseName='string',
    PartnerName='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Web Services account ID that owns the cluster.

  • ClusterIdentifier (string) –

    [REQUIRED]

    The cluster identifier of the cluster whose partner integration is being described.

  • DatabaseName (string) – The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.

  • PartnerName (string) – The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

Return type:

dict

Returns:

Response Syntax

{
    'PartnerIntegrationInfoList': [
        {
            'DatabaseName': 'string',
            'PartnerName': 'string',
            'Status': 'Active'|'Inactive'|'RuntimeFailure'|'ConnectionFailure',
            'StatusMessage': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • PartnerIntegrationInfoList (list) –

      A list of partner integrations.

      • (dict) –

        Describes a partner integration.

        • DatabaseName (string) –

          The name of the database that receives data from a partner.

        • PartnerName (string) –

          The name of the partner.

        • Status (string) –

          The partner integration status.

        • StatusMessage (string) –

          The status message provided by the partner.

        • CreatedAt (datetime) –

          The date (UTC) that the partner integration was created.

        • UpdatedAt (datetime) –

          The date (UTC) that the partner integration status was last updated by the partner.

Exceptions

  • Redshift.Client.exceptions.ClusterNotFoundFault

  • Redshift.Client.exceptions.UnauthorizedPartnerIntegrationFault

  • Redshift.Client.exceptions.UnsupportedOperationFault