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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#created_atTime

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

Returns:

  • (Time)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_typeTypes::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:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_formatString

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

Returns:

  • (String)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_conversionTypes::InputConversion

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



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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

#mappingTypes::Mapping

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

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_templateString

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

Returns:

  • (String)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_atTime

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

Returns:

  • (Time)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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

#nameString

Returns the descriptive name for the transformer.

Returns:

  • (String)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_conversionTypes::OutputConversion

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



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_documentString

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

Returns:

  • (String)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_documentsTypes::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.



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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

#statusString

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)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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_idString

Returns the system-assigned unique identifier for the transformer.

Returns:

  • (String)


2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
# File 'gems/aws-sdk-b2bi/lib/aws-sdk-b2bi/types.rb', line 2186

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