ListCapabilitiesCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { B2biClient, ListCapabilitiesCommand } from "@aws-sdk/client-b2bi"; // ES Modules import
// const { B2biClient, ListCapabilitiesCommand } = require("@aws-sdk/client-b2bi"); // CommonJS import
const client = new B2biClient(config);
const input = { // ListCapabilitiesRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListCapabilitiesCommand(input);
const response = await client.send(command);
// { // ListCapabilitiesResponse
//   capabilities: [ // CapabilityList // required
//     { // CapabilitySummary
//       capabilityId: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       type: "edi", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       modifiedAt: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Example Usage

 Loading code editor

ListCapabilitiesCommand Input

See ListCapabilitiesCommandInput for more details

Parameter
Type
Description
maxResults
number | undefined

Specifies the maximum number of capabilities to return.

nextToken
string | undefined

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.

ListCapabilitiesCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
capabilities
Required
CapabilitySummary[] | undefined

Returns one or more capabilities associated with this partnership.

nextToken
string | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

ThrottlingException
client

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

ValidationException
client

Occurs when a B2BI object cannot be validated against a request from another object.

B2biServiceException
Base exception class for all service exceptions from B2bi service.