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.
Request Syntax
{
"fileFormat": "string
",
"inputFileContent": "string
",
"mappingTemplate": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- fileFormat
-
Specifies that the currently supported file formats for EDI transformations are
JSON
andXML
.Type: String
Valid Values:
XML | JSON
Required: Yes
- inputFileContent
-
Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 5000000.
Required: Yes
- mappingTemplate
-
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 350000.
Required: Yes
Response Syntax
{
"mappedFileContent": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- mappedFileContent
-
Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
This exception is thrown when an error occurs in the AWS B2B Data Interchange service.
HTTP Status Code: 500
- ResourceNotFoundException
-
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.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
HTTP Status Code: 400
- ValidationException
-
Occurs when a B2BI object cannot be validated against a request from another object.
HTTP Status Code: 400
Examples
Example
The following example maps the sample input string, using the JSONata mapping template $
.
Sample Request
{
"fileFormat": "JSON",
"inputFileContent": "<sample input string>",
"mappingTemplate": "$"
}
Sample Response
{
"mappedFileContent": "<mapped sample content >"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: