:doc:`WorkDocs <../../workdocs>` / Client / delete_custom_metadata

**********************
delete_custom_metadata
**********************



.. py:method:: WorkDocs.Client.delete_custom_metadata(**kwargs)

  

  Deletes custom metadata from the specified resource.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteCustomMetadata>`_  


  **Request Syntax**
  ::

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

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

    

  
  :type ResourceId: string
  :param ResourceId: **[REQUIRED]** 

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

    

  
  :type VersionId: string
  :param VersionId: 

    The ID of the version, if the custom metadata is being deleted from a document version.

    

  
  :type Keys: list
  :param Keys: 

    List of properties to remove.

    

  
    - *(string) --* 

    

  :type DeleteAll: boolean
  :param DeleteAll: 

    Flag to indicate removal of all custom metadata properties from the specified resource.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`WorkDocs.Client.exceptions.EntityNotExistsException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedOperationException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedResourceAccessException`

  
  *   :py:class:`WorkDocs.Client.exceptions.ProhibitedStateException`

  
  *   :py:class:`WorkDocs.Client.exceptions.FailedDependencyException`

  
  *   :py:class:`WorkDocs.Client.exceptions.ServiceUnavailableException`

  