Skip to content

delete_workload_share

delete_workload_share(
    share_id: ShareId,
    workload_id: WorkloadId,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> None

Delete a workload share.

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def delete_workload_share(
    self,
    share_id: "capo_wellarchitected.types.share_id.ShareId",
    workload_id: "capo_wellarchitected.types.workload_id.WorkloadId",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    client_request_token: Optional[
        "capo_wellarchitected.types.client_request_token.ClientRequestToken"
    ] = None,
) -> None:
    """<p>Delete a workload share.</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.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.delete_workload_share_input.DeleteWorkloadShareInput]",
    ) -> OperationResponse[None]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.delete_workload_share

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.delete_workload_share.delete_workload_share(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output