Skip to content

UpdateTransformerResponse

Source code in docs_src/capo_b2bi/types/update_transformer_response.py
class UpdateTransformerResponse(TypedDict, closed=True):
    transformer_id: "capo_b2bi.types.transformer_id.TransformerId"
    """<p>Returns the system-assigned unique identifier for the transformer.</p>"""
    transformer_arn: "capo_b2bi.types.resource_arn.ResourceArn"
    """<p>Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.</p>"""
    name: "capo_b2bi.types.transformer_name.TransformerName"
    """<p>Returns the name of the transformer.</p>"""
    status: "capo_b2bi.types.transformer_status.TransformerStatus"
    """<p>Returns the state of the newly created transformer. The transformer can be either <code>active</code> or <code>inactive</code>. For the transformer to be used in a capability, its status must <code>active</code>.</p>"""
    created_at: "capo_b2bi.types.created_date.CreatedDate"
    """<p>Returns a timestamp for creation date and time of the transformer.</p>"""
    modified_at: "capo_b2bi.types.modified_date.ModifiedDate"
    """<p>Returns a timestamp for last time the transformer was modified.</p>"""
    file_format: "capo_b2bi.types.file_format.FileFormat"
    """<p>Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>"""
    mapping_template: "capo_b2bi.types.mapping_template.MappingTemplate"
    """<p>Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p>"""
    edi_type: NotRequired["capo_b2bi.types.edi_type.EdiType"]
    """<p>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.</p>"""
    sample_document: NotRequired["capo_b2bi.types.file_location.FileLocation"]
    """<p>Returns 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>Returns the <code>InputConversion</code> object, which contains the format options for the inbound transformation.</p>"""
    mapping: NotRequired["capo_b2bi.types.mapping.Mapping"]
    """<p>Returns 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>Returns 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>Returns 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>"""

created_at instance-attribute

created_at: CreatedDate

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

edi_type instance-attribute

edi_type: NotRequired[EdiType]

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.

file_format instance-attribute

file_format: FileFormat

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

input_conversion instance-attribute

input_conversion: NotRequired[InputConversion]

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

mapping instance-attribute

mapping: NotRequired[Mapping]

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

mapping_template instance-attribute

mapping_template: MappingTemplate

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

modified_at instance-attribute

modified_at: ModifiedDate

Returns a timestamp for last time the transformer was modified.

name instance-attribute

Returns the name of the transformer.

output_conversion instance-attribute

output_conversion: NotRequired[OutputConversion]

Returns the OutputConversion object, which contains the format options for the outbound transformation.

sample_document instance-attribute

sample_document: NotRequired[FileLocation]

Returns 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]

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

status instance-attribute

Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.

transformer_arn instance-attribute

transformer_arn: ResourceArn

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

transformer_id instance-attribute

transformer_id: TransformerId

Returns the system-assigned unique identifier for the transformer.