Redshift / Client / update_partner_status

update_partner_status#

Redshift.Client.update_partner_status(**kwargs)#

Updates the status of a partner integration.

See also: AWS API Documentation

Request Syntax

response = client.update_partner_status(
    AccountId='string',
    ClusterIdentifier='string',
    DatabaseName='string',
    PartnerName='string',
    Status='Active'|'Inactive'|'RuntimeFailure'|'ConnectionFailure',
    StatusMessage='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 status is being updated.

  • DatabaseName (string) –

    [REQUIRED]

    The name of the database whose partner integration status is being updated.

  • PartnerName (string) –

    [REQUIRED]

    The name of the partner whose integration status is being updated.

  • Status (string) –

    [REQUIRED]

    The value of the updated status.

  • StatusMessage (string) – The status message provided by the partner.

Return type:

dict

Returns:

Response Syntax

{
    'DatabaseName': 'string',
    'PartnerName': 'string'
}

Response Structure

  • (dict) –

    • DatabaseName (string) –

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

    • PartnerName (string) –

      The name of the partner that is authorized to send data.

Exceptions

  • Redshift.Client.exceptions.PartnerNotFoundFault

  • Redshift.Client.exceptions.ClusterNotFoundFault

  • Redshift.Client.exceptions.UnauthorizedPartnerIntegrationFault

  • Redshift.Client.exceptions.UnsupportedOperationFault