Class: Aws::B2bi::Types::UpdateTransformerRequest

Inherits:

Struct

• Object
• Struct
• Aws::B2bi::Types::UpdateTransformerRequest

Includes:

Structure

Defined in:

lib/aws-sdk-b2bi/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #edi_type ⇒ Types::EdiType

  Specifies the details for the EDI standard that is being used for the transformer.

• #file_format ⇒ String

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

• #input_conversion ⇒ Types::InputConversion

  To update, specify the ‘InputConversion` object, which contains the format options for the inbound transformation.

• #mapping ⇒ Types::Mapping

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

• #mapping_template ⇒ String

  Specifies the mapping template for the transformer.

• #name ⇒ String

  Specify a new name for the transformer, if you want to update it.

• #output_conversion ⇒ Types::OutputConversion

  To update, specify the ‘OutputConversion` object, which contains the format options for the outbound transformation.

• #sample_document ⇒ String

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

• #sample_documents ⇒ Types::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.

• #status ⇒ String

  Specifies the transformer’s status.

• #transformer_id ⇒ String

  Specifies the system-assigned unique identifier for the transformer.

Instance Attribute Details

#edi_type ⇒ Types::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.

Returns:

• (Types::EdiType)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#file_format ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#input_conversion ⇒ Types::InputConversion

To update, specify the ‘InputConversion` object, which contains the format options for the inbound transformation.

Returns:

• (Types::InputConversion)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#mapping ⇒ Types::Mapping

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

Returns:

• (Types::Mapping)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#mapping_template ⇒ String

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

<note markdown=“1”> This parameter is available for backwards compatibility. Use the

Mapping][1

data type instead.

</note>

[1]: docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html

Returns:

• (String)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Specify a new name for the transformer, if you want to update it.

Returns:

• (String)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#output_conversion ⇒ Types::OutputConversion

To update, specify the ‘OutputConversion` object, which contains the format options for the outbound transformation.

Returns:

• (Types::OutputConversion)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#sample_document ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#sample_documents ⇒ Types::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.

Returns:

• (Types::SampleDocuments)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Specifies the transformer’s status. You can update the state of the transformer from ‘inactive` to `active`.

Returns:

• (String)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end

#transformer_id ⇒ String

Specifies the system-assigned unique identifier for the transformer.

Returns:

• (String)

# File 'lib/aws-sdk-b2bi/types.rb', line 2563

class UpdateTransformerRequest < Struct.new(
  :transformer_id,
  :name,
  :status,
  :file_format,
  :mapping_template,
  :edi_type,
  :sample_document,
  :input_conversion,
  :mapping,
  :output_conversion,
  :sample_documents)
  SENSITIVE = []
  include Aws::Structure
end