Skip to content
AWS for Query.Farm

aws.b2bi.get_capability

Example SQL Queries

SELECT * FROM
aws.b2bi.get_capability
WHERE
"capability_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
capability_id Required Input Column

Returns a system-assigned unique identifier for the capability.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

capability_arn

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

VARCHAR
configuration

Returns a structure that contains the details for a capability.

STRUCT(
    "edi" STRUCT(
        "type" STRUCT(
            "x12_details" STRUCT(
                "transaction_set" VARCHAR,
                "version" VARCHAR
            )
        ),
        "input_location" STRUCT(
            "bucket_name" VARCHAR,
            "key" VARCHAR
        ),
        "output_location" STRUCT(
            "bucket_name" VARCHAR,
            "key" VARCHAR
        ),
        "transformer_id" VARCHAR
    )
)
Show child fields
configuration.edi

An EDI (electronic data interchange) configuration object.

Show child fields
configuration.edi.input_location

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

Show child fields
configuration.edi.input_location.bucket_name

Specifies the name of the Amazon S3 bucket.

configuration.edi.input_location.key

Specifies the Amazon S3 key for the file location.

configuration.edi.output_location

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

Show child fields
configuration.edi.output_location.bucket_name

Specifies the name of the Amazon S3 bucket.

configuration.edi.output_location.key

Specifies the Amazon S3 key for the file location.

configuration.edi.transformer_id

Returns the system-assigned unique identifier for the transformer.

configuration.edi.type

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

Show child fields
configuration.edi.type.x12_details

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.

Show child fields
configuration.edi.type.x12_details.transaction_set

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

configuration.edi.type.x12_details.version

Returns the version to use for the specified X12 transaction set. 

 </p>
created_at

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

TIMESTAMP_S
instructions_documents

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.

STRUCT(
    "bucket_name" VARCHAR,
    "key" VARCHAR
)[]
Show child fields
instructions_documents[]
Show child fields
instructions_documents[].bucket_name

Specifies the name of the Amazon S3 bucket.

instructions_documents[].key

Specifies the Amazon S3 key for the file location.

modified_at

Returns a timestamp for last time the capability was modified.

TIMESTAMP_S
name

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

VARCHAR
type

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

VARCHAR