start_matching_job `async` ¶

start_matching_job(
    workflow_name: EntityName,
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
) -> StartMatchingJobOutput

Starts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.

Parameters:

workflow_name (EntityName) –

The name of the matching job to be retrieved.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc.
ExceedsLimitException –

The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded.
InternalServerException –

This exception occurs when there is an internal failure in the Entity Resolution service.
ResourceNotFoundException –

The resource couldn't be found.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by Entity Resolution.
UnknownServiceError –

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

Source code in docs_src/capo_entityresolution/_services/async_entity_resolution.py

async def start_matching_job(
    self,
    workflow_name: "capo_entityresolution.types.entity_name.EntityName",
    *,
    config_overrides: Optional[AsyncEntityResolutionClientConfig] = None,
) -> "capo_entityresolution.types.start_matching_job_output.StartMatchingJobOutput":
    """<p>Starts the <code>MatchingJob</code> of a workflow. The workflow must have previously been created using the <code>CreateMatchingWorkflow</code> endpoint.</p>

    Args:
        workflow_name: <p>The name of the matching job to be retrieved.</p>

    Raises:
        capo_entityresolution.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action. </p>
        capo_entityresolution.errors.conflict_exception.ConflictException: <p>The request couldn't be processed because of conflict in the current state of the resource. Example: Workflow already exists, Schema already exists, Workflow is currently running, etc. </p>
        capo_entityresolution.errors.exceeds_limit_exception.ExceedsLimitException: <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. The error message describes the limit exceeded. </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.start_matching_job_input.StartMatchingJobInput]",
    ) -> AsyncOperationResponse[
        "capo_entityresolution.types.start_matching_job_output.StartMatchingJobOutput"
    ]:
        import capo_entityresolution._operations.aws_venice_service.start_matching_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartMatchingJob")
    )
    input_: capo_entityresolution.types.start_matching_job_input.StartMatchingJobInput = {
        "workflow_name": workflow_name
    }

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

start_matching_job async ¶

start_matching_job `async` ¶