B2BI / Client / get_capability

get_capability

B2BI.Client.get_capability(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_capability(
    capabilityId='string'
)

Parameters:

capabilityId (string) –

[REQUIRED]

Specifies a system-assigned unique identifier for the capability.

Return type:

dict

Returns:

Response Syntax

{
    'capabilityId': 'string',
    'capabilityArn': 'string',
    'name': 'string',
    'type': 'edi',
    'configuration': {
        'edi': {
            'type': {
                'x12Details': {
                    'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
                    'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
                }
            },
            'inputLocation': {
                'bucketName': 'string',
                'key': 'string'
            },
            'outputLocation': {
                'bucketName': 'string',
                'key': 'string'
            },
            'transformerId': 'string'
        }
    },
    'instructionsDocuments': [
        {
            'bucketName': 'string',
            'key': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • capabilityId (string) –

    Returns a system-assigned unique identifier for the capability.

  • capabilityArn (string) –

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

  • name (string) –

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

  • type (string) –

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

  • configuration (dict) –

    Returns a structure that contains the details for a capability.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: edi. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • edi (dict) –

      An EDI (electronic data interchange) configuration object.

      • type (dict) –

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

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • x12Details (dict) –

          Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

          • transactionSet (string) –

            Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.

          • version (string) –

            Returns the version to use for the specified X12 transaction set. Supported versions are 4010, 4030, and 5010.

      • inputLocation (dict) –

        Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an S3Location object.

        • bucketName (string) –

          Specifies the name of the Amazon S3 bucket.

        • key (string) –

          Specifies the Amazon S3 key for the file location.

      • outputLocation (dict) –

        Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.

        • bucketName (string) –

          Specifies the name of the Amazon S3 bucket.

        • key (string) –

          Specifies the Amazon S3 key for the file location.

      • transformerId (string) –

        Returns the system-assigned unique identifier for the transformer.

  • instructionsDocuments (list) –

    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.

    • (dict) –

      Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2BI Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.

      • bucketName (string) –

        Specifies the name of the Amazon S3 bucket.

      • key (string) –

        Specifies the Amazon S3 key for the file location.

  • createdAt (datetime) –

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

  • modifiedAt (datetime) –

    Returns a timestamp for last time the capability was modified.

Exceptions

• B2BI.Client.exceptions.AccessDeniedException

• B2BI.Client.exceptions.ValidationException

• B2BI.Client.exceptions.ThrottlingException

• B2BI.Client.exceptions.ResourceNotFoundException

• B2BI.Client.exceptions.InternalServerException