PartnerCentralAccountAPI / Client / list_partners

list_partners¶

PartnerCentralAccountAPI.Client.list_partners(**kwargs)¶

Lists partner accounts in the catalog, providing a summary view of all partners.

Request Syntax

response = client.list_partners(
    Catalog='string',
    NextToken='string'
)

Parameters:

Catalog (string) –
[REQUIRED]

The catalog identifier to list partners from.
NextToken (string) – The token for retrieving the next page of results in paginated responses.

Return type:

dict

Returns:

Response Syntax

{
    'PartnerSummaryList': [
        {
            'Catalog': 'string',
            'Arn': 'string',
            'Id': 'string',
            'LegalName': 'string',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- PartnerSummaryList (list) –
  
  A list of partner summaries including basic information about each partner account.
  - (dict) –
    
    A summary view of a partner account containing basic information for listing purposes.
    - Catalog (string) –
      
      The catalog identifier for the partner account.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the partner account.
    - Id (string) –
      
      The unique identifier of the partner account.
    - LegalName (string) –
      
      The legal name of the partner organization.
    - CreatedAt (datetime) –
      
      The timestamp when the partner account was created.
- 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