Skip to content

CreateTransformerRequest

Source code in docs_src/capo_b2bi/types/create_transformer_request.py
class CreateTransformerRequest(TypedDict, closed=True):
    name: "capo_b2bi.types.transformer_name.TransformerName"
    """<p>Specifies the name of the transformer, used to identify it.</p>"""
    client_token: NotRequired["str"]
    """<p>Reserved for future use.</p>"""
    tags: NotRequired["capo_b2bi.types.tag_list.TagList"]
    """<p>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.</p>"""
    file_format: NotRequired["capo_b2bi.types.file_format.FileFormat"]
    """<p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>"""
    mapping_template: NotRequired["capo_b2bi.types.mapping_template.MappingTemplate"]
    """<p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p> <note> <p>This parameter is available for backwards compatibility. Use the <a href="https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html">Mapping</a> data type instead.</p> </note>"""
    edi_type: NotRequired["capo_b2bi.types.edi_type.EdiType"]
    """<p>Specifies 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.</p>"""
    sample_document: NotRequired["capo_b2bi.types.file_location.FileLocation"]
    """<p>Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.</p>"""
    input_conversion: NotRequired["capo_b2bi.types.input_conversion.InputConversion"]
    """<p>Specify the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>"""
    mapping: NotRequired["capo_b2bi.types.mapping.Mapping"]
    """<p>Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).</p>"""
    output_conversion: NotRequired["capo_b2bi.types.output_conversion.OutputConversion"]
    """<p>A structure that contains the <code>OutputConversion</code> object, which contains the format options for the outbound transformation.</p>"""
    sample_documents: NotRequired["capo_b2bi.types.sample_documents.SampleDocuments"]
    """<p>Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.</p>"""

client_token instance-attribute

client_token: NotRequired[str]

Reserved for future use.

edi_type instance-attribute

edi_type: NotRequired[EdiType]

Specifies 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.

file_format instance-attribute

file_format: NotRequired[FileFormat]

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

input_conversion instance-attribute

input_conversion: NotRequired[InputConversion]

Specify the InputConversion object, which contains the format options for the inbound transformation.

mapping instance-attribute

mapping: NotRequired[Mapping]

Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).

mapping_template instance-attribute

mapping_template: NotRequired[MappingTemplate]

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

This parameter is available for backwards compatibility. Use the Mapping data type instead.

name instance-attribute

Specifies the name of the transformer, used to identify it.

output_conversion instance-attribute

output_conversion: NotRequired[OutputConversion]

A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.

sample_document instance-attribute

sample_document: NotRequired[FileLocation]

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

sample_documents instance-attribute

sample_documents: NotRequired[SampleDocuments]

Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

tags instance-attribute

tags: NotRequired[TagList]

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.