Skip to content

get_transformer_job

get_transformer_job(
    transformer_job_id: TransformerJobId,
    transformer_id: TransformerId,
    *,
    config_overrides: Optional[b2biClientConfig] = None,
) -> GetTransformerJobResponse

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.

Parameters:

  • transformer_job_id (TransformerJobId) –

    Specifies the unique, system-generated identifier for a transformer run.

  • transformer_id (TransformerId) –

    Specifies the system-assigned unique identifier for the transformer.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • InternalServerException –

    This exception is thrown when an error occurs in the Amazon Web Services B2B Data Interchange service.

  • 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.

  • ThrottlingException –

    The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.

  • ValidationException –

    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.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

Sample GetTransformerJob call

>>> client.get_transformer_job(transformer_id='tr-974c129999f84d8c9', transformer_job_id='tj-vpYxfV7yQOqjMSYllEslLw')
Source code in docs_src/capo_b2bi/_services/b2bi.py
def get_transformer_job(
    self,
    transformer_job_id: "capo_b2bi.types.transformer_job_id.TransformerJobId",
    transformer_id: "capo_b2bi.types.transformer_id.TransformerId",
    *,
    config_overrides: Optional[b2biClientConfig] = None,
) -> "capo_b2bi.types.get_transformer_job_response.GetTransformerJobResponse":
    """<p>Returns the details of the transformer run, based on the Transformer job ID.</p> <note> <p>If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run <code>GetTransformerJob</code> and supply a <code>transformerId</code> and <code>transformerJobId</code> for a job that was started more than 30 days previously, you receive a 404 response.</p> </note>

    Args:
        transformer_job_id: <p>Specifies the unique, system-generated identifier for a transformer run.</p>
        transformer_id: <p>Specifies the system-assigned unique identifier for the transformer.</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 GetTransformerJob call

        >>> client.get_transformer_job(transformer_id='tr-974c129999f84d8c9', transformer_job_id='tj-vpYxfV7yQOqjMSYllEslLw')
    """

    def _handler(
        req: "OperationRequest[capo_b2bi.types.get_transformer_job_request.GetTransformerJobRequest]",
    ) -> OperationResponse[
        "capo_b2bi.types.get_transformer_job_response.GetTransformerJobResponse"
    ]:
        import capo_b2bi._operations.b2_bi.get_transformer_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTransformerJob")
    )
    input_: capo_b2bi.types.get_transformer_job_request.GetTransformerJobRequest = {
        "transformer_job_id": transformer_job_id,
        "transformer_id": transformer_id,
    }

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