list_jobs `async` ¶

list_jobs(
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    dataset_name: Optional[DatasetName] = None,
    max_results: Optional[MaxResults100] = None,
    next_token: Optional[NextToken] = None,
    project_name: Optional[ProjectName] = None,
) -> ListJobsResponse

Lists all of the DataBrew jobs that are defined.

Parameters:

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

The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.
max_results (Optional[MaxResults100], default: None ) –

The maximum number of results to return in this request.
next_token (Optional[NextToken], default: None ) –

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.
project_name (Optional[ProjectName], default: None ) –

The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

Raises:

ValidationException –

The input parameters for this request failed validation.
UnknownServiceError –

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

Source code in docs_src/capo_databrew/_services/async_data_brew.py

async def list_jobs(
    self,
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    dataset_name: Optional["capo_databrew.types.dataset_name.DatasetName"] = None,
    max_results: Optional[
        "capo_databrew.types.max_results100.MaxResults100"
    ] = None,
    next_token: Optional["capo_databrew.types.next_token.NextToken"] = None,
    project_name: Optional["capo_databrew.types.project_name.ProjectName"] = None,
) -> "capo_databrew.types.list_jobs_response.ListJobsResponse":
    """<p>Lists all of the DataBrew jobs that are defined.</p>

    Args:
        dataset_name: <p>The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.</p>
        max_results: <p>The maximum number of results to return in this request. </p>
        next_token: <p>A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call. </p>
        project_name: <p>The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.</p>

    Raises:
        capo_databrew.errors.validation_exception.ValidationException: <p>The input parameters for this request failed validation.</p>
        capo_databrew.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_databrew.types.list_jobs_request.ListJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_databrew.types.list_jobs_response.ListJobsResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.list_jobs

        (
            output,
            http_response,
        ) = await capo_databrew._operations.aws_glue_data_brew.list_jobs.async_list_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListJobs")
    )
    input_: capo_databrew.types.list_jobs_request.ListJobsRequest = {}
    if dataset_name is not None:
        input_["dataset_name"] = dataset_name
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if project_name is not None:
        input_["project_name"] = project_name

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

list_jobs async ¶

list_jobs `async` ¶