WorkDocs / Client / delete_labels

delete_labels#

WorkDocs.Client.delete_labels(**kwargs)#

Deletes the specified list of labels from a resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_labels(
    ResourceId='string',
    AuthenticationToken='string',
    Labels=[
        'string',
    ],
    DeleteAll=True|False
)
Parameters:

  • ResourceId (string) –

    [REQUIRED]

    The ID of the resource.

  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • Labels (list) –

    List of labels to delete from the resource.

    • (string) –

  • DeleteAll (boolean) – Flag to request removal of all labels from the specified resource.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkDocs.Client.exceptions.EntityNotExistsException

  • WorkDocs.Client.exceptions.UnauthorizedOperationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.ServiceUnavailableException

  • WorkDocs.Client.exceptions.ProhibitedStateException