delete_custom_metadata

WorkDocs.Client.delete_custom_metadata(**kwargs)

Deletes custom metadata from the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_custom_metadata(
    AuthenticationToken='string',
    ResourceId='string',
    VersionId='string',
    Keys=[
        'string',
    ],
    DeleteAll=True|False
)

Parameters

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

  [REQUIRED]

  The ID of the resource, either a document or folder.

• VersionId (string) -- The ID of the version, if the custom metadata is being deleted from a document version.
• Keys (list) --

  List of properties to remove.

  • (string) --
• DeleteAll (boolean) -- Flag to indicate removal of all custom metadata properties 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.ProhibitedStateException
• WorkDocs.Client.exceptions.FailedDependencyException
• WorkDocs.Client.exceptions.ServiceUnavailableException