This is the Amazon Web Services B2B Data Interchange API Reference. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.
B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.
Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton file.
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.
", "CreatePartnership": "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.
", "CreateProfile": "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.
", "CreateStarterMappingTemplate": "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.
If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.
If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the templateDetails parameter.
Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
", "CreateTransformer": "Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.
Use the mapping data type in place of mappingTemplate and fileFormat
Use the sampleDocuments data type in place of sampleDocument
Use either the inputConversion or outputConversion in place of ediType
Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "DeletePartnership": "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.
", "DeleteProfile": "Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.
", "DeleteTransformer": "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.
", "GenerateMapping": "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.
Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the Amazon Web Services B2B Data Interchange User guide.
To generate a mapping, perform the following steps:
Start with an X12 EDI document to use as the input.
Call TestMapping using your EDI document.
Use the output from the TestMapping operation as either input or output for your GenerateMapping call, along with your sample file.
Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "GetPartnership": "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.
", "GetProfile": "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.
", "GetTransformer": "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.
", "GetTransformerJob": "Returns the details of the transformer run, based on the Transformer job ID.
If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run GetTransformerJob and supply a transformerId and transformerJobId for a job that was started more than 30 days previously, you receive a 404 response.
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.
", "ListPartnerships": "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.
", "ListProfiles": "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.
", "ListTagsForResource": "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.
", "ListTransformers": "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.
", "StartTransformerJob": "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.
If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob API to process your files.
The system stores transformer jobs for 30 days. During that period, you can run GetTransformerJob and supply its transformerId and transformerJobId to return details of the job.
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.
There is no response returned from this call.
", "TestConversion": "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.
", "TestMapping": "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.
Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
", "UntagResource": "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.
", "UpdateCapability": "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.
", "UpdatePartnership": "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.
", "UpdateProfile": "Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.
", "UpdateTransformer": "Updates the specified parameters for a 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.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "AdvancedOptions": { "base": "A structure that contains advanced options for EDI processing. Currently, only X12 advanced options are supported.
", "refs": { "ConversionTarget$advancedOptions": null, "InputConversion$advancedOptions": "Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.
", "OutputConversion$advancedOptions": null, "TestParsingRequest$advancedOptions": "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.
" } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$ResourceARN": "Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "TagResourceRequest$ResourceARN": "Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UntagResourceRequest$ResourceARN": "Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
" } }, "BucketName": { "base": null, "refs": { "S3Location$bucketName": "Specifies the name of the Amazon S3 bucket.
", "SampleDocuments$bucketName": "Contains the Amazon S3 bucket that is used to hold your sample documents.
" } }, "BusinessName": { "base": null, "refs": { "CreateProfileRequest$businessName": "Specifies the name for the business associated with this profile.
", "CreateProfileResponse$businessName": "Returns the name for the business associated with this profile.
", "GetProfileResponse$businessName": "Returns the name for the business associated with this profile.
", "ProfileSummary$businessName": "Returns the name for the business associated with this profile.
", "UpdateProfileRequest$businessName": "Specifies the name for the business associated with this profile.
", "UpdateProfileResponse$businessName": "Returns the name for the business associated with this profile.
" } }, "CapabilityConfiguration": { "base": "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.
", "refs": { "CreateCapabilityRequest$configuration": "Specifies a structure that contains the details for a capability.
", "CreateCapabilityResponse$configuration": "Returns a structure that contains the details for a capability.
", "GetCapabilityResponse$configuration": "Returns a structure that contains the details for a capability.
", "UpdateCapabilityRequest$configuration": "Specifies a structure that contains the details for a capability.
", "UpdateCapabilityResponse$configuration": "Returns a structure that contains the details for a capability.
" } }, "CapabilityDirection": { "base": null, "refs": { "EdiConfiguration$capabilityDirection": "Specifies whether this is capability is for inbound or outbound transformations.
" } }, "CapabilityId": { "base": null, "refs": { "CapabilitySummary$capabilityId": "Returns a system-assigned unique identifier for the capability.
", "CreateCapabilityResponse$capabilityId": "Returns a system-assigned unique identifier for the capability.
", "DeleteCapabilityRequest$capabilityId": "Specifies a system-assigned unique identifier for the capability.
", "GetCapabilityRequest$capabilityId": "Specifies a system-assigned unique identifier for the capability.
", "GetCapabilityResponse$capabilityId": "Returns a system-assigned unique identifier for the capability.
", "PartnershipCapabilities$member": null, "UpdateCapabilityRequest$capabilityId": "Specifies a system-assigned unique identifier for the capability.
", "UpdateCapabilityResponse$capabilityId": "Returns a system-assigned unique identifier for the capability.
" } }, "CapabilityList": { "base": null, "refs": { "ListCapabilitiesResponse$capabilities": "Returns one or more capabilities associated with this partnership.
" } }, "CapabilityName": { "base": null, "refs": { "CapabilitySummary$name": "The display name of the capability.
", "CreateCapabilityRequest$name": "Specifies the name of the capability, used to identify it.
", "CreateCapabilityResponse$name": "Returns the name of the capability used to identify it.
", "GetCapabilityResponse$name": "Returns the name of the capability, used to identify it.
", "UpdateCapabilityRequest$name": "Specifies a new name for the capability, to replace the existing name.
", "UpdateCapabilityResponse$name": "Returns the name of the capability, used to identify it.
" } }, "CapabilityOptions": { "base": "Contains the details for an Outbound EDI capability.
", "refs": { "CreatePartnershipRequest$capabilityOptions": "Specify the structure that contains the details for the associated capabilities.
", "CreatePartnershipResponse$capabilityOptions": "Returns the structure that contains the details for the associated capabilities.
", "GetPartnershipResponse$capabilityOptions": null, "PartnershipSummary$capabilityOptions": null, "UpdatePartnershipRequest$capabilityOptions": "To update, specify the structure that contains the details for the associated capabilities.
", "UpdatePartnershipResponse$capabilityOptions": "Returns the structure that contains the details for the associated capabilities.
" } }, "CapabilitySummary": { "base": "Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
", "refs": { "CapabilityList$member": null } }, "CapabilityType": { "base": null, "refs": { "CapabilitySummary$type": "Returns the type of the capability. Currently, only edi is supported.
Specifies the type of the capability. Currently, only edi is supported.
Returns the type of the capability. Currently, only edi is supported.
Returns the type of the capability. Currently, only edi is supported.
Returns the type of the capability. Currently, only edi is supported.
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.
", "X12CodeListValidationRule$codesToRemove": "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.
" } }, "ConflictException": { "base": "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.
", "refs": { } }, "ConversionSource": { "base": "Describes the input for an outbound transformation.
", "refs": { "TestConversionRequest$source": "Specify the source file for an outbound EDI request.
" } }, "ConversionSourceFormat": { "base": null, "refs": { "ConversionSource$fileFormat": "The format for the input file: either JSON or XML.
" } }, "ConversionTarget": { "base": "Provide a sample of what the output of the transformation should look like.
", "refs": { "TestConversionRequest$target": "Specify the format (X12 is the only currently supported format), and other details for the conversion target.
" } }, "ConversionTargetFormat": { "base": null, "refs": { "ConversionTarget$fileFormat": "Currently, only X12 format is supported.
" } }, "ConversionTargetFormatDetails": { "base": "Contains a structure describing the X12 details for the conversion target.
", "refs": { "ConversionTarget$formatDetails": "A structure that contains the formatting details for the conversion target.
" } }, "CreateCapabilityRequest": { "base": null, "refs": { } }, "CreateCapabilityResponse": { "base": null, "refs": { } }, "CreatePartnershipRequest": { "base": null, "refs": { } }, "CreatePartnershipResponse": { "base": null, "refs": { } }, "CreateProfileRequest": { "base": null, "refs": { } }, "CreateProfileResponse": { "base": null, "refs": { } }, "CreateStarterMappingTemplateRequest": { "base": null, "refs": { } }, "CreateStarterMappingTemplateResponse": { "base": null, "refs": { } }, "CreateTransformerRequest": { "base": null, "refs": { } }, "CreateTransformerResponse": { "base": null, "refs": { } }, "CreatedDate": { "base": null, "refs": { "CapabilitySummary$createdAt": "Returns a timestamp for creation date and time of the capability.
", "CreateCapabilityResponse$createdAt": "Returns a timestamp for creation date and time of the capability.
", "CreatePartnershipResponse$createdAt": "Returns a timestamp for creation date and time of the partnership.
", "CreateProfileResponse$createdAt": "Returns a timestamp representing the time the profile was created.
", "CreateTransformerResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
", "GetCapabilityResponse$createdAt": "Returns a timestamp for creation date and time of the capability.
", "GetPartnershipResponse$createdAt": "Returns a timestamp for creation date and time of the partnership.
", "GetProfileResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
", "GetTransformerResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
", "PartnershipSummary$createdAt": "Returns a timestamp for creation date and time of the partnership.
", "ProfileSummary$createdAt": "Returns the timestamp for creation date and time of the profile.
", "TransformerSummary$createdAt": "Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
Returns a timestamp for creation date and time of the capability.
", "UpdatePartnershipResponse$createdAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "UpdateProfileResponse$createdAt": "Returns a timestamp for creation date and time of the profile.
", "UpdateTransformerResponse$createdAt": "Returns a timestamp for creation date and time of the transformer.
" } }, "DeleteCapabilityRequest": { "base": null, "refs": { } }, "DeletePartnershipRequest": { "base": null, "refs": { } }, "DeleteProfileRequest": { "base": null, "refs": { } }, "DeleteTransformerRequest": { "base": null, "refs": { } }, "EdiConfiguration": { "base": "Specifies the details for the EDI (electronic data interchange) transformation.
", "refs": { "CapabilityConfiguration$edi": "An EDI (electronic data interchange) configuration object.
" } }, "EdiType": { "base": "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.
", "refs": { "CreateTransformerRequest$ediType": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "CreateTransformerResponse$ediType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "EdiConfiguration$type": "Returns the type of the capability. Currently, only edi is supported.
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.
", "TestParsingRequest$ediType": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "TransformerSummary$ediType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "UpdateTransformerRequest$ediType": "Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
", "UpdateTransformerResponse$ediType": "Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
" } }, "ElementId": { "base": "A string type representing an X12 element ID. Element IDs are four-digit numeric identifiers that uniquely identify elements within the X12 standard. This type enforces a pattern of exactly four digits to ensure valid element IDs are used in validation rules.
", "refs": { "X12CodeListValidationRule$elementId": "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.
", "X12ElementLengthValidationRule$elementId": "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.
" } }, "ElementPosition": { "base": "A string type representing the position of an element within an X12 segment. The format follows the pattern of segment identifier followed by element position (e.g., \"ST-01\" for the first element of the ST segment) and optionally a component position (e.g., \"ST-01-02\" for the second component of the first element). This type is used in validation rules to precisely identify which element in which position is being validated.
", "refs": { "X12ElementRequirementValidationRule$elementPosition": "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).
" } }, "ElementRequirement": { "base": null, "refs": { "X12ElementRequirementValidationRule$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).
" } }, "Email": { "base": null, "refs": { "CreatePartnershipRequest$email": "Specifies the email address associated with this trading partner.
", "CreatePartnershipResponse$email": "Returns the email address associated with this trading partner.
", "CreateProfileRequest$email": "Specifies the email address associated with this customer profile.
", "CreateProfileResponse$email": "Returns the email address associated with this customer profile.
", "GetPartnershipResponse$email": "Returns the email address associated with this trading partner.
", "GetProfileResponse$email": "Returns the email address associated with this customer profile.
", "UpdatePartnershipResponse$email": "Returns the email address associated with this trading partner.
", "UpdateProfileRequest$email": "Specifies the email address associated with this customer profile.
", "UpdateProfileResponse$email": "Returns the email address associated with this customer profile.
" } }, "ErrorMessage": { "base": null, "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, "InternalServerException$message": null, "ResourceNotFoundException$message": null, "ServiceQuotaExceededException$message": null, "ThrottlingException$message": null, "ValidationException$Message": null } }, "FileFormat": { "base": null, "refs": { "CreateTransformerRequest$fileFormat": "Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
Returns that the currently supported file formats for EDI transformations are JSON and XML.
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "CreateTransformerResponse$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "GetTransformerResponse$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "TransformerSummary$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "UpdateTransformerRequest$sampleDocument": "Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
", "UpdateTransformerResponse$sampleDocument": "Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
" } }, "FormatOptions": { "base": "A structure that contains the X12 transaction set and version.
", "refs": { "InputConversion$formatOptions": "A structure that contains the formatting options for an inbound transformer.
", "OutputConversion$formatOptions": "A structure that contains the X12 transaction set and version for the transformer output.
" } }, "FromFormat": { "base": null, "refs": { "InputConversion$fromFormat": "The format for the transformer input: currently on X12 is supported.
Provide the contents of a sample X12 EDI file, either in JSON or XML format, to use as a starting point for the mapping.
" } }, "GenerateMappingOutputFileContent": { "base": null, "refs": { "GenerateMappingRequest$outputFileContent": "Provide the contents of a sample X12 EDI file, either in JSON or XML format, to use as a target for the mapping.
" } }, "GenerateMappingRequest": { "base": null, "refs": { } }, "GenerateMappingResponse": { "base": null, "refs": { } }, "GenerateMappingResponseMappingAccuracyFloat": { "base": null, "refs": { "GenerateMappingResponse$mappingAccuracy": "Returns a percentage that estimates the accuracy of the generated mapping.
" } }, "GetCapabilityRequest": { "base": null, "refs": { } }, "GetCapabilityResponse": { "base": null, "refs": { } }, "GetPartnershipRequest": { "base": null, "refs": { } }, "GetPartnershipResponse": { "base": null, "refs": { } }, "GetProfileRequest": { "base": null, "refs": { } }, "GetProfileResponse": { "base": null, "refs": { } }, "GetTransformerJobRequest": { "base": null, "refs": { } }, "GetTransformerJobResponse": { "base": null, "refs": { } }, "GetTransformerRequest": { "base": null, "refs": { } }, "GetTransformerResponse": { "base": null, "refs": { } }, "InboundEdiOptions": { "base": "Contains options for processing inbound EDI files. These options allow for customizing how incoming EDI documents are processed.
", "refs": { "CapabilityOptions$inboundEdi": "A structure that contains the inbound EDI options for the capability.
" } }, "InputConversion": { "base": "Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.
", "refs": { "CreateTransformerRequest$inputConversion": "Specify the InputConversion object, which contains the format options for the inbound transformation.
Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns the InputConversion object, which contains the format options for the inbound transformation.
Returns a structure that contains the format options for the transformation.
", "UpdateTransformerRequest$inputConversion": "To update, specify the InputConversion object, which contains the format options for the inbound transformation.
Returns the InputConversion object, which contains the format options for the inbound transformation.
The input file to use for an outbound transformation.
", "refs": { "ConversionSource$inputFile": "File to be converted
" } }, "InputFileSourceFileContentString": { "base": null, "refs": { "InputFileSource$fileContent": "Specify the input contents, as a string, for the source of an outbound transformation.
" } }, "InstructionsDocuments": { "base": null, "refs": { "CreateCapabilityRequest$instructionsDocuments": "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.
", "CreateCapabilityResponse$instructionsDocuments": "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.
", "GetCapabilityResponse$instructionsDocuments": "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.
", "UpdateCapabilityRequest$instructionsDocuments": "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.
", "UpdateCapabilityResponse$instructionsDocuments": "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.
" } }, "Integer": { "base": null, "refs": { "InternalServerException$retryAfterSeconds": "The server attempts to retry a failed command.
", "ThrottlingException$retryAfterSeconds": "The server attempts to retry a command that was throttled.
" } }, "InternalServerException": { "base": "This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.
", "refs": { } }, "KeyList": { "base": null, "refs": { "SampleDocuments$keys": "Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
" } }, "LineLength": { "base": null, "refs": { "WrapOptions$lineLength": "Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.
Specifies the character sequence used to terminate lines when wrapping. Valid values:
CRLF: carriage return and line feed
LF: line feed)
CR: carriage return
Returns the name of the logging group.
", "GetProfileResponse$logGroupName": "Returns the name of the logging group.
", "ProfileSummary$logGroupName": "Returns the name of the logging group.
", "UpdateProfileResponse$logGroupName": "Returns the name of the logging group.
" } }, "Logging": { "base": null, "refs": { "CreateProfileRequest$logging": "Specifies whether or not logging is enabled for this profile.
", "CreateProfileResponse$logging": "Returns whether or not logging is turned on for this profile.
", "GetProfileResponse$logging": "Returns whether or not logging is enabled for this profile.
", "ProfileSummary$logging": "Specifies whether or not logging is enabled for this profile.
", "UpdateProfileResponse$logging": "Specifies whether or not logging is enabled for this profile.
" } }, "Mapping": { "base": "Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", "refs": { "CreateTransformerRequest$mapping": "Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
", "CreateTransformerResponse$mapping": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
", "GetTransformerResponse$mapping": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
", "TransformerSummary$mapping": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
", "UpdateTransformerRequest$mapping": "Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).
", "UpdateTransformerResponse$mapping": "Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
" } }, "MappingTemplate": { "base": null, "refs": { "CreateTransformerRequest$mappingTemplate": "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.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", "GetTransformerResponse$mappingTemplate": "Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", "Mapping$template": "A string that represents the mapping template, in the transformation language specified in templateLanguage.
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.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
", "UpdateTransformerRequest$mappingTemplate": "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.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
" } }, "MappingTemplateLanguage": { "base": null, "refs": { "Mapping$templateLanguage": "The transformation language for the template, either XSLT or JSONATA.
" } }, "MappingType": { "base": null, "refs": { "CreateStarterMappingTemplateRequest$mappingType": "Specify the format for the mapping template: either JSONATA or XSLT.
", "GenerateMappingRequest$mappingType": "Specify the mapping type: either JSONATA or XSLT.
Specifies the maximum number of capabilities to return.
", "ListPartnershipsRequest$maxResults": "Specifies the maximum number of capabilities to return.
", "ListProfilesRequest$maxResults": "Specifies the maximum number of profiles to return.
", "ListTransformersRequest$maxResults": "Specifies the number of items to return for the API response.
" } }, "ModifiedDate": { "base": null, "refs": { "CapabilitySummary$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the capability was modified.
", "GetCapabilityResponse$modifiedAt": "Returns a timestamp for last time the capability was modified.
", "GetPartnershipResponse$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "GetProfileResponse$modifiedAt": "Returns a timestamp for last time the profile was modified.
", "GetTransformerResponse$modifiedAt": "Returns a timestamp for last time the transformer was modified.
", "PartnershipSummary$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "ProfileSummary$modifiedAt": "Returns the timestamp that identifies the most recent date and time that the profile was modified.
", "TransformerSummary$modifiedAt": "Returns a timestamp representing the date and time for the most recent change for the transformer object.
", "UpdateCapabilityResponse$modifiedAt": "Returns a timestamp for last time the capability was modified.
", "UpdatePartnershipResponse$modifiedAt": "Returns a timestamp that identifies the most recent date and time that the partnership was modified.
", "UpdateProfileResponse$modifiedAt": "Returns a timestamp for last time the profile was modified.
", "UpdateTransformerResponse$modifiedAt": "Returns a timestamp for last time the transformer was modified.
" } }, "OutboundEdiOptions": { "base": "A container for outbound EDI options.
", "refs": { "CapabilityOptions$outboundEdi": "A structure that contains the outbound EDI options.
" } }, "OutputConversion": { "base": "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).
", "refs": { "CreateTransformerRequest$outputConversion": "A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.
Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns the OutputConversion object, which contains the format options for the outbound transformation.
Returns the OutputConversion object, which contains the format options for the outbound transformation.
To update, specify the OutputConversion object, which contains the format options for the outbound transformation.
Returns the OutputConversion object, which contains the format options for the outbound transformation.
Container for the location of a sample file used for outbound transformations.
", "refs": { "ConversionTarget$outputSampleFile": "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
" } }, "PageToken": { "base": null, "refs": { "ListCapabilitiesRequest$nextToken": "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.
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.
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.
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.
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.
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.
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.
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.
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.
" } }, "PartnerName": { "base": null, "refs": { "CreatePartnershipRequest$name": "Specifies a descriptive name for the partnership.
", "CreatePartnershipResponse$name": "Returns a descriptive name for the partnership.
", "GetPartnershipResponse$name": "Returns the display name of the partnership
", "PartnershipSummary$name": "Returns the name of the partnership.
", "UpdatePartnershipRequest$name": "The name of the partnership, used to identify it.
", "UpdatePartnershipResponse$name": "The name of the partnership, used to identify it.
" } }, "PartnershipCapabilities": { "base": null, "refs": { "CreatePartnershipRequest$capabilities": "Specifies a list of the capabilities associated with this partnership.
", "CreatePartnershipResponse$capabilities": "Returns one or more capabilities associated with this partnership.
", "GetPartnershipResponse$capabilities": "Returns one or more capabilities associated with this partnership.
", "PartnershipSummary$capabilities": "Returns one or more capabilities associated with this partnership.
", "UpdatePartnershipRequest$capabilities": "List of the capabilities associated with this partnership.
", "UpdatePartnershipResponse$capabilities": "Returns one or more capabilities associated with this partnership.
" } }, "PartnershipId": { "base": null, "refs": { "CreatePartnershipResponse$partnershipId": "Returns the unique, system-generated identifier for a partnership.
", "DeletePartnershipRequest$partnershipId": "Specifies the unique, system-generated identifier for a partnership.
", "GetPartnershipRequest$partnershipId": "Specifies the unique, system-generated identifier for a partnership.
", "GetPartnershipResponse$partnershipId": "Returns the unique, system-generated identifier for a partnership.
", "PartnershipSummary$partnershipId": "Returns the unique, system-generated identifier for a partnership.
", "UpdatePartnershipRequest$partnershipId": "Specifies the unique, system-generated identifier for a partnership.
", "UpdatePartnershipResponse$partnershipId": "Returns the unique, system-generated identifier for a partnership.
" } }, "PartnershipList": { "base": null, "refs": { "ListPartnershipsResponse$partnerships": "Specifies a list of your partnerships.
" } }, "PartnershipSummary": { "base": "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.
", "refs": { "PartnershipList$member": null } }, "Phone": { "base": null, "refs": { "CreatePartnershipRequest$phone": "Specifies the phone number associated with the partnership.
", "CreatePartnershipResponse$phone": "Returns the phone number associated with the partnership.
", "CreateProfileRequest$phone": "Specifies the phone number associated with the profile.
", "CreateProfileResponse$phone": "Returns the phone number associated with the profile.
", "GetPartnershipResponse$phone": "Returns the phone number associated with the partnership.
", "GetProfileResponse$phone": "Returns the phone number associated with the profile.
", "UpdatePartnershipResponse$phone": "Returns the phone number associated with the partnership.
", "UpdateProfileRequest$phone": "Specifies the phone number associated with the profile.
", "UpdateProfileResponse$phone": "Returns the phone number associated with the profile.
" } }, "ProfileId": { "base": null, "refs": { "CreatePartnershipRequest$profileId": "Specifies the unique, system-generated identifier for the profile connected to this partnership.
", "CreatePartnershipResponse$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "CreateProfileResponse$profileId": "Returns the unique, system-generated identifier for the profile.
", "DeleteProfileRequest$profileId": "Specifies the unique, system-generated identifier for the profile.
", "GetPartnershipResponse$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "GetProfileRequest$profileId": "Specifies the unique, system-generated identifier for the profile.
", "GetProfileResponse$profileId": "Returns the unique, system-generated identifier for the profile.
", "ListPartnershipsRequest$profileId": "Specifies the unique, system-generated identifier for the profile connected to this partnership.
", "PartnershipSummary$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "ProfileSummary$profileId": "Returns the unique, system-generated identifier for the profile.
", "UpdatePartnershipResponse$profileId": "Returns the unique, system-generated identifier for the profile connected to this partnership.
", "UpdateProfileRequest$profileId": "Specifies the unique, system-generated identifier for the profile.
", "UpdateProfileResponse$profileId": "Returns the unique, system-generated identifier for the profile.
" } }, "ProfileList": { "base": null, "refs": { "ListProfilesResponse$profiles": "Returns an array of ProfileSummary objects.
Specifies the name of the profile.
", "CreateProfileResponse$name": "Returns the name of the profile, used to identify it.
", "GetProfileResponse$name": "Returns the name of the profile, used to identify it.
", "ProfileSummary$name": "Returns the display name for profile.
", "UpdateProfileRequest$name": "The name of the profile, used to identify it.
", "UpdateProfileResponse$name": "Returns the name of the profile.
" } }, "ProfileSummary": { "base": "Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.
", "refs": { "ProfileList$member": null } }, "ResourceArn": { "base": null, "refs": { "CreateCapabilityResponse$capabilityArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "CreatePartnershipResponse$partnershipArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "CreateProfileResponse$profileArn": "Returns an Amazon Resource Name (ARN) for the profile.
", "CreateTransformerResponse$transformerArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetCapabilityResponse$capabilityArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetPartnershipResponse$partnershipArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetProfileResponse$profileArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "GetTransformerResponse$transformerArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UpdateCapabilityResponse$capabilityArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UpdatePartnershipResponse$partnershipArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
", "UpdateProfileResponse$profileArn": "Returns an Amazon Resource Name (ARN) for the profile.
", "UpdateTransformerResponse$transformerArn": "Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
" } }, "ResourceNotFoundException": { "base": "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.
", "refs": { } }, "S3Key": { "base": null, "refs": { "S3Location$key": "Specifies the Amazon S3 key for the file location.
", "SampleDocumentKeys$input": "An array of keys for your input sample documents.
", "SampleDocumentKeys$output": "An array of keys for your output sample documents.
" } }, "S3Location": { "base": "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.
", "refs": { "CreateStarterMappingTemplateRequest$outputSampleLocation": "Specify the location of the sample EDI file that is used to generate the mapping template.
", "EdiConfiguration$inputLocation": "Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an S3Location object.
Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an S3Location object.
Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.
", "StartTransformerJobRequest$outputLocation": "Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.
", "TestParsingRequest$inputFile": "Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.
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.
" } }, "SampleDocumentKeys": { "base": "An array of the Amazon S3 keys used to identify the location for your sample documents.
", "refs": { "KeyList$member": null } }, "SampleDocuments": { "base": "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.
", "refs": { "CreateTransformerRequest$sampleDocuments": "Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
", "CreateTransformerResponse$sampleDocuments": "Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
", "GetTransformerResponse$sampleDocuments": "Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
", "TransformerSummary$sampleDocuments": "Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
", "UpdateTransformerRequest$sampleDocuments": "Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
", "UpdateTransformerResponse$sampleDocuments": "Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
" } }, "ServiceQuotaExceededException": { "base": "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.
", "refs": { } }, "StartTransformerJobRequest": { "base": null, "refs": { } }, "StartTransformerJobResponse": { "base": null, "refs": { } }, "StartingFunctionalGroupControlNumber": { "base": null, "refs": { "X12ControlNumbers$startingFunctionalGroupControlNumber": "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.
" } }, "StartingInterchangeControlNumber": { "base": null, "refs": { "X12ControlNumbers$startingInterchangeControlNumber": "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.
" } }, "StartingTransactionSetControlNumber": { "base": null, "refs": { "X12ControlNumbers$startingTransactionSetControlNumber": "Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.
" } }, "String": { "base": null, "refs": { "CodeList$member": null, "CreateCapabilityRequest$clientToken": "Reserved for future use.
", "CreatePartnershipRequest$clientToken": "Reserved for future use.
", "CreateProfileRequest$clientToken": "Reserved for future use.
", "CreateStarterMappingTemplateResponse$mappingTemplate": "Returns a string that represents the mapping template.
", "CreateTransformerRequest$clientToken": "Reserved for future use.
", "GenerateMappingResponse$mappingTemplate": "Returns a mapping template based on your inputs.
", "GetTransformerJobResponse$message": "Returns an optional error message, which gets populated when the job is not run successfully.
", "ParsedSplitFileContentsList$member": null, "ServiceQuotaExceededException$resourceId": "The ID for the resource that exceeded the quota, which caused the exception.
", "ServiceQuotaExceededException$resourceType": "The resource type (profile, partnership, transformer, or capability) that exceeded the quota, which caused the exception.
", "ServiceQuotaExceededException$serviceCode": "The code responsible for exceeding the quota, which caused the exception.
", "ServiceQuotaExceededException$quotaCode": "The quota that was exceeded, which caused the exception.
", "StartTransformerJobRequest$clientToken": "Reserved for future use.
", "TestConversionResponse$convertedFileContent": "Returns the converted file content.
", "TestMappingResponse$mappedFileContent": "Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint
", "TestParsingResponse$parsedFileContent": "Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.
", "ValidationMessages$member": null } }, "Tag": { "base": "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.
Specifies the name assigned to the tag that you create.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "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.
" } }, "TagList": { "base": null, "refs": { "CreateCapabilityRequest$tags": "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.
", "CreatePartnershipRequest$tags": "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.
", "CreateProfileRequest$tags": "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.
", "CreateTransformerRequest$tags": "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.
", "ListTagsForResourceResponse$Tags": "Returns 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.
", "TagResourceRequest$Tags": "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.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$Value": "Contains one or more values that you assigned to the key name that you create.
" } }, "TemplateDetails": { "base": "A data structure that contains the information to use when generating a mapping template.
", "refs": { "CreateStarterMappingTemplateRequest$templateDetails": "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.
" } }, "TestConversionRequest": { "base": null, "refs": { } }, "TestConversionResponse": { "base": null, "refs": { } }, "TestMappingInputFileContent": { "base": null, "refs": { "TestMappingRequest$inputFileContent": "Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
" } }, "TestMappingRequest": { "base": null, "refs": { } }, "TestMappingResponse": { "base": null, "refs": { } }, "TestParsingRequest": { "base": null, "refs": { } }, "TestParsingResponse": { "base": null, "refs": { } }, "ThrottlingException": { "base": "The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
", "refs": { } }, "ToFormat": { "base": null, "refs": { "OutputConversion$toFormat": "The format for the output from an outbound transformer: only X12 is currently supported.
" } }, "TradingPartnerId": { "base": null, "refs": { "CreatePartnershipResponse$tradingPartnerId": "Returns the unique, system-generated identifier for a trading partner.
", "GetPartnershipResponse$tradingPartnerId": "Returns the unique identifier for the partner for this partnership.
", "PartnershipSummary$tradingPartnerId": "Returns the unique, system-generated identifier for a trading partner.
", "UpdatePartnershipResponse$tradingPartnerId": "Returns the unique, system-generated identifier for a trading partner.
" } }, "TransformerId": { "base": null, "refs": { "CreateTransformerResponse$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "DeleteTransformerRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "EdiConfiguration$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "GetTransformerJobRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "GetTransformerRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "GetTransformerResponse$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "StartTransformerJobRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "TransformerSummary$transformerId": "Returns the system-assigned unique identifier for the transformer.
", "UpdateTransformerRequest$transformerId": "Specifies the system-assigned unique identifier for the transformer.
", "UpdateTransformerResponse$transformerId": "Returns the system-assigned unique identifier for the transformer.
" } }, "TransformerJobId": { "base": null, "refs": { "GetTransformerJobRequest$transformerJobId": "Specifies the unique, system-generated identifier for a transformer run.
", "StartTransformerJobResponse$transformerJobId": "Returns the unique, system-generated identifier for a transformer run.
" } }, "TransformerJobStatus": { "base": null, "refs": { "GetTransformerJobResponse$status": "Returns the current state of the transformer job, either running, succeeded, or failed.
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.
Specifies the name of the transformer, used to identify it.
", "CreateTransformerResponse$name": "Returns the name of the transformer, used to identify it.
", "GetTransformerResponse$name": "Returns the name of the transformer, used to identify it.
", "TransformerSummary$name": "Returns the descriptive name for the transformer.
", "UpdateTransformerRequest$name": "Specify a new name for the transformer, if you want to update it.
", "UpdateTransformerResponse$name": "Returns the name of the transformer.
" } }, "TransformerStatus": { "base": null, "refs": { "CreateTransformerResponse$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.
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
Returns 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.
Specifies the transformer's status. You can update the state of the transformer from inactive to active.
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.
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.
", "refs": { "TransformerList$member": null } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UpdateCapabilityRequest": { "base": null, "refs": { } }, "UpdateCapabilityResponse": { "base": null, "refs": { } }, "UpdatePartnershipRequest": { "base": null, "refs": { } }, "UpdatePartnershipResponse": { "base": null, "refs": { } }, "UpdateProfileRequest": { "base": null, "refs": { } }, "UpdateProfileResponse": { "base": null, "refs": { } }, "UpdateTransformerRequest": { "base": null, "refs": { } }, "UpdateTransformerResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "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.
", "refs": { } }, "ValidationMessages": { "base": null, "refs": { "TestConversionResponse$validationMessages": "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.
", "TestParsingResponse$validationMessages": "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.
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.
", "refs": { "X12Envelope$wrapOptions": null } }, "X12AcknowledgmentOptions": { "base": "Contains options for configuring X12 acknowledgments. These options control how functional and technical acknowledgments are handled.
", "refs": { "X12InboundEdiOptions$acknowledgmentOptions": "Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.
" } }, "X12AcknowledgmentRequestedCode": { "base": null, "refs": { "X12InterchangeControlHeaders$acknowledgmentRequestedCode": "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.
" } }, "X12AdvancedOptions": { "base": "Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.
", "refs": { "AdvancedOptions$x12": "A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.
" } }, "X12ApplicationReceiverCode": { "base": null, "refs": { "X12FunctionalGroupHeaders$applicationReceiverCode": "A value representing the code used to identify the party receiving a message, at position GS-03.
" } }, "X12ApplicationSenderCode": { "base": null, "refs": { "X12FunctionalGroupHeaders$applicationSenderCode": "A value representing the code used to identify the party transmitting a message, at position GS-02.
" } }, "X12CodeListValidationRule": { "base": "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.
", "refs": { "X12ValidationRule$codeListValidationRule": "Specifies 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.
" } }, "X12ComponentSeparator": { "base": null, "refs": { "X12Delimiters$componentSeparator": "The component, or sub-element, separator. The default value is : (colon).
Contains configuration for X12 control numbers used in X12 EDI generation. Control numbers are used to uniquely identify interchanges, functional groups, and transaction sets.
", "refs": { "X12OutboundEdiHeaders$controlNumbers": "Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.
" } }, "X12DataElementSeparator": { "base": null, "refs": { "X12Delimiters$dataElementSeparator": "The data element separator. The default value is * (asterisk).
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.
", "refs": { "X12OutboundEdiHeaders$delimiters": "The delimiters, for example semicolon (;), that separates sections of the headers for the X12 object.
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.
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.
", "FormatOptions$x12": null, "TemplateDetails$x12": null } }, "X12ElementLengthValidationRule": { "base": "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.
", "refs": { "X12ValidationRule$elementLengthValidationRule": "Specifies 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.
" } }, "X12ElementLengthValidationRuleMaxLengthInteger": { "base": null, "refs": { "X12ElementLengthValidationRule$maxLength": "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.
" } }, "X12ElementLengthValidationRuleMinLengthInteger": { "base": null, "refs": { "X12ElementLengthValidationRule$minLength": "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.
" } }, "X12ElementRequirementValidationRule": { "base": "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.
", "refs": { "X12ValidationRule$elementRequirementValidationRule": "Specifies 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.
" } }, "X12Envelope": { "base": "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:
Interchange Envelope
Functional Group
Transaction Set
A structure that contains an X12 envelope structure.
" } }, "X12FunctionalAcknowledgment": { "base": null, "refs": { "X12AcknowledgmentOptions$functionalAcknowledgment": "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.
Part of the X12 message structure. These are the functional group headers for the X12 EDI object.
", "refs": { "X12OutboundEdiHeaders$functionalGroupHeaders": "The functional group headers for the X12 object.
" } }, "X12GS05TimeFormat": { "base": "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 minutes
HHMMSS - Hours, minutes, and seconds
HHMMSSDD - Hours, minutes, seconds, and decimal seconds
Where:
HH - Hours (00-23)
MM - Minutes (00-59)
SS - Seconds (00-59)
DD - Hundredths of seconds (00-99)
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
", "X12InterchangeControlHeaders$receiverIdQualifier": "Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
" } }, "X12InboundEdiOptions": { "base": "Contains options specific to processing inbound X12 EDI files.
", "refs": { "InboundEdiOptions$x12": "A structure that contains X12-specific options for processing inbound X12 EDI files.
" } }, "X12InterchangeControlHeaders": { "base": "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.
", "refs": { "X12OutboundEdiHeaders$interchangeControlHeaders": "In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
" } }, "X12OutboundEdiHeaders": { "base": "A structure containing the details for an outbound EDI object.
", "refs": { "X12Envelope$common": "A container for the X12 outbound EDI headers.
" } }, "X12ReceiverId": { "base": null, "refs": { "X12InterchangeControlHeaders$receiverId": "Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
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.
A code that identifies the issuer of the standard, at position GS-07.
" } }, "X12SegmentTerminator": { "base": null, "refs": { "X12Delimiters$segmentTerminator": "The segment terminator. The default value is ~ (tilde).
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
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.
", "refs": { "X12AdvancedOptions$splitOptions": "Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.
" } }, "X12TechnicalAcknowledgment": { "base": null, "refs": { "X12AcknowledgmentOptions$technicalAcknowledgment": "Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
" } }, "X12UsageIndicatorCode": { "base": null, "refs": { "X12InterchangeControlHeaders$usageIndicatorCode": "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.
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.
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.
", "refs": { "X12AdvancedOptions$validationOptions": "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.
" } }, "X12ValidationRule": { "base": "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.
", "refs": { "X12ValidationRules$member": null } }, "X12ValidationRules": { "base": "A list of X12 validation rules to be applied during EDI document processing. This collection allows you to specify multiple validation rules of different types that will be enforced when validating X12 EDI documents.
", "refs": { "X12ValidationOptions$validationRules": "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.
" } }, "X12Version": { "base": null, "refs": { "X12Details$version": "Returns the version to use for the specified X12 transaction set.
" } } } }