B2BI / Client / list_capabilities

list_capabilities#

B2BI.Client.list_capabilities(**kwargs)#

Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

Request Syntax

response = client.list_capabilities(
    nextToken='string',
    maxResults=123
)

Parameters:

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

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

B2BI.Client.exceptions.AccessDeniedException
B2BI.Client.exceptions.ValidationException
B2BI.Client.exceptions.ThrottlingException
B2BI.Client.exceptions.InternalServerException