Request Syntax Request Parameters Response Elements Errors Examples See Also

DeleteCapability

Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

Request Syntax


{
   "capabilityId": "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.

capabilityId

Specifies a system-assigned unique identifier for the capability.

Type: String

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

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Response Elements

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

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

ConflictException

A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.

HTTP Status Code: 400

ThrottlingException

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

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 deletes a capability. If successful, an empty HTTP body,{} is returned.

Sample Request


{
   "capabilityId": "ca-1111aaaa2222bbbb3"
}