Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListCapabilities

Lists the capabilities associated with your AWS 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


{
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

Specifies the maximum number of capabilities to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax


{
   "capabilities": [ 
      { 
         "capabilityId": "string",
         "createdAt": "string",
         "modifiedAt": "string",
         "name": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

capabilities

Returns one or more capabilities associated with this partnership.

Type: Array of CapabilitySummary objects

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

This exception is thrown when an error occurs in the AWS B2B Data Interchange service.

retryAfterSeconds: The server attempts to retry a failed command.

HTTP Status Code: 500

ThrottlingException

The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

retryAfterSeconds: The server attempts to retry a command that was throttled.

HTTP Status Code: 400

ValidationException

When you use Transformer APIs, TestConversion, or TestParsing, the service throws a validation exception if a rule is configured incorrectly. For example, a validation exception occurs when:

A rule references an element that doesn't exist in the selected transaction set
An element length rule specifies a minimum length less than 0

Note

If your custom validation rules are configured correctly but the EDI validation fails due to those rules, this is expected behavior and doesn't result in a ValidationException.

For all other API operations, a validation exception occurs when a Trading Partner object can't be validated against a request from another object. This can happen during:

Standard EDI validation
Custom validation rule evaluation, such as when:
- Element lengths don't meet specified constraints
- Code list validations contain invalid codes
- Required elements are missing based on your element requirement rules

HTTP Status Code: 400

Examples

Example

The following example lists the capabilities for your account and in your region. Note that in this example, there is only one capability listed: however, this call would return up to 50 capabilities.

Sample Request


{
    "maxResults": 50,
    "nextToken": "foo"
}

Sample Response


{
    "capabilities": [
        {
            "capabilityId": "ca-1111aaaa2222bbbb3",
            "createdAt": "2023-11-01T21:51:05.504Z",
            "modifiedAt": "2023-11-01T21:51:05.504Z",
            "name": "b2biexample",
            "type": "edi"
        }
    ],
    "nextToken": "foo"
}