delete_labels ¶

def delete_labels(
    self,
    resource_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
    labels: Optional["capo_workdocs.types.shared_labels.SharedLabels"] = None,
    delete_all: Optional["capo_workdocs.types.boolean_type.BooleanType"] = None,
) -> "capo_workdocs.types.delete_labels_response.DeleteLabelsResponse":
    """<p>Deletes the specified list of labels from a resource.</p>

    Args:
        resource_id: <p>The ID of the resource.</p>
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        labels: <p>List of labels to delete from the resource.</p>
        delete_all: <p>Flag to request removal of all labels from the specified resource.</p>

    Raises:
        capo_workdocs.errors.entity_not_exists_exception.EntityNotExistsException: <p>The resource does not exist.</p>
        capo_workdocs.errors.failed_dependency_exception.FailedDependencyException: <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
        capo_workdocs.errors.prohibited_state_exception.ProhibitedStateException: <p>The specified document version is not in the INITIALIZED state.</p>
        capo_workdocs.errors.service_unavailable_exception.ServiceUnavailableException: <p>One or more of the dependencies is unavailable.</p>
        capo_workdocs.errors.unauthorized_operation_exception.UnauthorizedOperationException: <p>The operation is not permitted.</p>
        capo_workdocs.errors.unauthorized_resource_access_exception.UnauthorizedResourceAccessException: <p>The caller does not have access to perform the action on the resource.</p>
        capo_workdocs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workdocs.types.delete_labels_request.DeleteLabelsRequest]",
    ) -> OperationResponse[
        "capo_workdocs.types.delete_labels_response.DeleteLabelsResponse"
    ]:
        import capo_workdocs._operations.aws_gorilla_boy_service.delete_labels

        output, http_response = (
            capo_workdocs._operations.aws_gorilla_boy_service.delete_labels.delete_labels(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workdocs.types.delete_labels_request.DeleteLabelsRequest",
    ) -> dict[str, Any]:
        import capo_workdocs.types.delete_labels_request

        return capo_workdocs.types.delete_labels_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteLabels", redact_input=_redact_input),
    )
    input_: capo_workdocs.types.delete_labels_request.DeleteLabelsRequest = {
        "resource_id": resource_id
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token
    if labels is not None:
        input_["labels"] = labels
    if delete_all is not None:
        input_["delete_all"] = delete_all

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