starter_mapping_templates

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

Overview

Name	starter_mapping_templates
Type	Resource
Id	aws.b2bi.starter_mapping_templates

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_starter_mapping_template	insert	region, mappingType, templateDetails		Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI. If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI. If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter. Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.

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)

INSERT examples

create_starter_mapping_template

Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI. If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI. If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter. Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.

INSERT INTO aws.b2bi.starter_mapping_templates (
outputSampleLocation,
mappingType,
templateDetails,
region
)
SELECT 
'{{ outputSampleLocation }}',
'{{ mappingType }}' /* required */,
'{{ templateDetails }}' /* required */,
'{{ region }}'
RETURNING
mapping_template
;

Manifest

# Description fields are for documentation purposes
- name: starter_mapping_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the starter_mapping_templates resource.
  - name: outputSampleLocation
    description: |
      Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.
    value:
      bucketName: "{{ bucketName }}"
      key: "{{ key }}"
  - name: mappingType
    value: "{{ mappingType }}"
    description: |
      Specify the format for the mapping template: either JSONATA or XSLT.
    valid_values: ['JSONATA', 'XSLT']
  - name: templateDetails
    description: |
      Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used: currently, we only support X12.
    value:
      x12:
        transactionSet: "{{ transactionSet }}"
        version: "{{ version }}"