Skip to content

list_data_ingestion_jobs

list_data_ingestion_jobs(
    *,
    config_overrides: Optional[LookoutEquipmentClientConfig] = None,
    dataset_name: Optional[DatasetName] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    status: Optional[IngestionJobStatus] = None,
) -> ListDataIngestionJobsResponse

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

Parameters:

  • dataset_name (Optional[DatasetName], default: None ) –

    The name of the dataset being used for the data ingestion job.

  • next_token (Optional[NextToken], default: None ) –

    An opaque pagination token indicating where to continue the listing of data ingestion jobs.

  • max_results (Optional[MaxResults], default: None ) –

    Specifies the maximum number of data ingestion jobs to list.

  • status (Optional[IngestionJobStatus], default: None ) –

    Indicates the status of the data ingestion job.

Raises:

  • AccessDeniedException –

    The request could not be completed because you do not have access to the resource.

  • InternalServerException –

    Processing of the request has failed because of an unknown error, exception or failure.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

  • UnknownServiceError –

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

Source code in docs_src/capo_lookoutequipment/_services/lookout_equipment.py
def list_data_ingestion_jobs(
    self,
    *,
    config_overrides: Optional[LookoutEquipmentClientConfig] = None,
    dataset_name: Optional[
        "capo_lookoutequipment.types.dataset_name.DatasetName"
    ] = None,
    next_token: Optional["capo_lookoutequipment.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_lookoutequipment.types.max_results.MaxResults"
    ] = None,
    status: Optional[
        "capo_lookoutequipment.types.ingestion_job_status.IngestionJobStatus"
    ] = None,
) -> "capo_lookoutequipment.types.list_data_ingestion_jobs_response.ListDataIngestionJobsResponse":
    """<p>Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on. </p>

    Args:
        dataset_name: <p>The name of the dataset being used for the data ingestion job. </p>
        next_token: <p>An opaque pagination token indicating where to continue the listing of data ingestion jobs. </p>
        max_results: <p> Specifies the maximum number of data ingestion jobs to list. </p>
        status: <p>Indicates the status of the data ingestion job. </p>

    Raises:
        capo_lookoutequipment.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have access to the resource. </p>
        capo_lookoutequipment.errors.internal_server_exception.InternalServerException: <p> Processing of the request has failed because of an unknown error, exception or failure. </p>
        capo_lookoutequipment.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_lookoutequipment.errors.validation_exception.ValidationException: <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. </p>
        capo_lookoutequipment.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lookoutequipment.types.list_data_ingestion_jobs_request.ListDataIngestionJobsRequest]",
    ) -> OperationResponse[
        "capo_lookoutequipment.types.list_data_ingestion_jobs_response.ListDataIngestionJobsResponse"
    ]:
        import capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_data_ingestion_jobs

        output, http_response = (
            capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_data_ingestion_jobs.list_data_ingestion_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDataIngestionJobs")
    )
    input_: capo_lookoutequipment.types.list_data_ingestion_jobs_request.ListDataIngestionJobsRequest = {}
    if dataset_name is not None:
        input_["dataset_name"] = dataset_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if status is not None:
        input_["status"] = status

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