PartnerCentralAccountAPI / Client / list_connections

list_connections

PartnerCentralAccountAPI.Client.list_connections(**kwargs)

Lists active connections for the partner account, with optional filtering by connection type and participant.

See also: AWS API Documentation

Request Syntax

response = client.list_connections(
    Catalog='string',
    NextToken='string',
    ConnectionType='string',
    MaxResults=123,
    OtherParticipantIdentifiers=[
        'string',
    ]
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier for the partner account.

• NextToken (string) – The token for retrieving the next page of results in paginated responses.

• ConnectionType (string) – Filter results by connection type (e.g., reseller, distributor, technology partner).

• MaxResults (integer) – The maximum number of connections to return in a single response.

• OtherParticipantIdentifiers (list) –

  Filter results by specific participant identifiers.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionSummaries': [
        {
            'Catalog': 'string',
            'Id': 'string',
            'Arn': 'string',
            'OtherParticipantAccountId': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'ConnectionTypes': {
                'string': {
                    'Status': 'ACTIVE'|'CANCELED',
                    'OtherParticipant': {
                        'PartnerProfile': {
                            'Id': 'string',
                            'Name': 'string'
                        },
                        'SellerProfile': {
                            'Id': 'string',
                            'Name': 'string'
                        },
                        'Account': {
                            'Name': 'string'
                        }
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ConnectionSummaries (list) –

    A list of connection summaries matching the specified criteria.

    • (dict) –

      A summary view of an active connection between partners containing key information.

      • Catalog (string) –

        The catalog identifier where the connection exists.

      • Id (string) –

        The unique identifier of the connection.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the connection.

      • OtherParticipantAccountId (string) –

        The AWS account ID of the other participant in the connection.

      • UpdatedAt (datetime) –

        The timestamp when the connection was last updated.

      • ConnectionTypes (dict) –

        A map of connection types and their summary information for this connection.

        • (string) –

          • (dict) –

            Summary information about a specific connection type between partners.

            • Status (string) –

              The current status of this connection type (active, canceled, etc.).

            • OtherParticipant (dict) –

              Information about the other participant in this connection type.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: PartnerProfile, SellerProfile, Account. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              

              • PartnerProfile (dict) –

                The partner profile information for the participant.

                • Id (string) –

                  The unique identifier of the partner profile.

                • Name (string) –

                  The display name of the partner.

              • SellerProfile (dict) –

                The seller profile information for the participant.

                • Id (string) –

                  The unique identifier of the seller profile.

                • Name (string) –

                  The display name of the seller.

              • Account (dict) –

                The AWS account information for the participant.

                • Name (string) –

                  The name associated with the AWS account.

  • NextToken (string) –

    The token for retrieving the next page of results if more results are available.

Exceptions

• PartnerCentralAccountAPI.Client.exceptions.AccessDeniedException

• PartnerCentralAccountAPI.Client.exceptions.ThrottlingException

• PartnerCentralAccountAPI.Client.exceptions.ValidationException

• PartnerCentralAccountAPI.Client.exceptions.InternalServerException