B2BI / Client / list_partnerships

list_partnerships#

B2BI.Client.list_partnerships(**kwargs)#

Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See also: AWS API Documentation

Request Syntax

response = client.list_partnerships(
    profileId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • profileId (string) – Specifies the unique, system-generated identifier for the profile connected to this partnership.

  • nextToken (string) – When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

  • maxResults (integer) – Specifies the maximum number of capabilities to return.

Return type:

dict

Returns:

Response Syntax

{
    'partnerships': [
        {
            'profileId': 'string',
            'partnershipId': 'string',
            'name': 'string',
            'capabilities': [
                'string',
            ],
            'tradingPartnerId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • partnerships (list) –

      Specifies a list of your partnerships.

      • (dict) –

        A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

        • profileId (string) –

          Returns the unique, system-generated identifier for the profile connected to this partnership.

        • partnershipId (string) –

          Returns the unique, system-generated identifier for a partnership.

        • name (string) –

          Returns the name of the partnership.

        • capabilities (list) –

          Returns one or more capabilities associated with this partnership.

          • (string) –

        • tradingPartnerId (string) –

          Returns the unique, system-generated identifier for a trading partner.

        • createdAt (datetime) –

          Returns a timestamp for creation date and time of the partnership.

        • modifiedAt (datetime) –

          Returns a timestamp that identifies the most recent date and time that the partnership was modified.

    • nextToken (string) –

      When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Exceptions