Class: Aws::B2bi::Types::TransformerSummary

Inherits:

Struct

Object
Struct
Aws::B2bi::Types::TransformerSummary

show all

Defined in:: gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb

Overview

Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#created_at ⇒ Time
Returns a timestamp indicating when the transformer was created.
#edi_type ⇒ Types::EdiType
Returns the details for the EDI standard that is being used for the transformer.
#file_format ⇒ String
Returns that the currently supported file formats for EDI transformations are JSON and XML.
#input_conversion ⇒ Types::InputConversion
Returns a structure that contains the format options for the transformation.
#mapping ⇒ Types::Mapping
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
#mapping_template ⇒ String
Returns the mapping template for the transformer.
#modified_at ⇒ Time
Returns a timestamp representing the date and time for the most recent change for the transformer object.
#name ⇒ String
Returns the descriptive name for the transformer.
#output_conversion ⇒ Types::OutputConversion
Returns the OutputConversion object, which contains the format options for the outbound transformation.
#sample_document ⇒ String
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
#sample_documents ⇒ Types::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 ⇒ String
Returns the state of the newly created transformer.
#transformer_id ⇒ String
Returns the system-assigned unique identifier for the transformer.

Instance Attribute Details

#created_at ⇒ `Time`

Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.

Returns:

(Time)

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

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

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

Returns:

(Types::EdiType)

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

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

#file_format ⇒ `String`

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

Returns:

(String)

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

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

#input_conversion ⇒ `Types::InputConversion`

Returns a structure that contains the format options for the transformation.

Returns:

(Types::InputConversion)

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

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

#mapping ⇒ `Types::Mapping`

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

Returns:

(Types::Mapping)

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

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

#mapping_template ⇒ `String`

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

Returns:

(String)

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

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

#modified_at ⇒ `Time`

Returns a timestamp representing the date and time for the most recent change for the transformer object.

Returns:

(Time)

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

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

#name ⇒ `String`

Returns the descriptive name for the transformer.

Returns:

(String)

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

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

#output_conversion ⇒ `Types::OutputConversion`

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

Returns:

(Types::OutputConversion)

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

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

#sample_document ⇒ `String`

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

Returns:

(String)

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

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

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

Returns:

(Types::SampleDocuments)

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

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

#status ⇒ `String`

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.

Returns:

(String)

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

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

#transformer_id ⇒ `String`

Returns the system-assigned unique identifier for the transformer.

Returns:

(String)

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

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

Class: Aws::B2bi::Types::TransformerSummary

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

#edi_type ⇒ Types::EdiType

#file_format ⇒ String

#input_conversion ⇒ Types::InputConversion

#mapping ⇒ Types::Mapping

#mapping_template ⇒ String

#modified_at ⇒ Time

#name ⇒ String

#output_conversion ⇒ Types::OutputConversion

#sample_document ⇒ String

#sample_documents ⇒ Types::SampleDocuments

#status ⇒ String

#transformer_id ⇒ String

#created_at ⇒ `Time`

#edi_type ⇒ `Types::EdiType`

#file_format ⇒ `String`

#input_conversion ⇒ `Types::InputConversion`

#mapping ⇒ `Types::Mapping`

#mapping_template ⇒ `String`

#modified_at ⇒ `Time`

#name ⇒ `String`

#output_conversion ⇒ `Types::OutputConversion`

#sample_document ⇒ `String`

#sample_documents ⇒ `Types::SampleDocuments`

#status ⇒ `String`

#transformer_id ⇒ `String`