Skip to content

describe_dataset_import_job async

describe_dataset_import_job(
    dataset_import_job_arn: Arn,
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
) -> DescribeDatasetImportJobResponse

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

Parameters:

  • dataset_import_job_arn (Arn) –

    The Amazon Resource Name (ARN) of the dataset import job.

Raises:

  • InvalidInputException –

    We can't process the request because it includes an invalid value or a value that exceeds the valid range.

  • ResourceNotFoundException –

    We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

  • UnknownServiceError –

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

Source code in docs_src/capo_forecast/_services/async_forecast.py
async def describe_dataset_import_job(
    self,
    dataset_import_job_arn: "capo_forecast.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
) -> "capo_forecast.types.describe_dataset_import_job_response.DescribeDatasetImportJobResponse":
    """<p>Describes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation.</p> <p>In addition to listing the parameters provided in the <code>CreateDatasetImportJob</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>DataSize</code> </p> </li> <li> <p> <code>FieldStatistics</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>

    Args:
        dataset_import_job_arn: <p>The Amazon Resource Name (ARN) of the dataset import job.</p>

    Raises:
        capo_forecast.errors.invalid_input_exception.InvalidInputException: <p>We can't process the request because it includes an invalid value or a value that exceeds the valid range.</p>
        capo_forecast.errors.resource_not_found_exception.ResourceNotFoundException: <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.</p>
        capo_forecast.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_forecast.types.describe_dataset_import_job_request.DescribeDatasetImportJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_forecast.types.describe_dataset_import_job_response.DescribeDatasetImportJobResponse"
    ]:
        import capo_forecast._operations.amazon_forecast.describe_dataset_import_job

        (
            output,
            http_response,
        ) = await capo_forecast._operations.amazon_forecast.describe_dataset_import_job.async_describe_dataset_import_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDatasetImportJob")
    )
    input_: capo_forecast.types.describe_dataset_import_job_request.DescribeDatasetImportJobRequest = {
        "dataset_import_job_arn": dataset_import_job_arn
    }

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