Skip to content

UpdateFolderRequest

Source code in docs_src/capo_workdocs/types/update_folder_request.py
class UpdateFolderRequest(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>"""
    folder_id: "capo_workdocs.types.resource_id_type.ResourceIdType"
    """<p>The ID of the folder.</p>"""
    name: NotRequired["capo_workdocs.types.resource_name_type.ResourceNameType"]
    """<p>The name of the folder.</p>"""
    parent_folder_id: NotRequired["capo_workdocs.types.resource_id_type.ResourceIdType"]
    """<p>The ID of the parent folder.</p>"""
    resource_state: NotRequired[
        "capo_workdocs.types.resource_state_type.ResourceStateType"
    ]
    """<p>The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.</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.

folder_id instance-attribute

folder_id: ResourceIdType

The ID of the folder.

name instance-attribute

name: NotRequired[ResourceNameType]

The name of the folder.

parent_folder_id instance-attribute

parent_folder_id: NotRequired[ResourceIdType]

The ID of the parent folder.

resource_state instance-attribute

resource_state: NotRequired[ResourceStateType]

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.