B2BI / Client / test_parsing

test_parsing

B2BI.Client.test_parsing(**kwargs)

Parses the input EDI (electronic data interchange) file.

See also: AWS API Documentation

Request Syntax

response = client.test_parsing(
    inputFile={
        'bucketName': 'string',
        'key': 'string'
    },
    fileFormat='XML'|'JSON',
    ediType={
        'x12Details': {
            'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
            'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
        }
    }
)

Parameters:

• inputFile (dict) –

  [REQUIRED]

  Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.

  • bucketName (string) –

    Specifies the name of the Amazon S3 bucket.

  • key (string) –

    Specifies the Amazon S3 key for the file location.

• fileFormat (string) –

  [REQUIRED]

  Specifies that the currently supported file formats for EDI transformations are JSON and XML.

• ediType (dict) –

  [REQUIRED]

  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.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.

  • x12Details (dict) –

    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.

    • transactionSet (string) –

      Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.

    • version (string) –

      Returns the version to use for the specified X12 transaction set. Supported versions are 4010, 4030, and 5010.

Return type:

dict

Returns:

Response Syntax

{
    'parsedFileContent': 'string'
}

Response Structure

• (dict) –

  • parsedFileContent (string) –

    Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.

Exceptions

• B2BI.Client.exceptions.AccessDeniedException

• B2BI.Client.exceptions.ValidationException

• B2BI.Client.exceptions.ThrottlingException

• B2BI.Client.exceptions.ResourceNotFoundException

• B2BI.Client.exceptions.InternalServerException