쿠키 기본 설정 선택

당사는 사이트와 서비스를 제공하는 데 필요한 필수 쿠키 및 유사한 도구를 사용합니다. 고객이 사이트를 어떻게 사용하는지 파악하고 개선할 수 있도록 성능 쿠키를 사용해 익명의 통계를 수집합니다. 필수 쿠키는 비활성화할 수 없지만 '사용자 지정' 또는 ‘거부’를 클릭하여 성능 쿠키를 거부할 수 있습니다.

사용자가 동의하는 경우 AWS와 승인된 제3자도 쿠키를 사용하여 유용한 사이트 기능을 제공하고, 사용자의 기본 설정을 기억하고, 관련 광고를 비롯한 관련 콘텐츠를 표시합니다. 필수가 아닌 모든 쿠키를 수락하거나 거부하려면 ‘수락’ 또는 ‘거부’를 클릭하세요. 더 자세한 내용을 선택하려면 ‘사용자 정의’를 클릭하세요.

GetCapability - AWS B2B Data Interchange
이 페이지는 귀하의 언어로 번역되지 않았습니다. 번역 요청

GetCapability

Retrieves the details for 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 Syntax

{ "capabilityArn": "string", "capabilityId": "string", "configuration": { ... }, "createdAt": "string", "instructionsDocuments": [ { "bucketName": "string", "key": "string" } ], "modifiedAt": "string", "name": "string", "type": "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.

capabilityArn

Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.

Type: String

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

capabilityId

Returns 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_-]+

configuration

Returns a structure that contains the details for a capability.

Type: CapabilityConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

createdAt

Returns a timestamp for creation date and time of the capability.

Type: Timestamp

instructionsDocuments

Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.

Type: Array of S3Location objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

modifiedAt

Returns a timestamp for last time the capability was modified.

Type: Timestamp

name

Returns the name of the capability, used to identify it.

Type: String

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

type

Returns the type of the capability. Currently, only edi is supported.

Type: String

Valid Values: edi

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.

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 retrieves details for the specified capability.

Sample Request

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

Sample Response

{ "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-1111aaaa2222bbbb3", "capabilityId": "ca-1111aaaa2222bbbb3", "configuration": { "edi": { "type": { "x12Details": { "transactionSet": "X12_110", "version": "VERSION_4010" } }, "inputLocation": { "bucketName": "amzn-s3-demo-bucket", "key": "input/" }, "outputLocation": { "bucketName": "amzn-s3-demo-bucket", "key": "output/" }, "transformerId": "tr-1234abcd5678efghj" } }, "createdAt": "2023-11-01T21:51:05.504Z", "instructionsDocuments": [ { "bucketName": "amzn-s3-demo-bucket", "key": "instructiondoc.txt" } ], "modifiedAt": "2023-11-02T21:51:05.504Z", "name": "b2biexample", "type": "edi" }

See Also

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

프라이버시사이트 이용 약관쿠키 기본 설정
© 2025, Amazon Web Services, Inc. 또는 계열사. All rights reserved.