B2BI / Paginator / ListPartnerships

ListPartnerships

class B2BI.Paginator.ListPartnerships

paginator = client.get_paginator('list_partnerships')

paginate(**kwargs)

Creates an iterator that will paginate through responses from B2BI.Client.list_partnerships().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    profileId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• 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

{
    '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) –

    A token to resume pagination.