Package-level declarations
Types
You do not have sufficient access to perform this action.
A structure that contains advanced options for EDI processing. Currently, only X12 advanced options are supported.
Base class for all service related exceptions thrown by the B2Bi client
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.
Contains the details for an Outbound EDI capability.
Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
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.
Describes the input for an outbound transformation.
Provide a sample of what the output of the transformation should look like.
Contains a structure describing the X12 details for the conversion target.
Specifies the details for the EDI (electronic data interchange) transformation.
A structure that contains the X12 transaction set and version.
Contains options for processing inbound EDI files. These options allow for customizing how incoming EDI documents are processed.
Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.
The input file to use for an outbound transformation.
This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
A container for outbound EDI options.
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).
Container for the location of a sample file used for outbound transformations.
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.
Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.
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.
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.
An array of the Amazon S3 keys used to identify the location for 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.
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.
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.
A data structure that contains the information to use when generating a mapping template.
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
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.
Occurs 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.
Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.
Contains options for configuring X12 acknowledgments. These options control how functional and technical acknowledgments are handled.
Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.
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.
Contains configuration for X12 control numbers used in X12 EDI generation. Control numbers are used to uniquely identify interchanges, functional groups, and transaction sets.
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.
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.
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.
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.
A wrapper structure for an X12 definition object.
Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:
Contains options specific to processing inbound X12 EDI files.
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.
A structure containing the details for an outbound EDI object.
Contains options for splitting X12 EDI files into smaller units. This is useful for processing large EDI files more efficiently.
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.
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.