B2BI / Paginator / ListCapabilities

ListCapabilities

class B2BI.Paginator.ListCapabilities

paginator = client.get_paginator('list_capabilities')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'capabilities': [
        {
            'capabilityId': 'string',
            'name': 'string',
            'type': 'edi',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • capabilities (list) –

    Returns one or more capabilities associated with this partnership.

    • (dict) –

      Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

      • capabilityId (string) –

        Returns a system-assigned unique identifier for the capability.

      • name (string) –

        The display name of the capability.

      • type (string) –

        Returns the type of the capability. Currently, only edi is supported.

      • createdAt (datetime) –

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

      • modifiedAt (datetime) –

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

  • NextToken (string) –

    A token to resume pagination.