get_transformer `async` ¶

get_transformer(
    transformer_id: TransformerId,
    *,
    config_overrides: Optional[Asyncb2biClientConfig] = None,
) -> GetTransformerResponse

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.

Parameters:

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 GetTransformer call

>>> await client.get_transformer(transformer_id='tr-974c129999f84d8c9')

Source code in docs_src/capo_b2bi/_services/async_b2bi.py

async def get_transformer(
    self,
    transformer_id: "capo_b2bi.types.transformer_id.TransformerId",
    *,
    config_overrides: Optional[Asyncb2biClientConfig] = None,
) -> "capo_b2bi.types.get_transformer_response.GetTransformerResponse":
    """<p>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.</p>

    Args:
        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 GetTransformer call

        >>> await client.get_transformer(transformer_id='tr-974c129999f84d8c9')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_b2bi.types.get_transformer_request.GetTransformerRequest]",
    ) -> AsyncOperationResponse[
        "capo_b2bi.types.get_transformer_response.GetTransformerResponse"
    ]:
        import capo_b2bi._operations.b2_bi.get_transformer

        (
            output,
            http_response,
        ) = await capo_b2bi._operations.b2_bi.get_transformer.async_get_transformer(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTransformer")
    )
    input_: capo_b2bi.types.get_transformer_request.GetTransformerRequest = {
        "transformer_id": transformer_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_transformer async ¶

get_transformer `async` ¶