Smaws_Client_B2bi.Typestype nonrec code_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec x12_code_list_validation_rule = {codes_to_remove : code_list option;Specifies a list of code values to remove from the element's allowed values. These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.
*)codes_to_add : code_list option;Specifies a list of code values to add to the element's allowed values. These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.
*)element_id : element_id;Specifies the four-digit element ID to which the code list modifications apply. This identifies which X12 element will have its allowed code values modified.
*)}Defines a validation rule that modifies the allowed code values for a specific X12 element. This rule allows you to add or remove valid codes from an element's standard code list, providing flexibility to accommodate trading partner-specific requirements or industry variations. You can specify codes to add to expand the allowed values beyond the X12 standard, or codes to remove to restrict the allowed values for stricter validation.
type nonrec x12_element_length_validation_rule = {min_length : Smaws_Lib.Smithy_api.Types.integer;Specifies the minimum required length for the identified element. This value must be between 1 and 200 characters and defines the lower limit for the element's content length.
*)max_length : Smaws_Lib.Smithy_api.Types.integer;Specifies the maximum allowed length for the identified element. This value must be between 1 and 200 characters and defines the upper limit for the element's content length.
*)element_id : element_id;Specifies the four-digit element ID to which the length constraints will be applied. This identifies which X12 element will have its length requirements modified.
*)}Defines a validation rule that specifies custom length constraints for a specific X12 element. This rule allows you to override the standard minimum and maximum length requirements for an element, enabling validation of trading partner-specific length requirements that may differ from the X12 specification. Both minimum and maximum length values must be specified and must be between 1 and 200 characters.
type nonrec x12_element_requirement_validation_rule = {requirement : element_requirement;Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).
*)element_position : element_position;Specifies the position of the element within an X12 segment for which the requirement status will be modified. The format follows the pattern of segment identifier followed by element position (e.g., "ST-01" for the first element of the ST segment).
*)}Defines a validation rule that modifies the requirement status of a specific X12 element within a segment. This rule allows you to make optional elements mandatory or mandatory elements optional, providing flexibility to accommodate different trading partner requirements and business rules. The rule targets a specific element position within a segment and sets its requirement status to either OPTIONAL or MANDATORY.
type nonrec x12_validation_rule = | ElementRequirementValidationRule of x12_element_requirement_validation_ruleSpecifies an element requirement validation rule that modifies whether a specific X12 element is required or optional within a segment. This rule provides flexibility to accommodate different trading partner requirements for element presence.
*)| ElementLengthValidationRule of x12_element_length_validation_ruleSpecifies an element length validation rule that defines custom length constraints for a specific X12 element. This rule allows you to enforce minimum and maximum length requirements that may differ from the standard X12 specification.
*)| CodeListValidationRule of x12_code_list_validation_ruleSpecifies a code list validation rule that modifies the allowed code values for a specific X12 element. This rule enables you to customize which codes are considered valid for an element, allowing for trading partner-specific code requirements.
*)Represents a single validation rule that can be applied during X12 EDI processing. This is a union type that can contain one of several specific validation rule types: code list validation rules for modifying allowed element codes, element length validation rules for enforcing custom length constraints, or element requirement validation rules for changing mandatory/optional status. Each validation rule targets specific aspects of EDI document validation to ensure compliance with trading partner requirements and business rules.
type nonrec x12_validation_rules = x12_validation_rule listtype nonrec x12_validation_options = {validation_rules : x12_validation_rules option;Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes.
*)}Contains configuration options for X12 EDI validation. This structure allows you to specify custom validation rules that will be applied during EDI document processing, including element length constraints, code list modifications, and element requirement changes. These validation options provide flexibility to accommodate trading partner-specific requirements while maintaining EDI compliance. The validation rules are applied in addition to standard X12 validation to ensure documents meet both standard and custom requirements.
type nonrec x12_transaction_set = | X12_999_X231| X12_837_X298| X12_837_X292| X12_837_X291| X12_837_X224| X12_837_X223| X12_837_X222| X12_835_X221| X12_834_X318| X12_834_X307| X12_834_X220| X12_824_X186| X12_820_X306| X12_820_X218| X12_278_X217| X12_277_X364| X12_277_X214| X12_277_X212| X12_276_X212| X12_275_X211| X12_275_X210| X12_271_X279| X12_270_X279| X12_999| X12_998| X12_997| X12_996| X12_993| X12_990| X12_980| X12_947| X12_945| X12_944| X12_943| X12_940| X12_928| X12_926| X12_925| X12_924| X12_920| X12_896| X12_895| X12_894| X12_893| X12_891| X12_889| X12_888| X12_887| X12_886| X12_885| X12_884| X12_883| X12_882| X12_881| X12_880| X12_879| X12_878| X12_877| X12_876| X12_875| X12_874| X12_873| X12_872| X12_871| X12_870| X12_869| X12_868| X12_867| X12_866| X12_865| X12_864| X12_863| X12_862| X12_861| X12_860| X12_859| X12_858| X12_857| X12_856| X12_855| X12_854| X12_853| X12_852| X12_851| X12_850| X12_849| X12_848| X12_847| X12_846| X12_845| X12_844| X12_843| X12_842| X12_841| X12_840| X12_839| X12_838| X12_837| X12_836| X12_835| X12_834| X12_833| X12_832| X12_831| X12_830| X12_829| X12_828| X12_827| X12_826| X12_824| X12_823| X12_822| X12_821| X12_820| X12_819| X12_818| X12_816| X12_815| X12_814| X12_813| X12_812| X12_811| X12_810| X12_806| X12_805| X12_754| X12_753| X12_715| X12_650| X12_625| X12_620| X12_602| X12_601| X12_568| X12_567| X12_561| X12_540| X12_536| X12_527| X12_521| X12_517| X12_511| X12_504| X12_503| X12_501| X12_500| X12_494| X12_492| X12_490| X12_486| X12_485| X12_475| X12_470| X12_468| X12_466| X12_463| X12_460| X12_456| X12_455| X12_453| X12_452| X12_451| X12_440| X12_437| X12_436| X12_435| X12_434| X12_433| X12_432| X12_431| X12_429| X12_426| X12_425| X12_424| X12_423| X12_422| X12_421| X12_420| X12_419| X12_418| X12_417| X12_414| X12_412| X12_410| X12_404| X12_362| X12_361| X12_358| X12_357| X12_356| X12_355| X12_354| X12_353| X12_352| X12_350| X12_326| X12_325| X12_324| X12_323| X12_322| X12_319| X12_317| X12_315| X12_313| X12_312| X12_311| X12_310| X12_309| X12_304| X12_303| X12_301| X12_300| X12_290| X12_288| X12_286| X12_285| X12_284| X12_283| X12_280| X12_278| X12_277| X12_276| X12_275| X12_274| X12_273| X12_272| X12_271| X12_270| X12_269| X12_268| X12_267| X12_266| X12_265| X12_264| X12_263| X12_262| X12_261| X12_260| X12_259| X12_256| X12_255| X12_252| X12_251| X12_250| X12_249| X12_248| X12_245| X12_244| X12_242| X12_240| X12_228| X12_227| X12_225| X12_224| X12_223| X12_222| X12_220| X12_219| X12_218| X12_217| X12_216| X12_215| X12_214| X12_213| X12_212| X12_211| X12_210| X12_206| X12_205| X12_204| X12_203| X12_202| X12_201| X12_200| X12_199| X12_198| X12_197| X12_196| X12_195| X12_194| X12_191| X12_190| X12_189| X12_188| X12_187| X12_186| X12_185| X12_180| X12_179| X12_176| X12_175| X12_170| X12_163| X12_161| X12_160| X12_159| X12_158| X12_157| X12_155| X12_154| X12_153| X12_152| X12_151| X12_150| X12_149| X12_148| X12_147| X12_146| X12_144| X12_143| X12_142| X12_141| X12_140| X12_139| X12_138| X12_135| X12_133| X12_132| X12_131| X12_130| X12_129| X12_128| X12_127| X12_126| X12_125| X12_124| X12_121| X12_120| X12_113| X12_112| X12_111| X12_110| X12_109| X12_108| X12_107| X12_106| X12_105| X12_104| X12_103| X12_102| X12_101| X12_100type nonrec x12_split_options = {split_by : x12_split_by;Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).
}Contains options for splitting X12 EDI files into smaller units. This is useful for processing large EDI files more efficiently.
type nonrec x12_interchange_control_headers = {usage_indicator_code : x12_usage_indicator_code option;Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.P indicates this interchange is for production.I indicates this interchange is informational.acknowledgment_requested_code : x12_acknowledgment_requested_code option;Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
*)repetition_separator : x12_repetition_separator option;Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
This parameter is only honored for version greater than 401 (VERSION_4010 and higher).
For versions less than 401, this field is called StandardsId, in which case our service sets the value to U.
receiver_id : x12_receiver_id option;Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
receiver_id_qualifier : x12_id_qualifier option;Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
*)sender_id : x12_sender_id option;Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
sender_id_qualifier : x12_id_qualifier option;Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
*)}In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.
type nonrec x12_functional_group_headers = {responsible_agency_code : x12_responsible_agency_code option;A code that identifies the issuer of the standard, at position GS-07.
*)application_receiver_code : x12_application_receiver_code option;A value representing the code used to identify the party receiving a message, at position GS-03.
*)application_sender_code : x12_application_sender_code option;A value representing the code used to identify the party transmitting a message, at position GS-02.
*)}Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
type nonrec x12_delimiters = {segment_terminator : x12_segment_terminator option;The segment terminator. The default value is ~ (tilde).
data_element_separator : x12_data_element_separator option;The data element separator. The default value is * (asterisk).
component_separator : x12_component_separator option;The component, or sub-element, separator. The default value is : (colon).
}In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header. The delimiters are part of the message's syntax and divide up its different elements.
type nonrec x12_control_numbers = {starting_transaction_set_control_number : starting_transaction_set_control_number
option;Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.
*)starting_functional_group_control_number : starting_functional_group_control_number
option;Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.
*)starting_interchange_control_number : starting_interchange_control_number
option;Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.
*)}Contains configuration for X12 control numbers used in X12 EDI generation. Control numbers are used to uniquely identify interchanges, functional groups, and transaction sets.
Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:
HHMM - Hours and minutesHHMMSS - Hours, minutes, and secondsHHMMSSDD - Hours, minutes, seconds, and decimal secondsWhere:
HH - Hours (00-23)MM - Minutes (00-59)SS - Seconds (00-59)DD - Hundredths of seconds (00-99)type nonrec x12_outbound_edi_headers = {gs05_time_format : x12gs05_time_format option;control_numbers : x12_control_numbers option;Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.
*)validate_edi : x12_validate_edi option;Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.
delimiters : x12_delimiters option;The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.
functional_group_headers : x12_functional_group_headers option;The functional group headers for the X12 object.
*)interchange_control_headers : x12_interchange_control_headers option;In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
*)}A structure containing the details for an outbound EDI object.
type nonrec x12_acknowledgment_options = {technical_acknowledgment : x12_technical_acknowledgment;Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.
functional_acknowledgment : x12_functional_acknowledgment;Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.
If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.
}Contains options for configuring X12 acknowledgments. These options control how functional and technical acknowledgments are handled.
type nonrec x12_inbound_edi_options = {acknowledgment_options : x12_acknowledgment_options option;Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.
*)}Contains options specific to processing inbound X12 EDI files.
type nonrec wrap_options = {line_length : line_length option;Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.
line_terminator : line_terminator option;Specifies the character sequence used to terminate lines when wrapping. Valid values:
CRLF: carriage return and line feedLF: line feed)CR: carriage returnwrap_by : wrap_format;Specifies the method used for wrapping lines in the EDI output. Valid values:
SEGMENT: Wraps by segment.ONE_LINE: Indicates that the entire content is on a single line.
When you specify ONE_LINE, do not provide either the line length nor the line terminator value.
LINE_LENGTH: Wraps by character count, as specified by lineLength value.}Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.
type nonrec x12_envelope = {wrap_options : wrap_options option;common : x12_outbound_edi_headers option;A container for the X12 outbound EDI headers.
*)}A wrapper structure for an X12 definition object.
the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
type nonrec x12_details = {version : x12_version option;Returns the version to use for the specified X12 transaction set.
*)transaction_set : x12_transaction_set option;Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
*)}A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.
type nonrec x12_advanced_options = {validation_options : x12_validation_options option;Specifies validation options for X12 EDI processing. These options control how validation rules are applied during EDI document processing, including custom validation rules for element length constraints, code list validations, and element requirement checks.
*)split_options : x12_split_options option;Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.
*)}Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.
type nonrec validation_messages = Smaws_Lib.Smithy_api.Types.string_ listOccurs when a B2BI object cannot be validated against a request from another object. This exception can be thrown during standard EDI validation or when custom validation rules fail, such as when element length constraints are violated, invalid codes are used in code list validations, or required elements are missing based on configured element requirement rules.
type nonrec edi_type = | X12Details of x12_detailsReturns 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.
*)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.
A structure that contains the X12 transaction set and version.
type nonrec advanced_options = {x12 : x12_advanced_options option;A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.
*)}A structure that contains advanced options for EDI processing. Currently, only X12 advanced options are supported.
type nonrec input_conversion = {advanced_options : advanced_options option;Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.
*)format_options : format_options option;A structure that contains the formatting options for an inbound transformer.
*)from_format : from_format;The format for the transformer input: currently on X12 is supported.
}Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.
type nonrec mapping = {template : mapping_template option;A string that represents the mapping template, in the transformation language specified in templateLanguage.
template_language : mapping_template_language;The transformation language for the template, either XSLT or JSONATA.
*)}Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
type nonrec output_conversion = {advanced_options : advanced_options option;format_options : format_options option;A structure that contains the X12 transaction set and version for the transformer output.
*)to_format : to_format;The format for the output from an outbound transformer: only X12 is currently supported.
*)}Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).
type nonrec sample_document_keys = {output : s3_key option;An array of keys for your output sample documents.
*)input : s3_key option;An array of keys for your input sample documents.
*)}An array of the Amazon S3 keys used to identify the location for your sample documents.
type nonrec key_list = sample_document_keys listtype nonrec sample_documents = {keys : key_list;Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
*)bucket_name : bucket_name;Contains the Amazon S3 bucket that is used to hold your sample documents.
*)}Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
type nonrec update_transformer_response = {sample_documents : sample_documents option;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.
*)output_conversion : output_conversion option;Returns the OutputConversion object, which contains the format options for the outbound transformation.
mapping : mapping option;Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
*)input_conversion : input_conversion option;Returns the InputConversion object, which contains the format options for the inbound transformation.
sample_document : file_location option;Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
*)edi_type : edi_type option;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.
*)mapping_template : mapping_template option;Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
*)file_format : file_format option;Returns that the currently supported file formats for EDI transformations are JSON and XML.
modified_at : modified_date;Returns a timestamp for last time the transformer was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the transformer.
*)status : transformer_status;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.
name : transformer_name;Returns the name of the transformer.
*)transformer_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)transformer_id : transformer_id;Returns the system-assigned unique identifier for the transformer.
*)}type nonrec update_transformer_request = {sample_documents : sample_documents option;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.
*)output_conversion : output_conversion option;To update, specify the OutputConversion object, which contains the format options for the outbound transformation.
mapping : mapping option;Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
*)input_conversion : input_conversion option;To update, specify the InputConversion object, which contains the format options for the inbound transformation.
sample_document : file_location option;Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
*)edi_type : edi_type option;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.
*)mapping_template : mapping_template option;Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
This parameter is available for backwards compatibility. Use the Mapping data type instead.
*)file_format : file_format option;Specifies that the currently supported file formats for EDI transformations are JSON and XML.
status : transformer_status option;Specifies the transformer's status. You can update the state of the transformer from inactive to active.
name : transformer_name option;Specify a new name for the transformer, if you want to update it.
*)transformer_id : transformer_id;Specifies the system-assigned unique identifier for the transformer.
*)}type nonrec throttling_exception = {retry_after_seconds : Smaws_Lib.Smithy_api.Types.integer option;The server attempts to retry a command that was throttled.
*)message : error_message;}The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
type nonrec service_quota_exceeded_exception = {quota_code : Smaws_Lib.Smithy_api.Types.string_;The quota that was exceeded, which caused the exception.
*)service_code : Smaws_Lib.Smithy_api.Types.string_;The code responsible for exceeding the quota, which caused the exception.
*)resource_type : Smaws_Lib.Smithy_api.Types.string_;The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_;The ID for the resource that exceeded the quota, which caused the exception.
*)message : error_message;}Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
type nonrec internal_server_exception = {retry_after_seconds : Smaws_Lib.Smithy_api.Types.integer option;The server attempts to retry a failed command.
*)message : error_message;}This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.
You do not have sufficient access to perform this action.
type nonrec update_profile_response = {modified_at : modified_date option;Returns a timestamp for last time the profile was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the profile.
*)log_group_name : log_group_name option;Returns the name of the logging group.
*)logging : logging option;Specifies whether or not logging is enabled for this profile.
*)business_name : business_name;Returns the name for the business associated with this profile.
*)phone : phone;Returns the phone number associated with the profile.
*)email : email option;Returns the email address associated with this customer profile.
*)name : profile_name;Returns the name of the profile.
*)profile_arn : resource_arn;Returns an Amazon Resource Name (ARN) for the profile.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile.
*)}type nonrec update_profile_request = {business_name : business_name option;Specifies the name for the business associated with this profile.
*)phone : phone option;Specifies the phone number associated with the profile.
*)email : email option;Specifies the email address associated with this customer profile.
*)name : profile_name option;The name of the profile, used to identify it.
*)profile_id : profile_id;Specifies the unique, system-generated identifier for the profile.
*)}type nonrec partnership_capabilities = capability_id listtype nonrec outbound_edi_options = | X12 of x12_envelopeA structure that contains an X12 envelope structure.
*)A container for outbound EDI options.
type nonrec inbound_edi_options = {x12 : x12_inbound_edi_options option;A structure that contains X12-specific options for processing inbound X12 EDI files.
*)}Contains options for processing inbound EDI files. These options allow for customizing how incoming EDI documents are processed.
type nonrec capability_options = {inbound_edi : inbound_edi_options option;A structure that contains the inbound EDI options for the capability.
*)outbound_edi : outbound_edi_options option;A structure that contains the outbound EDI options.
*)}Contains the details for an Outbound EDI capability.
type nonrec update_partnership_response = {modified_at : modified_date option;Returns a timestamp that identifies the most recent date and time that the partnership was modified.
*)created_at : created_date;Returns a timestamp that identifies the most recent date and time that the partnership was modified.
*)trading_partner_id : trading_partner_id option;Returns the unique, system-generated identifier for a trading partner.
*)capability_options : capability_options option;Returns the structure that contains the details for the associated capabilities.
*)capabilities : partnership_capabilities option;Returns one or more capabilities associated with this partnership.
*)phone : phone option;Returns the phone number associated with the partnership.
*)email : email option;Returns the email address associated with this trading partner.
*)name : partner_name option;The name of the partnership, used to identify it.
*)partnership_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)partnership_id : partnership_id;Returns the unique, system-generated identifier for a partnership.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile connected to this partnership.
*)}type nonrec update_partnership_request = {capability_options : capability_options option;To update, specify the structure that contains the details for the associated capabilities.
*)capabilities : partnership_capabilities option;List of the capabilities associated with this partnership.
*)name : partner_name option;The name of the partnership, used to identify it.
*)partnership_id : partnership_id;Specifies the unique, system-generated identifier for a partnership.
*)}type nonrec s3_location = {key : s3_key option;Specifies the Amazon S3 key for the file location.
*)bucket_name : bucket_name option;Specifies the name of the Amazon S3 bucket.
*)}Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.
type nonrec edi_configuration = {transformer_id : transformer_id;Returns the system-assigned unique identifier for the transformer.
*)output_location : s3_location;Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.
input_location : s3_location;Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an S3Location object.
type_ : edi_type;Returns the type of the capability. Currently, only edi is supported.
capability_direction : capability_direction option;Specifies whether this is capability is for inbound or outbound transformations.
*)}Specifies the details for the EDI (electronic data interchange) transformation.
type nonrec capability_configuration = | Edi of edi_configurationAn EDI (electronic data interchange) configuration object.
*)A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
type nonrec instructions_documents = s3_location listtype nonrec update_capability_response = {modified_at : modified_date option;Returns a timestamp for last time the capability was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the capability.
*)instructions_documents : instructions_documents option;Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
*)configuration : capability_configuration;Returns a structure that contains the details for a capability.
*)type_ : capability_type;Returns the type of the capability. Currently, only edi is supported.
name : capability_name;Returns the name of the capability, used to identify it.
*)capability_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)capability_id : capability_id;Returns a system-assigned unique identifier for the capability.
*)}type nonrec update_capability_request = {instructions_documents : instructions_documents option;Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
*)configuration : capability_configuration option;Specifies a structure that contains the details for a capability.
*)name : capability_name option;Specifies a new name for the capability, to replace the existing name.
*)capability_id : capability_id;Specifies a system-assigned unique identifier for the capability.
*)}type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;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.
*)resource_ar_n : amazon_resource_name;Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)}type nonrec transformer_summary = {sample_documents : sample_documents option;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.
*)output_conversion : output_conversion option;Returns the OutputConversion object, which contains the format options for the outbound transformation.
mapping : mapping option;Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
*)input_conversion : input_conversion option;Returns a structure that contains the format options for the transformation.
*)sample_document : file_location option;Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
*)edi_type : edi_type option;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.
*)mapping_template : mapping_template option;Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
*)file_format : file_format option;Returns that the currently supported file formats for EDI transformations are JSON and XML.
modified_at : modified_date option;Returns a timestamp representing the date and time for the most recent change for the transformer object.
*)created_at : created_date;Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
status : transformer_status;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.
name : transformer_name;Returns the descriptive name for the transformer.
*)transformer_id : transformer_id;Returns the system-assigned unique identifier for the transformer.
*)}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.
type nonrec transformer_list = transformer_summary listtype nonrec transformer = Smaws_Lib.CoreTypes.Resource.ttype nonrec parsed_split_file_contents_list =
Smaws_Lib.Smithy_api.Types.string_ listtype nonrec test_parsing_response = {validation_messages : validation_messages option;Returns an array of validation messages generated during EDI validation. These messages provide detailed information about validation errors, warnings, or confirmations based on the configured X12 validation rules such as element length constraints, code list validations, and element requirement checks. This field is populated when the TestParsing API validates EDI documents.
parsed_split_file_contents : parsed_split_file_contents_list option;Returns an array of parsed file contents when the input file is split according to the specified split options. Each element in the array represents a separate split file's parsed content.
*)parsed_file_content : Smaws_Lib.Smithy_api.Types.string_;Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.
*)}type nonrec test_parsing_request = {advanced_options : advanced_options option;Specifies advanced options for parsing the input EDI file. These options allow for more granular control over the parsing process, including split options for X12 files.
*)edi_type : edi_type;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.
*)file_format : file_format;Specifies that the currently supported file formats for EDI transformations are JSON and XML.
input_file : s3_location;Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.
}type nonrec test_mapping_response = {mapped_file_content : Smaws_Lib.Smithy_api.Types.string_;Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint
*)}type nonrec test_mapping_request = {file_format : file_format;Specifies that the currently supported file formats for EDI transformations are JSON and XML.
mapping_template : mapping_template;Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
This parameter is available for backwards compatibility. Use the Mapping data type instead.
*)input_file_content : test_mapping_input_file_content;Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
*)}type nonrec test_conversion_response = {validation_messages : validation_messages option;Returns an array of validation messages that Amazon Web Services B2B Data Interchange generates during the conversion process. These messages include both standard EDI validation results and custom validation messages when custom validation rules are configured. Custom validation messages provide detailed feedback on element length constraints, code list validations, and element requirement checks applied during the outbound EDI generation process.
*)converted_file_content : Smaws_Lib.Smithy_api.Types.string_;Returns the converted file content.
*)}type nonrec input_file_source = | FileContent of Smaws_Lib.Smithy_api.Types.string_Specify the input contents, as a string, for the source of an outbound transformation.
*)The input file to use for an outbound transformation.
type nonrec conversion_source = {input_file : input_file_source;File to be converted
*)file_format : conversion_source_format;The format for the input file: either JSON or XML.
*)}Describes the input for an outbound transformation.
Contains a structure describing the X12 details for the conversion target.
Container for the location of a sample file used for outbound transformations.
type nonrec conversion_target = {advanced_options : advanced_options option;output_sample_file : output_sample_file_source option;Customer uses this to provide a sample on what should file look like after conversion X12 EDI use case around this would be discovering the file syntax
*)format_details : conversion_target_format_details option;A structure that contains the formatting details for the conversion target.
*)file_format : conversion_target_format;Currently, only X12 format is supported.
*)}Provide a sample of what the output of the transformation should look like.
type nonrec test_conversion_request = {target : conversion_target;Specify the format (X12 is the only currently supported format), and other details for the conversion target.
*)source : conversion_source;Specify the source file for an outbound EDI request.
*)}A data structure that contains the information to use when generating a mapping template.
type nonrec tag = {value : tag_value;Contains one or more values that you assigned to the key name that you create.
*)key : tag_key;Specifies the name assigned to the tag that you create.
*)}Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
type nonrec tag_list = tag listtype nonrec tag_resource_request = {resource_ar_n : amazon_resource_name;Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)}type nonrec start_transformer_job_response = {transformer_job_id : transformer_job_id;Returns the unique, system-generated identifier for a transformer run.
*)}type nonrec start_transformer_job_request = {client_token : Smaws_Lib.Smithy_api.Types.string_ option;Reserved for future use.
*)transformer_id : transformer_id;Specifies the system-assigned unique identifier for the transformer.
*)output_location : s3_location;Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.
*)input_file : s3_location;Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.
*)}type nonrec s3_location_list = s3_location listtype nonrec profile_summary = {modified_at : modified_date option;Returns the timestamp that identifies the most recent date and time that the profile was modified.
*)created_at : created_date;Returns the timestamp for creation date and time of the profile.
*)log_group_name : log_group_name option;Returns the name of the logging group.
*)logging : logging option;Specifies whether or not logging is enabled for this profile.
*)business_name : business_name;Returns the name for the business associated with this profile.
*)name : profile_name;Returns the display name for profile.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile.
*)}Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.
type nonrec profile_list = profile_summary listtype nonrec profile = Smaws_Lib.CoreTypes.Resource.ttype nonrec partnership_summary = {modified_at : modified_date option;Returns a timestamp that identifies the most recent date and time that the partnership was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the partnership.
*)trading_partner_id : trading_partner_id option;Returns the unique, system-generated identifier for a trading partner.
*)capability_options : capability_options option;capabilities : partnership_capabilities option;Returns one or more capabilities associated with this partnership.
*)name : partner_name option;Returns the name of the partnership.
*)partnership_id : partnership_id;Returns the unique, system-generated identifier for a partnership.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile connected to this partnership.
*)}A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
type nonrec partnership_list = partnership_summary listtype nonrec partnership = Smaws_Lib.CoreTypes.Resource.ttype nonrec list_transformers_response = {next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
transformers : transformer_list;Returns an array of one or more transformer objects.
For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.
}type nonrec list_transformers_request = {max_results : max_results option;Specifies the number of items to return for the API response.
*)next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
}type nonrec list_profiles_response = {next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
profiles : profile_list;Returns an array of ProfileSummary objects.
}type nonrec list_profiles_request = {max_results : max_results option;Specifies the maximum number of profiles to return.
*)next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
}type nonrec list_partnerships_response = {next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
partnerships : partnership_list;Specifies a list of your partnerships.
*)}type nonrec list_partnerships_request = {max_results : max_results option;Specifies the maximum number of capabilities to return.
*)next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
profile_id : profile_id option;Specifies the unique, system-generated identifier for the profile connected to this partnership.
*)}type nonrec capability_summary = {modified_at : modified_date option;Returns a timestamp that identifies the most recent date and time that the capability was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the capability.
*)type_ : capability_type;Returns the type of the capability. Currently, only edi is supported.
name : capability_name;The display name of the capability.
*)capability_id : capability_id;Returns a system-assigned unique identifier for the capability.
*)}Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
type nonrec capability_list = capability_summary listtype nonrec list_capabilities_response = {next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
capabilities : capability_list;Returns one or more capabilities associated with this partnership.
*)}type nonrec list_capabilities_request = {max_results : max_results option;Specifies the maximum number of capabilities to return.
*)next_token : page_token option;When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
}type nonrec get_transformer_response = {sample_documents : sample_documents option;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.
*)output_conversion : output_conversion option;Returns the OutputConversion object, which contains the format options for the outbound transformation.
mapping : mapping option;Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
*)input_conversion : input_conversion option;Returns the InputConversion object, which contains the format options for the inbound transformation.
sample_document : file_location option;Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
*)edi_type : edi_type option;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.
*)mapping_template : mapping_template option;Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
*)file_format : file_format option;Returns that the currently supported file formats for EDI transformations are JSON and XML.
modified_at : modified_date option;Returns a timestamp for last time the transformer was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the transformer.
*)status : transformer_status;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.
name : transformer_name;Returns the name of the transformer, used to identify it.
*)transformer_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)transformer_id : transformer_id;Returns the system-assigned unique identifier for the transformer.
*)}type nonrec get_transformer_request = {transformer_id : transformer_id;Specifies the system-assigned unique identifier for the transformer.
*)}type nonrec get_transformer_job_response = {message : Smaws_Lib.Smithy_api.Types.string_ option;Returns an optional error message, which gets populated when the job is not run successfully.
*)output_files : s3_location_list option;Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.
*)status : transformer_job_status;Returns the current state of the transformer job, either running, succeeded, or failed.
}type nonrec get_transformer_job_request = {transformer_id : transformer_id;Specifies the system-assigned unique identifier for the transformer.
*)transformer_job_id : transformer_job_id;Specifies the unique, system-generated identifier for a transformer run.
*)}type nonrec get_profile_response = {modified_at : modified_date option;Returns a timestamp for last time the profile was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the transformer.
*)log_group_name : log_group_name option;Returns the name of the logging group.
*)logging : logging option;Returns whether or not logging is enabled for this profile.
*)business_name : business_name;Returns the name for the business associated with this profile.
*)phone : phone;Returns the phone number associated with the profile.
*)email : email option;Returns the email address associated with this customer profile.
*)name : profile_name;Returns the name of the profile, used to identify it.
*)profile_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile.
*)}type nonrec get_profile_request = {profile_id : profile_id;Specifies the unique, system-generated identifier for the profile.
*)}type nonrec get_partnership_response = {modified_at : modified_date option;Returns a timestamp that identifies the most recent date and time that the partnership was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the partnership.
*)trading_partner_id : trading_partner_id option;Returns the unique identifier for the partner for this partnership.
*)capability_options : capability_options option;capabilities : partnership_capabilities option;Returns one or more capabilities associated with this partnership.
*)phone : phone option;Returns the phone number associated with the partnership.
*)email : email option;Returns the email address associated with this trading partner.
*)name : partner_name option;Returns the display name of the partnership
*)partnership_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)partnership_id : partnership_id;Returns the unique, system-generated identifier for a partnership.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile connected to this partnership.
*)}type nonrec get_partnership_request = {partnership_id : partnership_id;Specifies the unique, system-generated identifier for a partnership.
*)}type nonrec get_capability_response = {modified_at : modified_date option;Returns a timestamp for last time the capability was modified.
*)created_at : created_date;Returns a timestamp for creation date and time of the capability.
*)instructions_documents : instructions_documents option;Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
*)configuration : capability_configuration;Returns a structure that contains the details for a capability.
*)type_ : capability_type;Returns the type of the capability. Currently, only edi is supported.
name : capability_name;Returns the name of the capability, used to identify it.
*)capability_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)capability_id : capability_id;Returns a system-assigned unique identifier for the capability.
*)}type nonrec get_capability_request = {capability_id : capability_id;Specifies a system-assigned unique identifier for the capability.
*)}type nonrec generate_mapping_response = {mapping_accuracy : Smaws_Lib.Smithy_api.Types.float_ option;Returns a percentage that estimates the accuracy of the generated mapping.
*)mapping_template : Smaws_Lib.Smithy_api.Types.string_;Returns a mapping template based on your inputs.
*)}type nonrec generate_mapping_request = {mapping_type : mapping_type;Specify the mapping type: either JSONATA or XSLT.
output_file_content : generate_mapping_output_file_content;Provide the contents of a sample X12 EDI file, either in JSON or XML format, to use as a target for the mapping.
*)input_file_content : generate_mapping_input_file_content;Provide the contents of a sample X12 EDI file, either in JSON or XML format, to use as a starting point for the mapping.
*)}type nonrec delete_transformer_request = {transformer_id : transformer_id;Specifies the system-assigned unique identifier for the transformer.
*)}type nonrec delete_profile_request = {profile_id : profile_id;Specifies the unique, system-generated identifier for the profile.
*)}type nonrec delete_partnership_request = {partnership_id : partnership_id;Specifies the unique, system-generated identifier for a partnership.
*)}type nonrec delete_capability_request = {capability_id : capability_id;Specifies a system-assigned unique identifier for the capability.
*)}type nonrec create_transformer_response = {sample_documents : sample_documents option;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.
*)output_conversion : output_conversion option;Returns the OutputConversion object, which contains the format options for the outbound transformation.
mapping : mapping option;Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
*)input_conversion : input_conversion option;Returns the InputConversion object, which contains the format options for the inbound transformation.
sample_document : file_location option;Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
*)edi_type : edi_type option;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.
*)mapping_template : mapping_template option;Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
*)file_format : file_format option;Returns that the currently supported file formats for EDI transformations are JSON and XML.
created_at : created_date;Returns a timestamp for creation date and time of the transformer.
*)status : transformer_status;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.
name : transformer_name;Returns the name of the transformer, used to identify it.
*)transformer_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)transformer_id : transformer_id;Returns the system-assigned unique identifier for the transformer.
*)}type nonrec create_transformer_request = {sample_documents : sample_documents option;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.
*)output_conversion : output_conversion option;A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.
mapping : mapping option;Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
*)input_conversion : input_conversion option;Specify the InputConversion object, which contains the format options for the inbound transformation.
sample_document : file_location option;Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
*)edi_type : edi_type option;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.
*)mapping_template : mapping_template option;Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
This parameter is available for backwards compatibility. Use the Mapping data type instead.
*)file_format : file_format option;Specifies that the currently supported file formats for EDI transformations are JSON and XML.
client_token : Smaws_Lib.Smithy_api.Types.string_ option;Reserved for future use.
*)name : transformer_name;Specifies the name of the transformer, used to identify it.
*)}type nonrec create_starter_mapping_template_response = {mapping_template : Smaws_Lib.Smithy_api.Types.string_;Returns a string that represents the mapping template.
*)}type nonrec create_starter_mapping_template_request = {template_details : template_details;Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used: currently, we only support X12.
*)mapping_type : mapping_type;Specify the format for the mapping template: either JSONATA or XSLT.
*)output_sample_location : s3_location option;Specify the location of the sample EDI file that is used to generate the mapping template.
*)}type nonrec create_profile_response = {created_at : created_date;Returns a timestamp representing the time the profile was created.
*)log_group_name : log_group_name option;Returns the name of the logging group.
*)logging : logging option;Returns whether or not logging is turned on for this profile.
*)email : email option;Returns the email address associated with this customer profile.
*)phone : phone;Returns the phone number associated with the profile.
*)business_name : business_name;Returns the name for the business associated with this profile.
*)name : profile_name;Returns the name of the profile, used to identify it.
*)profile_arn : resource_arn;Returns an Amazon Resource Name (ARN) for the profile.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile.
*)}type nonrec create_profile_request = {client_token : Smaws_Lib.Smithy_api.Types.string_ option;Reserved for future use.
*)logging : logging;Specifies whether or not logging is enabled for this profile.
*)business_name : business_name;Specifies the name for the business associated with this profile.
*)phone : phone;Specifies the phone number associated with the profile.
*)email : email option;Specifies the email address associated with this customer profile.
*)name : profile_name;Specifies the name of the profile.
*)}type nonrec create_partnership_response = {created_at : created_date;Returns a timestamp for creation date and time of the partnership.
*)trading_partner_id : trading_partner_id option;Returns the unique, system-generated identifier for a trading partner.
*)capability_options : capability_options option;Returns the structure that contains the details for the associated capabilities.
*)capabilities : partnership_capabilities option;Returns one or more capabilities associated with this partnership.
*)phone : phone option;Returns the phone number associated with the partnership.
*)email : email option;Returns the email address associated with this trading partner.
*)name : partner_name option;Returns a descriptive name for the partnership.
*)partnership_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)partnership_id : partnership_id;Returns the unique, system-generated identifier for a partnership.
*)profile_id : profile_id;Returns the unique, system-generated identifier for the profile connected to this partnership.
*)}type nonrec create_partnership_request = {client_token : Smaws_Lib.Smithy_api.Types.string_ option;Reserved for future use.
*)capability_options : capability_options option;Specify the structure that contains the details for the associated capabilities.
*)capabilities : partnership_capabilities;Specifies a list of the capabilities associated with this partnership.
*)phone : phone option;Specifies the phone number associated with the partnership.
*)email : email;Specifies the email address associated with this trading partner.
*)name : partner_name;Specifies a descriptive name for the partnership.
*)profile_id : profile_id;Specifies the unique, system-generated identifier for the profile connected to this partnership.
*)}type nonrec create_capability_response = {created_at : created_date;Returns a timestamp for creation date and time of the capability.
*)instructions_documents : instructions_documents option;Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
*)configuration : capability_configuration;Returns a structure that contains the details for a capability.
*)type_ : capability_type;Returns the type of the capability. Currently, only edi is supported.
name : capability_name;Returns the name of the capability used to identify it.
*)capability_arn : resource_arn;Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
*)capability_id : capability_id;Returns a system-assigned unique identifier for the capability.
*)}type nonrec create_capability_request = {client_token : Smaws_Lib.Smithy_api.Types.string_ option;Reserved for future use.
*)instructions_documents : instructions_documents option;Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.
*)configuration : capability_configuration;Specifies a structure that contains the details for a capability.
*)type_ : capability_type;Specifies the type of the capability. Currently, only edi is supported.
name : capability_name;Specifies the name of the capability, used to identify it.
*)}type nonrec capability = Smaws_Lib.CoreTypes.Resource.t