Skip to content

DeleteCustomMetadataRequest

Source code in docs_src/capo_workdocs/types/delete_custom_metadata_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DeleteCustomMetadataRequest(TypedDict, closed=True):
    authentication_token: NotRequired[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ]
    """<p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
    resource_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
    """<p>The ID of the resource, either a document or folder.</p>"""
    version_id: NotRequired[
        "capo_workdocs.types.document_version_id_type.DocumentVersionIdType"
    ]
    """<p>The ID of the version, if the custom metadata is being deleted from a document version.</p>"""
    keys: NotRequired[
        "capo_workdocs.types.custom_metadata_key_list.CustomMetadataKeyList"
    ]
    """<p>List of properties to remove.</p>"""
    delete_all: "capo_workdocs.types.boolean_type.BooleanType"
    """<p>Flag to indicate removal of all custom metadata properties from the specified resource.</p>"""

authentication_token instance-attribute 

authentication_token: NotRequired[AuthenticationHeaderType]

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

delete_all instance-attribute 

delete_all: BooleanType

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

keys instance-attribute 

keys: NotRequired[CustomMetadataKeyList]

List of properties to remove.

resource_id instance-attribute 

resource_id: ResourceIdType

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

version_id instance-attribute 

version_id: NotRequired[DocumentVersionIdType]

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