Skip to content

delete_workload async

delete_workload(
    workload_id: WorkloadId,
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> None

Delete an existing workload.

Raises:

Source code in docs_src/capo_wellarchitected/_services/async_well_architected.py
async def delete_workload(
    self,
    workload_id: "capo_wellarchitected.types.workload_id.WorkloadId",
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    client_request_token: Optional[
        "capo_wellarchitected.types.client_request_token.ClientRequestToken"
    ] = None,
) -> None:
    """<p>Delete an existing workload.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.conflict_exception.ConflictException: <p>The resource has already been processed, was deleted, or is too large.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wellarchitected.types.delete_workload_input.DeleteWorkloadInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.delete_workload

        (
            output,
            http_response,
        ) = await capo_wellarchitected._operations.well_architected_api_service_lambda.delete_workload.async_delete_workload(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWorkload")
    )
    input_: capo_wellarchitected.types.delete_workload_input.DeleteWorkloadInput = {
        "workload_id": workload_id
    }
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token

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