Skip to content

CreateCustomMetadataRequest

Source code in docs_src/capo_workdocs/types/create_custom_metadata_request.py
class CreateCustomMetadataRequest(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.</p>"""
    version_id: NotRequired[
        "capo_workdocs.types.document_version_id_type.DocumentVersionIdType"
    ]
    """<p>The ID of the version, if the custom metadata is being added to a document version.</p>"""
    custom_metadata: "capo_workdocs.types.custom_metadata_map.CustomMetadataMap"
    """<p>Custom metadata in the form of name-value pairs.</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.

custom_metadata instance-attribute

custom_metadata: CustomMetadataMap

Custom metadata in the form of name-value pairs.

resource_id instance-attribute

resource_id: ResourceIdType

The ID of the resource.

version_id instance-attribute

version_id: NotRequired[DocumentVersionIdType]

The ID of the version, if the custom metadata is being added to a document version.