DeleteCapability - AWS B2B Data Interchange

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

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

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" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: