Skip to content

describe_import

describe_import(
    import_id: Id, *, config_overrides: Optional[LexModelsV2ClientConfig] = None
) -> DescribeImportResponse

Gets information about a specific import.

Parameters:

  • import_id (Id) –

    The unique identifier of the import to describe.

Raises:

  • InternalServerException –

    The service encountered an unexpected condition. Try your request again.

  • ResourceNotFoundException –

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ThrottlingException –

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException –

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • UnknownServiceError –

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

Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py
def describe_import(
    self,
    import_id: "capo_lex_models_v2.types.id.Id",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> "capo_lex_models_v2.types.describe_import_response.DescribeImportResponse":
    """<p>Gets information about a specific import.</p>

    Args:
        import_id: <p>The unique identifier of the import to describe.</p>

    Raises:
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.</p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.describe_import_request.DescribeImportRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.describe_import_response.DescribeImportResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.describe_import

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.describe_import.describe_import(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeImport")
    )
    input_: capo_lex_models_v2.types.describe_import_request.DescribeImportRequest = {
        "import_id": import_id
    }

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