Skip to content

list_matching_jobs async

list_matching_jobs(
    workflow_name: EntityName,
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[int] = None,
) -> ListMatchingJobsOutput

Lists all jobs for a given workflow.

Parameters:

  • workflow_name (EntityName) –

    The name of the workflow to be retrieved.

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

    The pagination token from the previous API call.

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

    The maximum number of objects returned per page.

Raises:

Source code in docs_src/capo_entityresolution/_services/async_entity_resolution.py
async def list_matching_jobs(
    self,
    workflow_name: "capo_entityresolution.types.entity_name.EntityName",
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
    next_token: Optional["capo_entityresolution.types.next_token.NextToken"] = None,
    max_results: Optional[int] = None,
) -> "capo_entityresolution.types.list_matching_jobs_output.ListMatchingJobsOutput":
    """<p>Lists all jobs for a given workflow.</p>

    Args:
        workflow_name: <p>The name of the workflow to be retrieved.</p>
        next_token: <p>The pagination token from the previous API call.</p>
        max_results: <p>The maximum number of objects returned per page.</p>

    Raises:
        capo_entityresolution.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </p>
        capo_entityresolution.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Entity Resolution service. </p>
        capo_entityresolution.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found. </p>
        capo_entityresolution.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. </p>
        capo_entityresolution.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
        capo_entityresolution.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_entityresolution.types.list_matching_jobs_input.ListMatchingJobsInput]",
    ) -> AsyncOperationResponse[
        "capo_entityresolution.types.list_matching_jobs_output.ListMatchingJobsOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.list_matching_jobs

        (
            output,
            http_response,
        ) = await capo_entityresolution._operations.aws_venice_service.list_matching_jobs.async_list_matching_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMatchingJobs")
    )
    input_: capo_entityresolution.types.list_matching_jobs_input.ListMatchingJobsInput = {
        "workflow_name": workflow_name
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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