Amazon Redshift

2021/04/21 - Amazon Redshift - 4 new api methods

Changes  Add operations: AddPartner, DescribePartners, DeletePartner, and UpdatePartnerStatus to support tracking integration status with data partners.

DeletePartner (new) Link ¶

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

See also: AWS API Documentation

Request Syntax

client.delete_partner(
    AccountId='string',
    ClusterIdentifier='string',
    DatabaseName='string',
    PartnerName='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The AWS account ID that owns the cluster.

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The cluster identifier of the cluster that receives data from the partner.

type DatabaseName

string

param DatabaseName

[REQUIRED]

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

type PartnerName

string

param PartnerName

[REQUIRED]

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

rtype

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.

DescribePartners (new) Link ¶

Returns information about the partner integrations defined for a cluster.

See also: AWS API Documentation

Request Syntax

client.describe_partners(
    AccountId='string',
    ClusterIdentifier='string',
    DatabaseName='string',
    PartnerName='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The AWS account ID that owns the cluster.

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

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

type DatabaseName

string

param DatabaseName

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.

type PartnerName

string

param PartnerName

The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

rtype

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.

UpdatePartnerStatus (new) Link ¶

Updates the status of a partner integration.

See also: AWS API Documentation

Request Syntax

client.update_partner_status(
    AccountId='string',
    ClusterIdentifier='string',
    DatabaseName='string',
    PartnerName='string',
    Status='Active'|'Inactive'|'RuntimeFailure'|'ConnectionFailure',
    StatusMessage='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The AWS account ID that owns the cluster.

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The cluster identifier of the cluster whose partner integration status is being updated.

type DatabaseName

string

param DatabaseName

[REQUIRED]

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

type PartnerName

string

param PartnerName

[REQUIRED]

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

type Status

string

param Status

[REQUIRED]

The value of the updated status.

type StatusMessage

string

param StatusMessage

The status message provided by the partner.

rtype

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.

AddPartner (new) Link ¶

Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.

See also: AWS API Documentation

Request Syntax

client.add_partner(
    AccountId='string',
    ClusterIdentifier='string',
    DatabaseName='string',
    PartnerName='string'
)
type AccountId

string

param AccountId

[REQUIRED]

The AWS account ID that owns the cluster.

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The cluster identifier of the cluster that receives data from the partner.

type DatabaseName

string

param DatabaseName

[REQUIRED]

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

type PartnerName

string

param PartnerName

[REQUIRED]

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

rtype

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.