PartnerCentralAccountAPI / Paginator / ListConnections

ListConnections¶

class PartnerCentralAccountAPI.Paginator.ListConnections¶

paginator = client.get_paginator('list_connections')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from PartnerCentralAccountAPI.Client.list_connections().

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    ConnectionType='string',
    OtherParticipantIdentifiers=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

Catalog (string) –
[REQUIRED]

The catalog identifier for the partner account.
ConnectionType (string) – Filter results by connection type (e.g., reseller, distributor, technology partner).
OtherParticipantIdentifiers (list) –
Filter results by specific participant identifiers.
- (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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'
                        }
                    }
                }
            }
        },
    ],

}

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.