test_parsing ¶

def test_parsing(
    self,
    input_file: "capo_b2bi.types.s3_location.S3Location",
    file_format: "capo_b2bi.types.file_format.FileFormat",
    edi_type: "capo_b2bi.types.edi_type.EdiType",
    *,
    config_overrides: Optional[b2biClientConfig] = None,
    advanced_options: Optional[
        "capo_b2bi.types.advanced_options.AdvancedOptions"
    ] = None,
) -> "capo_b2bi.types.test_parsing_response.TestParsingResponse":
    """<p>Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.</p>

    Args:
        input_file: <p>Specifies an <code>S3Location</code> object, which contains the Amazon S3 bucket and prefix for the location of the input file.</p>
        file_format: <p>Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.</p>
        edi_type: <p>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.</p>
        advanced_options: <p>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.</p>

    Raises:
        capo_b2bi.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_b2bi.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.</p>
        capo_b2bi.errors.resource_not_found_exception.ResourceNotFoundException: <p>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.</p>
        capo_b2bi.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.</p>
        capo_b2bi.errors.validation_exception.ValidationException: <p>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.</p>
        capo_b2bi.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample TestParsing call

        >>> client.test_parsing(edi_type={'x12Details': {'transactionSet': 'X12_110', 'version': 'VERSION_4010'}}, file_format='JSON', input_file={'bucketName': 'test-bucket', 'key': 'sampleFile.txt'})
        Sample TestParsing call without EDI Splitting

        >>> client.test_parsing(edi_type={'x12Details': {'transactionSet': 'X12_110', 'version': 'VERSION_4010'}}, file_format='JSON', advanced_options={'x12': {'splitOptions': {'splitBy': 'NONE'}}}, input_file={'bucketName': 'test-bucket', 'key': 'sampleFile.txt'})
        Sample TestParsing call with EDI Splitting by Transaction

        >>> client.test_parsing(edi_type={'x12Details': {'transactionSet': 'X12_110', 'version': 'VERSION_4010'}}, file_format='JSON', advanced_options={'x12': {'splitOptions': {'splitBy': 'TRANSACTION'}}}, input_file={'bucketName': 'test-bucket', 'key': 'sampleFile.txt'})
        Sample TestParsing call with Validation Options

        >>> client.test_parsing(edi_type={'x12Details': {'transactionSet': 'X12_110', 'version': 'VERSION_4010'}}, file_format='JSON', advanced_options={'x12': {'validationOptions': {'validationRules': [{'codeListValidationRule': {'elementId': '1280', 'codesToAdd': ['X', 'Y', 'Z'], 'codesToRemove': ['A', 'B', 'C']}}, {'elementRequirementValidationRule': {'elementPosition': 'NM1-01', 'requirement': 'OPTIONAL'}}, {'elementLengthValidationRule': {'elementId': '0803', 'maxLength': 30, 'minLength': 5}}]}}}, input_file={'bucketName': 'test-bucket', 'key': 'sampleFile.txt'})
    """

    def _handler(
        req: "OperationRequest[capo_b2bi.types.test_parsing_request.TestParsingRequest]",
    ) -> OperationResponse[
        "capo_b2bi.types.test_parsing_response.TestParsingResponse"
    ]:
        import capo_b2bi._operations.b2_bi.test_parsing

        output, http_response = (
            capo_b2bi._operations.b2_bi.test_parsing.test_parsing(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TestParsing")
    )
    input_: capo_b2bi.types.test_parsing_request.TestParsingRequest = {
        "input_file": input_file,
        "file_format": file_format,
        "edi_type": edi_type,
    }
    if advanced_options is not None:
        input_["advanced_options"] = advanced_options

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output