capabilities

Creates, updates, deletes, gets or lists a capabilities resource.

Overview

Name	capabilities
Type	Resource
Id	aws.b2bi.capabilities

Fields

The following fields are returned by SELECT queries:

get_capability

Name	Datatype	Description
name	string	Returns the name of the capability, used to identify it.
capability_arn	string	Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
capability_id	string	Returns a system-assigned unique identifier for the capability. (pattern: <code>[a-zA-Z0-9_-]+</code>)
configuration	object	Returns a structure that contains the details for a capability.
created_at	string (date-time)	Returns a timestamp for creation date and time of the capability.
instructions_documents	array	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.
modified_at	string (date-time)	Returns a timestamp for last time the capability was modified.
type_	string	Returns the type of the capability. Currently, only edi is supported. (edi)

list_capabilities

Name	Datatype	Description
name	string	The display name of the capability.
capability_id	string	Returns a system-assigned unique identifier for the capability. (pattern: <code>[a-zA-Z0-9_-]+</code>)
created_at	string (date-time)	Returns a timestamp for creation date and time of the capability.
modified_at	string (date-time)	Returns a timestamp that identifies the most recent date and time that the capability was modified.
type_	string	Returns the type of the capability. Currently, only edi is supported. (edi)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_capability	select	region		Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
list_capabilities	select	region		Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
create_capability	insert	region, name, type, configuration		Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
update_capability	update	region, capabilityId		Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
delete_capability	delete	region		Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_capability

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

SELECT
name,
capability_arn,
capability_id,
configuration,
created_at,
instructions_documents,
modified_at,
type_
FROM aws.b2bi.capabilities
WHERE region = '{{ region }}' -- required
;

list_capabilities

Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

SELECT
name,
capability_id,
created_at,
modified_at,
type_
FROM aws.b2bi.capabilities
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_capability

Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

INSERT INTO aws.b2bi.capabilities (
name,
type,
configuration,
instructionsDocuments,
clientToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ configuration }}' /* required */,
'{{ instructionsDocuments }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
capability_arn,
capability_id,
configuration,
created_at,
instructions_documents,
type_
;

Manifest

# Description fields are for documentation purposes
- name: capabilities
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the capabilities resource.
  - name: name
    value: "{{ name }}"
    description: |
      Specifies the name of the capability, used to identify it.
  - name: type
    value: "{{ type }}"
    description: |
      Specifies the type of the capability. Currently, only edi is supported.
    valid_values: ['edi']
  - name: configuration
    description: |
      Specifies a structure that contains the details for a capability.
    value:
      edi:
        capabilityDirection: "{{ capabilityDirection }}"
        type_:
          x12Details:
            transactionSet: "{{ transactionSet }}"
            version: "{{ version }}"
        inputLocation:
          bucketName: "{{ bucketName }}"
          key: "{{ key }}"
        outputLocation:
          bucketName: "{{ bucketName }}"
          key: "{{ key }}"
        transformerId: "{{ transformerId }}"
  - name: instructionsDocuments
    description: |
      Specifies 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.
    value:
      - bucketName: "{{ bucketName }}"
        key: "{{ key }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Reserved for future use.
  - name: tags
    description: |
      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_capability

Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

UPDATE aws.b2bi.capabilities
SET 
capabilityId = '{{ capabilityId }}',
name = '{{ name }}',
configuration = '{{ configuration }}',
instructionsDocuments = '{{ instructionsDocuments }}'
WHERE 
region = '{{ region }}' --required
AND capabilityId = '{{ capabilityId }}' --required
RETURNING
name,
capability_arn,
capability_id,
configuration,
created_at,
instructions_documents,
modified_at,
type_;

DELETE examples

delete_capability

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

DELETE FROM aws.b2bi.capabilities
WHERE region = '{{ region }}' --required
;