Class: Aws::B2bi::Types::CreateTransformerRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-b2bi/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Reserved for future use.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

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

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



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

class CreateTransformerRequest < Struct.new(
  :name,
  :client_token,
  :tags,
  :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) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

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

#input_conversion ⇒ Types::InputConversion

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

Returns:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

class CreateTransformerRequest < Struct.new(
  :name,
  :client_token,
  :tags,
  :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:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

class CreateTransformerRequest < Struct.new(
  :name,
  :client_token,
  :tags,
  :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) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

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

#name ⇒ String

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

Returns:

  • (String) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

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

#output_conversion ⇒ Types::OutputConversion

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

Returns:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

class CreateTransformerRequest < Struct.new(
  :name,
  :client_token,
  :tags,
  :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) 


646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

class CreateTransformerRequest < Struct.new(
  :name,
  :client_token,
  :tags,
  :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:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

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

#tags ⇒ Array<Types::Tag>

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.

Returns:



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/aws-sdk-b2bi/types.rb', line 646

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