Skip to content

cancel_capacity_task async

cancel_capacity_task(
    capacity_task_id: CapacityTaskId,
    outpost_identifier: OutpostIdentifier,
    *,
    config_overrides: Optional[AsyncOutpostsClientConfig] = None,
) -> CancelCapacityTaskOutput

Cancels the capacity task.

Parameters:

  • capacity_task_id (CapacityTaskId) –

    ID of the capacity task that you want to cancel.

  • outpost_identifier (OutpostIdentifier) –

    ID or ARN of the Outpost associated with the capacity task that you want to cancel.

Raises:

Source code in docs_src/capo_outposts/_services/async_outposts.py
async def cancel_capacity_task(
    self,
    capacity_task_id: "capo_outposts.types.capacity_task_id.CapacityTaskId",
    outpost_identifier: "capo_outposts.types.outpost_identifier.OutpostIdentifier",
    *,
    config_overrides: Optional[AsyncOutpostsClientConfig] = None,
) -> "capo_outposts.types.cancel_capacity_task_output.CancelCapacityTaskOutput":
    """<p>Cancels the capacity task.</p>

    Args:
        capacity_task_id: <p>ID of the capacity task that you want to cancel.</p>
        outpost_identifier: <p>ID or ARN of the Outpost associated with the capacity task that you want to cancel.</p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.conflict_exception.ConflictException: <p>Updating or deleting this resource can cause an inconsistent state.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_outposts.types.cancel_capacity_task_input.CancelCapacityTaskInput]",
    ) -> AsyncOperationResponse[
        "capo_outposts.types.cancel_capacity_task_output.CancelCapacityTaskOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.cancel_capacity_task

        (
            output,
            http_response,
        ) = await capo_outposts._operations.outposts_olaf_service.cancel_capacity_task.async_cancel_capacity_task(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelCapacityTask")
    )
    input_: capo_outposts.types.cancel_capacity_task_input.CancelCapacityTaskInput = {
        "capacity_task_id": capacity_task_id,
        "outpost_identifier": outpost_identifier,
    }

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