Module Smaws_Client_B2bi

b2bi client library built on EIO.

Types

module Types : sig ... end

Builders

val make_x12_code_list_validation_rule : ?codes_to_remove:Types.code_list -> ?codes_to_add:Types.code_list -> element_id:Types.element_id -> unit -> Types.x12_code_list_validation_rule
val make_x12_element_length_validation_rule : min_length:Smaws_Lib.Smithy_api.Types.integer -> max_length:Smaws_Lib.Smithy_api.Types.integer -> element_id:Types.element_id -> unit -> Types.x12_element_length_validation_rule
val make_x12_element_requirement_validation_rule : requirement:Types.element_requirement -> element_position:Types.element_position -> unit -> Types.x12_element_requirement_validation_rule
val make_x12_validation_options : ?validation_rules:Types.x12_validation_rules -> unit -> Types.x12_validation_options
val make_x12_split_options : split_by:Types.x12_split_by -> unit -> Types.x12_split_options
val make_x12_interchange_control_headers : ?usage_indicator_code:Types.x12_usage_indicator_code -> ?acknowledgment_requested_code:Types.x12_acknowledgment_requested_code -> ?repetition_separator:Types.x12_repetition_separator -> ?receiver_id:Types.x12_receiver_id -> ?receiver_id_qualifier:Types.x12_id_qualifier -> ?sender_id:Types.x12_sender_id -> ?sender_id_qualifier:Types.x12_id_qualifier -> unit -> Types.x12_interchange_control_headers
val make_x12_functional_group_headers : ?responsible_agency_code:Types.x12_responsible_agency_code -> ?application_receiver_code:Types.x12_application_receiver_code -> ?application_sender_code:Types.x12_application_sender_code -> unit -> Types.x12_functional_group_headers
val make_x12_delimiters : ?segment_terminator:Types.x12_segment_terminator -> ?data_element_separator:Types.x12_data_element_separator -> ?component_separator:Types.x12_component_separator -> unit -> Types.x12_delimiters
val make_x12_control_numbers : ?starting_transaction_set_control_number: Types.starting_transaction_set_control_number -> ?starting_functional_group_control_number: Types.starting_functional_group_control_number -> ?starting_interchange_control_number: Types.starting_interchange_control_number -> unit -> Types.x12_control_numbers
val make_x12_outbound_edi_headers : ?gs05_time_format:Types.x12gs05_time_format -> ?control_numbers:Types.x12_control_numbers -> ?validate_edi:Types.x12_validate_edi -> ?delimiters:Types.x12_delimiters -> ?functional_group_headers:Types.x12_functional_group_headers -> ?interchange_control_headers:Types.x12_interchange_control_headers -> unit -> Types.x12_outbound_edi_headers
val make_x12_acknowledgment_options : technical_acknowledgment:Types.x12_technical_acknowledgment -> functional_acknowledgment:Types.x12_functional_acknowledgment -> unit -> Types.x12_acknowledgment_options
val make_x12_inbound_edi_options : ?acknowledgment_options:Types.x12_acknowledgment_options -> unit -> Types.x12_inbound_edi_options
val make_wrap_options : ?line_length:Types.line_length -> ?line_terminator:Types.line_terminator -> wrap_by:Types.wrap_format -> unit -> Types.wrap_options
val make_x12_envelope : ?wrap_options:Types.wrap_options -> ?common:Types.x12_outbound_edi_headers -> unit -> Types.x12_envelope
val make_x12_details : ?version:Types.x12_version -> ?transaction_set:Types.x12_transaction_set -> unit -> Types.x12_details
val make_x12_advanced_options : ?validation_options:Types.x12_validation_options -> ?split_options:Types.x12_split_options -> unit -> Types.x12_advanced_options
val make_advanced_options : ?x12:Types.x12_advanced_options -> unit -> Types.advanced_options
val make_input_conversion : ?advanced_options:Types.advanced_options -> ?format_options:Types.format_options -> from_format:Types.from_format -> unit -> Types.input_conversion
val make_mapping : ?template:Types.mapping_template -> template_language:Types.mapping_template_language -> unit -> Types.mapping
val make_output_conversion : ?advanced_options:Types.advanced_options -> ?format_options:Types.format_options -> to_format:Types.to_format -> unit -> Types.output_conversion
val make_sample_document_keys : ?output:Types.s3_key -> ?input:Types.s3_key -> unit -> Types.sample_document_keys
val make_sample_documents : keys:Types.key_list -> bucket_name:Types.bucket_name -> unit -> Types.sample_documents
val make_update_transformer_response : ?sample_documents:Types.sample_documents -> ?output_conversion:Types.output_conversion -> ?mapping:Types.mapping -> ?input_conversion:Types.input_conversion -> ?sample_document:Types.file_location -> ?edi_type:Types.edi_type -> ?mapping_template:Types.mapping_template -> ?file_format:Types.file_format -> modified_at:Types.modified_date -> created_at:Types.created_date -> status:Types.transformer_status -> name:Types.transformer_name -> transformer_arn:Types.resource_arn -> transformer_id:Types.transformer_id -> unit -> Types.update_transformer_response
val make_update_transformer_request : ?sample_documents:Types.sample_documents -> ?output_conversion:Types.output_conversion -> ?mapping:Types.mapping -> ?input_conversion:Types.input_conversion -> ?sample_document:Types.file_location -> ?edi_type:Types.edi_type -> ?mapping_template:Types.mapping_template -> ?file_format:Types.file_format -> ?status:Types.transformer_status -> ?name:Types.transformer_name -> transformer_id:Types.transformer_id -> unit -> Types.update_transformer_request
val make_update_profile_response : ?modified_at:Types.modified_date -> ?log_group_name:Types.log_group_name -> ?logging:Types.logging -> ?email:Types.email -> created_at:Types.created_date -> business_name:Types.business_name -> phone:Types.phone -> name:Types.profile_name -> profile_arn:Types.resource_arn -> profile_id:Types.profile_id -> unit -> Types.update_profile_response
val make_update_profile_request : ?business_name:Types.business_name -> ?phone:Types.phone -> ?email:Types.email -> ?name:Types.profile_name -> profile_id:Types.profile_id -> unit -> Types.update_profile_request
val make_inbound_edi_options : ?x12:Types.x12_inbound_edi_options -> unit -> Types.inbound_edi_options
val make_capability_options : ?inbound_edi:Types.inbound_edi_options -> ?outbound_edi:Types.outbound_edi_options -> unit -> Types.capability_options
val make_update_partnership_response : ?modified_at:Types.modified_date -> ?trading_partner_id:Types.trading_partner_id -> ?capability_options:Types.capability_options -> ?capabilities:Types.partnership_capabilities -> ?phone:Types.phone -> ?email:Types.email -> ?name:Types.partner_name -> created_at:Types.created_date -> partnership_arn:Types.resource_arn -> partnership_id:Types.partnership_id -> profile_id:Types.profile_id -> unit -> Types.update_partnership_response
val make_update_partnership_request : ?capability_options:Types.capability_options -> ?capabilities:Types.partnership_capabilities -> ?name:Types.partner_name -> partnership_id:Types.partnership_id -> unit -> Types.update_partnership_request
val make_s3_location : ?key:Types.s3_key -> ?bucket_name:Types.bucket_name -> unit -> Types.s3_location
val make_edi_configuration : ?capability_direction:Types.capability_direction -> transformer_id:Types.transformer_id -> output_location:Types.s3_location -> input_location:Types.s3_location -> type_:Types.edi_type -> unit -> Types.edi_configuration
val make_update_capability_response : ?modified_at:Types.modified_date -> ?instructions_documents:Types.instructions_documents -> created_at:Types.created_date -> configuration:Types.capability_configuration -> type_:Types.capability_type -> name:Types.capability_name -> capability_arn:Types.resource_arn -> capability_id:Types.capability_id -> unit -> Types.update_capability_response
val make_update_capability_request : ?instructions_documents:Types.instructions_documents -> ?configuration:Types.capability_configuration -> ?name:Types.capability_name -> capability_id:Types.capability_id -> unit -> Types.update_capability_request
val make_untag_resource_request : tag_keys:Types.tag_key_list -> resource_ar_n:Types.amazon_resource_name -> unit -> Types.untag_resource_request
val make_transformer_summary : ?sample_documents:Types.sample_documents -> ?output_conversion:Types.output_conversion -> ?mapping:Types.mapping -> ?input_conversion:Types.input_conversion -> ?sample_document:Types.file_location -> ?edi_type:Types.edi_type -> ?mapping_template:Types.mapping_template -> ?file_format:Types.file_format -> ?modified_at:Types.modified_date -> created_at:Types.created_date -> status:Types.transformer_status -> name:Types.transformer_name -> transformer_id:Types.transformer_id -> unit -> Types.transformer_summary
val make_test_parsing_response : ?validation_messages:Types.validation_messages -> ?parsed_split_file_contents:Types.parsed_split_file_contents_list -> parsed_file_content:Smaws_Lib.Smithy_api.Types.string_ -> unit -> Types.test_parsing_response
val make_test_parsing_request : ?advanced_options:Types.advanced_options -> edi_type:Types.edi_type -> file_format:Types.file_format -> input_file:Types.s3_location -> unit -> Types.test_parsing_request
val make_test_mapping_response : mapped_file_content:Smaws_Lib.Smithy_api.Types.string_ -> unit -> Types.test_mapping_response
val make_test_mapping_request : file_format:Types.file_format -> mapping_template:Types.mapping_template -> input_file_content:Types.test_mapping_input_file_content -> unit -> Types.test_mapping_request
val make_test_conversion_response : ?validation_messages:Types.validation_messages -> converted_file_content:Smaws_Lib.Smithy_api.Types.string_ -> unit -> Types.test_conversion_response
val make_conversion_source : input_file:Types.input_file_source -> file_format:Types.conversion_source_format -> unit -> Types.conversion_source
val make_conversion_target : ?advanced_options:Types.advanced_options -> ?output_sample_file:Types.output_sample_file_source -> ?format_details:Types.conversion_target_format_details -> file_format:Types.conversion_target_format -> unit -> Types.conversion_target
val make_test_conversion_request : target:Types.conversion_target -> source:Types.conversion_source -> unit -> Types.test_conversion_request
val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tag_list -> resource_ar_n:Types.amazon_resource_name -> unit -> Types.tag_resource_request
val make_start_transformer_job_response : transformer_job_id:Types.transformer_job_id -> unit -> Types.start_transformer_job_response
val make_start_transformer_job_request : ?client_token:Smaws_Lib.Smithy_api.Types.string_ -> transformer_id:Types.transformer_id -> output_location:Types.s3_location -> input_file:Types.s3_location -> unit -> Types.start_transformer_job_request
val make_profile_summary : ?modified_at:Types.modified_date -> ?log_group_name:Types.log_group_name -> ?logging:Types.logging -> created_at:Types.created_date -> business_name:Types.business_name -> name:Types.profile_name -> profile_id:Types.profile_id -> unit -> Types.profile_summary
val make_partnership_summary : ?modified_at:Types.modified_date -> ?trading_partner_id:Types.trading_partner_id -> ?capability_options:Types.capability_options -> ?capabilities:Types.partnership_capabilities -> ?name:Types.partner_name -> created_at:Types.created_date -> partnership_id:Types.partnership_id -> profile_id:Types.profile_id -> unit -> Types.partnership_summary
val make_list_transformers_response : ?next_token:Types.page_token -> transformers:Types.transformer_list -> unit -> Types.list_transformers_response
val make_list_transformers_request : ?max_results:Types.max_results -> ?next_token:Types.page_token -> unit -> Types.list_transformers_request
val make_list_tags_for_resource_response : ?tags:Types.tag_list -> unit -> Types.list_tags_for_resource_response
val make_list_tags_for_resource_request : resource_ar_n:Types.amazon_resource_name -> unit -> Types.list_tags_for_resource_request
val make_list_profiles_response : ?next_token:Types.page_token -> profiles:Types.profile_list -> unit -> Types.list_profiles_response
val make_list_profiles_request : ?max_results:Types.max_results -> ?next_token:Types.page_token -> unit -> Types.list_profiles_request
val make_list_partnerships_response : ?next_token:Types.page_token -> partnerships:Types.partnership_list -> unit -> Types.list_partnerships_response
val make_list_partnerships_request : ?max_results:Types.max_results -> ?next_token:Types.page_token -> ?profile_id:Types.profile_id -> unit -> Types.list_partnerships_request
val make_capability_summary : ?modified_at:Types.modified_date -> created_at:Types.created_date -> type_:Types.capability_type -> name:Types.capability_name -> capability_id:Types.capability_id -> unit -> Types.capability_summary
val make_list_capabilities_response : ?next_token:Types.page_token -> capabilities:Types.capability_list -> unit -> Types.list_capabilities_response
val make_list_capabilities_request : ?max_results:Types.max_results -> ?next_token:Types.page_token -> unit -> Types.list_capabilities_request
val make_get_transformer_response : ?sample_documents:Types.sample_documents -> ?output_conversion:Types.output_conversion -> ?mapping:Types.mapping -> ?input_conversion:Types.input_conversion -> ?sample_document:Types.file_location -> ?edi_type:Types.edi_type -> ?mapping_template:Types.mapping_template -> ?file_format:Types.file_format -> ?modified_at:Types.modified_date -> created_at:Types.created_date -> status:Types.transformer_status -> name:Types.transformer_name -> transformer_arn:Types.resource_arn -> transformer_id:Types.transformer_id -> unit -> Types.get_transformer_response
val make_get_transformer_request : transformer_id:Types.transformer_id -> unit -> Types.get_transformer_request
val make_get_transformer_job_response : ?message:Smaws_Lib.Smithy_api.Types.string_ -> ?output_files:Types.s3_location_list -> status:Types.transformer_job_status -> unit -> Types.get_transformer_job_response
val make_get_transformer_job_request : transformer_id:Types.transformer_id -> transformer_job_id:Types.transformer_job_id -> unit -> Types.get_transformer_job_request
val make_get_profile_response : ?modified_at:Types.modified_date -> ?log_group_name:Types.log_group_name -> ?logging:Types.logging -> ?email:Types.email -> created_at:Types.created_date -> business_name:Types.business_name -> phone:Types.phone -> name:Types.profile_name -> profile_arn:Types.resource_arn -> profile_id:Types.profile_id -> unit -> Types.get_profile_response
val make_get_profile_request : profile_id:Types.profile_id -> unit -> Types.get_profile_request
val make_get_partnership_response : ?modified_at:Types.modified_date -> ?trading_partner_id:Types.trading_partner_id -> ?capability_options:Types.capability_options -> ?capabilities:Types.partnership_capabilities -> ?phone:Types.phone -> ?email:Types.email -> ?name:Types.partner_name -> created_at:Types.created_date -> partnership_arn:Types.resource_arn -> partnership_id:Types.partnership_id -> profile_id:Types.profile_id -> unit -> Types.get_partnership_response
val make_get_partnership_request : partnership_id:Types.partnership_id -> unit -> Types.get_partnership_request
val make_get_capability_response : ?modified_at:Types.modified_date -> ?instructions_documents:Types.instructions_documents -> created_at:Types.created_date -> configuration:Types.capability_configuration -> type_:Types.capability_type -> name:Types.capability_name -> capability_arn:Types.resource_arn -> capability_id:Types.capability_id -> unit -> Types.get_capability_response
val make_get_capability_request : capability_id:Types.capability_id -> unit -> Types.get_capability_request
val make_generate_mapping_response : ?mapping_accuracy:Smaws_Lib.Smithy_api.Types.float_ -> mapping_template:Smaws_Lib.Smithy_api.Types.string_ -> unit -> Types.generate_mapping_response
val make_generate_mapping_request : mapping_type:Types.mapping_type -> output_file_content:Types.generate_mapping_output_file_content -> input_file_content:Types.generate_mapping_input_file_content -> unit -> Types.generate_mapping_request
val make_delete_transformer_request : transformer_id:Types.transformer_id -> unit -> Types.delete_transformer_request
val make_delete_profile_request : profile_id:Types.profile_id -> unit -> Types.delete_profile_request
val make_delete_partnership_request : partnership_id:Types.partnership_id -> unit -> Types.delete_partnership_request
val make_delete_capability_request : capability_id:Types.capability_id -> unit -> Types.delete_capability_request
val make_create_transformer_response : ?sample_documents:Types.sample_documents -> ?output_conversion:Types.output_conversion -> ?mapping:Types.mapping -> ?input_conversion:Types.input_conversion -> ?sample_document:Types.file_location -> ?edi_type:Types.edi_type -> ?mapping_template:Types.mapping_template -> ?file_format:Types.file_format -> created_at:Types.created_date -> status:Types.transformer_status -> name:Types.transformer_name -> transformer_arn:Types.resource_arn -> transformer_id:Types.transformer_id -> unit -> Types.create_transformer_response
val make_create_transformer_request : ?sample_documents:Types.sample_documents -> ?output_conversion:Types.output_conversion -> ?mapping:Types.mapping -> ?input_conversion:Types.input_conversion -> ?sample_document:Types.file_location -> ?edi_type:Types.edi_type -> ?mapping_template:Types.mapping_template -> ?file_format:Types.file_format -> ?tags:Types.tag_list -> ?client_token:Smaws_Lib.Smithy_api.Types.string_ -> name:Types.transformer_name -> unit -> Types.create_transformer_request
val make_create_starter_mapping_template_response : mapping_template:Smaws_Lib.Smithy_api.Types.string_ -> unit -> Types.create_starter_mapping_template_response
val make_create_starter_mapping_template_request : ?output_sample_location:Types.s3_location -> template_details:Types.template_details -> mapping_type:Types.mapping_type -> unit -> Types.create_starter_mapping_template_request
val make_create_profile_response : ?log_group_name:Types.log_group_name -> ?logging:Types.logging -> ?email:Types.email -> created_at:Types.created_date -> phone:Types.phone -> business_name:Types.business_name -> name:Types.profile_name -> profile_arn:Types.resource_arn -> profile_id:Types.profile_id -> unit -> Types.create_profile_response
val make_create_profile_request : ?tags:Types.tag_list -> ?client_token:Smaws_Lib.Smithy_api.Types.string_ -> ?email:Types.email -> logging:Types.logging -> business_name:Types.business_name -> phone:Types.phone -> name:Types.profile_name -> unit -> Types.create_profile_request
val make_create_partnership_response : ?trading_partner_id:Types.trading_partner_id -> ?capability_options:Types.capability_options -> ?capabilities:Types.partnership_capabilities -> ?phone:Types.phone -> ?email:Types.email -> ?name:Types.partner_name -> created_at:Types.created_date -> partnership_arn:Types.resource_arn -> partnership_id:Types.partnership_id -> profile_id:Types.profile_id -> unit -> Types.create_partnership_response
val make_create_partnership_request : ?tags:Types.tag_list -> ?client_token:Smaws_Lib.Smithy_api.Types.string_ -> ?capability_options:Types.capability_options -> ?phone:Types.phone -> capabilities:Types.partnership_capabilities -> email:Types.email -> name:Types.partner_name -> profile_id:Types.profile_id -> unit -> Types.create_partnership_request
val make_create_capability_response : ?instructions_documents:Types.instructions_documents -> created_at:Types.created_date -> configuration:Types.capability_configuration -> type_:Types.capability_type -> name:Types.capability_name -> capability_arn:Types.resource_arn -> capability_id:Types.capability_id -> unit -> Types.create_capability_response
val make_create_capability_request : ?tags:Types.tag_list -> ?client_token:Smaws_Lib.Smithy_api.Types.string_ -> ?instructions_documents:Types.instructions_documents -> configuration:Types.capability_configuration -> type_:Types.capability_type -> name:Types.capability_name -> unit -> Types.create_capability_request

Operations

module CreateCapability : sig ... end

Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

module CreatePartnership : sig ... end

Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

module CreateProfile : sig ... end

Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.

module CreateStarterMappingTemplate : sig ... end

Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.

module CreateTransformer : sig ... end

Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:

module DeleteCapability : sig ... end

Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

module DeletePartnership : sig ... end

Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

module DeleteProfile : sig ... end

Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.

module DeleteTransformer : sig ... end

Deletes the specified transformer. 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.

module GenerateMapping : sig ... end

Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then edit the mapping for your needs.

module GetCapability : sig ... end

Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

module GetPartnership : sig ... end

Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

module GetProfile : sig ... end

Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.

module GetTransformer : sig ... end

Retrieves the details for the transformer specified by the transformer ID. 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.

module GetTransformerJob : sig ... end

Returns the details of the transformer run, based on the Transformer job ID.

module ListCapabilities : sig ... end

Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

module ListPartnerships : sig ... end

Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

module ListProfiles : sig ... end

Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.

module ListTagsForResource : sig ... end

Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.

module ListTransformers : sig ... end

Lists the available transformers. 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.

module StartTransformerJob : sig ... end

Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.

module TagResource : sig ... end

Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.

module TestConversion : sig ... end

This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.

module TestMapping : sig ... end

Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.

module TestParsing : sig ... end

Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.

module UntagResource : sig ... end

Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.

module UpdateCapability : sig ... end

Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

module UpdatePartnership : sig ... end

Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

module UpdateProfile : sig ... end

Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.

module UpdateTransformer : sig ... end
module Json_serializers : sig ... end
module Json_deserializers : sig ... end