cancel_metadata_generation_run `async` ¶

cancel_metadata_generation_run(
    domain_identifier: DomainId,
    identifier: MetadataGenerationRunIdentifier,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
) -> CancelMetadataGenerationRunOutput

Cancels the metadata generation run.

Prerequisites:

The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS).
Runs in SUCCEEDED status cannot be cancelled.
User must have access to the run and cancel permissions.

Parameters:

domain_identifier (DomainId) –

The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.
identifier (MetadataGenerationRunIdentifier) –

The ID of the metadata generation run.

Raises:

AccessDeniedException –

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

The request was denied due to request throttling.
UnauthorizedException –

You do not have permission to perform this action.
ConflictException –

There is a conflict while performing this action.
InternalServerException –

The request has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

The specified resource cannot be found.
ValidationException –

The input fails to satisfy the constraints specified by the Amazon Web Services service.
UnknownServiceError –

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

Source code in docs_src/capo_datazone/_services/async_data_zone.py

async def cancel_metadata_generation_run(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.metadata_generation_run_identifier.MetadataGenerationRunIdentifier",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
) -> "capo_datazone.types.cancel_metadata_generation_run_output.CancelMetadataGenerationRunOutput":
    """<p>Cancels the metadata generation run.</p> <p>Prerequisites:</p> <ul> <li> <p>The run must exist and be in a cancelable status (e.g., SUBMITTED, IN_PROGRESS). </p> </li> <li> <p>Runs in SUCCEEDED status cannot be cancelled.</p> </li> <li> <p>User must have access to the run and cancel permissions.</p> </li> </ul>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.</p>
        identifier: <p>The ID of the metadata generation run.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.conflict_exception.ConflictException: <p>There is a conflict while performing this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.cancel_metadata_generation_run_input.CancelMetadataGenerationRunInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.cancel_metadata_generation_run_output.CancelMetadataGenerationRunOutput"
    ]:
        import capo_datazone._operations.data_zone.cancel_metadata_generation_run

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.cancel_metadata_generation_run.async_cancel_metadata_generation_run(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelMetadataGenerationRun")
    )
    input_: capo_datazone.types.cancel_metadata_generation_run_input.CancelMetadataGenerationRunInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }

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

cancel_metadata_generation_run async ¶

cancel_metadata_generation_run `async` ¶