WorkDocsClient

Index > WorkDocs > WorkDocsClient

Auto-generated documentation for WorkDocs type annotations stubs module types-boto3-workdocs.

WorkDocsClient

Type annotations and code completion for boto3.client("workdocs"). boto3 documentation

# WorkDocsClient usage example

from boto3.session import Session
from types_boto3_workdocs.client import WorkDocsClient

def get_workdocs_client() -> WorkDocsClient:
    return Session().client("workdocs")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("workdocs").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("workdocs")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConflictingOperationException,
    client.exceptions.CustomMetadataLimitExceededException,
    client.exceptions.DeactivatingLastSystemUserException,
    client.exceptions.DocumentLockedForCommentsException,
    client.exceptions.DraftUploadOutOfSyncException,
    client.exceptions.EntityAlreadyExistsException,
    client.exceptions.EntityNotExistsException,
    client.exceptions.FailedDependencyException,
    client.exceptions.IllegalUserStateException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.InvalidCommentOperationException,
    client.exceptions.InvalidOperationException,
    client.exceptions.InvalidPasswordException,
    client.exceptions.LimitExceededException,
    client.exceptions.ProhibitedStateException,
    client.exceptions.RequestedEntityTooLargeException,
    client.exceptions.ResourceAlreadyCheckedOutException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.StorageLimitExceededException,
    client.exceptions.StorageLimitWillExceedException,
    client.exceptions.TooManyLabelsException,
    client.exceptions.TooManySubscriptionsException,
    client.exceptions.UnauthorizedOperationException,
    client.exceptions.UnauthorizedResourceAccessException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_workdocs.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("workdocs").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("workdocs").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

abort_document_version_upload

Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.

Type annotations and code completion for boto3.client("workdocs").abort_document_version_upload method. boto3 documentation

# abort_document_version_upload method definition

def abort_document_version_upload(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# abort_document_version_upload method usage example with argument unpacking

kwargs: AbortDocumentVersionUploadRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
}

parent.abort_document_version_upload(**kwargs)

1. See AbortDocumentVersionUploadRequestTypeDef

activate_user

Activates the specified user.

Type annotations and code completion for boto3.client("workdocs").activate_user method. boto3 documentation

# activate_user method definition

def activate_user(
    self,
    *,
    UserId: str,
    AuthenticationToken: str = ...,
) -> ActivateUserResponseTypeDef:  # (1)
    ...

1. See ActivateUserResponseTypeDef

# activate_user method usage example with argument unpacking

kwargs: ActivateUserRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.activate_user(**kwargs)

1. See ActivateUserRequestTypeDef

add_resource_permissions

Creates a set of permissions for the specified folder or document.

Type annotations and code completion for boto3.client("workdocs").add_resource_permissions method. boto3 documentation

# add_resource_permissions method definition

def add_resource_permissions(
    self,
    *,
    ResourceId: str,
    Principals: Sequence[SharePrincipalTypeDef],  # (1)
    AuthenticationToken: str = ...,
    NotificationOptions: NotificationOptionsTypeDef = ...,  # (2)
) -> AddResourcePermissionsResponseTypeDef:  # (3)
    ...

1. See Sequence[SharePrincipalTypeDef]
2. See NotificationOptionsTypeDef
3. See AddResourcePermissionsResponseTypeDef

# add_resource_permissions method usage example with argument unpacking

kwargs: AddResourcePermissionsRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Principals": ...,
}

parent.add_resource_permissions(**kwargs)

1. See AddResourcePermissionsRequestTypeDef

create_comment

Adds a new comment to the specified document version.

Type annotations and code completion for boto3.client("workdocs").create_comment method. boto3 documentation

# create_comment method definition

def create_comment(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    Text: str,
    AuthenticationToken: str = ...,
    ParentId: str = ...,
    ThreadId: str = ...,
    Visibility: CommentVisibilityTypeType = ...,  # (1)
    NotifyCollaborators: bool = ...,
) -> CreateCommentResponseTypeDef:  # (2)
    ...

1. See CommentVisibilityTypeType
2. See CreateCommentResponseTypeDef

# create_comment method usage example with argument unpacking

kwargs: CreateCommentRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
    "Text": ...,
}

parent.create_comment(**kwargs)

1. See CreateCommentRequestTypeDef

create_custom_metadata

Adds one or more custom properties to the specified resource (a folder, document, or version).

Type annotations and code completion for boto3.client("workdocs").create_custom_metadata method. boto3 documentation

# create_custom_metadata method definition

def create_custom_metadata(
    self,
    *,
    ResourceId: str,
    CustomMetadata: Mapping[str, str],
    AuthenticationToken: str = ...,
    VersionId: str = ...,
) -> Dict[str, Any]:
    ...

# create_custom_metadata method usage example with argument unpacking

kwargs: CreateCustomMetadataRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "CustomMetadata": ...,
}

parent.create_custom_metadata(**kwargs)

1. See CreateCustomMetadataRequestTypeDef

create_folder

Creates a folder with the specified name and parent folder.

Type annotations and code completion for boto3.client("workdocs").create_folder method. boto3 documentation

# create_folder method definition

def create_folder(
    self,
    *,
    ParentFolderId: str,
    AuthenticationToken: str = ...,
    Name: str = ...,
) -> CreateFolderResponseTypeDef:  # (1)
    ...

1. See CreateFolderResponseTypeDef

# create_folder method usage example with argument unpacking

kwargs: CreateFolderRequestTypeDef = {  # (1)
    "ParentFolderId": ...,
}

parent.create_folder(**kwargs)

1. See CreateFolderRequestTypeDef

create_labels

Adds the specified list of labels to the given resource (a document or folder).

Type annotations and code completion for boto3.client("workdocs").create_labels method. boto3 documentation

# create_labels method definition

def create_labels(
    self,
    *,
    ResourceId: str,
    Labels: Sequence[str],
    AuthenticationToken: str = ...,
) -> Dict[str, Any]:
    ...

# create_labels method usage example with argument unpacking

kwargs: CreateLabelsRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Labels": ...,
}

parent.create_labels(**kwargs)

1. See CreateLabelsRequestTypeDef

create_notification_subscription

Configure Amazon WorkDocs to use Amazon SNS notifications.

Type annotations and code completion for boto3.client("workdocs").create_notification_subscription method. boto3 documentation

# create_notification_subscription method definition

def create_notification_subscription(
    self,
    *,
    OrganizationId: str,
    Endpoint: str,
    Protocol: SubscriptionProtocolTypeType,  # (1)
    SubscriptionType: SubscriptionTypeType,  # (2)
) -> CreateNotificationSubscriptionResponseTypeDef:  # (3)
    ...

1. See SubscriptionProtocolTypeType
2. See SubscriptionTypeType
3. See CreateNotificationSubscriptionResponseTypeDef

# create_notification_subscription method usage example with argument unpacking

kwargs: CreateNotificationSubscriptionRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Endpoint": ...,
    "Protocol": ...,
    "SubscriptionType": ...,
}

parent.create_notification_subscription(**kwargs)

1. See CreateNotificationSubscriptionRequestTypeDef

create_user

Creates a user in a Simple AD or Microsoft AD directory.

Type annotations and code completion for boto3.client("workdocs").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    Username: str,
    GivenName: str,
    Surname: str,
    Password: str,
    OrganizationId: str = ...,
    EmailAddress: str = ...,
    TimeZoneId: str = ...,
    StorageRule: StorageRuleTypeTypeDef = ...,  # (1)
    AuthenticationToken: str = ...,
) -> CreateUserResponseTypeDef:  # (2)
    ...

1. See StorageRuleTypeTypeDef
2. See CreateUserResponseTypeDef

# create_user method usage example with argument unpacking

kwargs: CreateUserRequestTypeDef = {  # (1)
    "Username": ...,
    "GivenName": ...,
    "Surname": ...,
    "Password": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestTypeDef

deactivate_user

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Type annotations and code completion for boto3.client("workdocs").deactivate_user method. boto3 documentation

# deactivate_user method definition

def deactivate_user(
    self,
    *,
    UserId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# deactivate_user method usage example with argument unpacking

kwargs: DeactivateUserRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.deactivate_user(**kwargs)

1. See DeactivateUserRequestTypeDef

delete_comment

Deletes the specified comment from the document version.

Type annotations and code completion for boto3.client("workdocs").delete_comment method. boto3 documentation

# delete_comment method definition

def delete_comment(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    CommentId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_comment method usage example with argument unpacking

kwargs: DeleteCommentRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
    "CommentId": ...,
}

parent.delete_comment(**kwargs)

1. See DeleteCommentRequestTypeDef

delete_custom_metadata

Deletes custom metadata from the specified resource.

Type annotations and code completion for boto3.client("workdocs").delete_custom_metadata method. boto3 documentation

# delete_custom_metadata method definition

def delete_custom_metadata(
    self,
    *,
    ResourceId: str,
    AuthenticationToken: str = ...,
    VersionId: str = ...,
    Keys: Sequence[str] = ...,
    DeleteAll: bool = ...,
) -> Dict[str, Any]:
    ...

# delete_custom_metadata method usage example with argument unpacking

kwargs: DeleteCustomMetadataRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.delete_custom_metadata(**kwargs)

1. See DeleteCustomMetadataRequestTypeDef

delete_document

Permanently deletes the specified document and its associated metadata.

Type annotations and code completion for boto3.client("workdocs").delete_document method. boto3 documentation

# delete_document method definition

def delete_document(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_document method usage example with argument unpacking

kwargs: DeleteDocumentRequestTypeDef = {  # (1)
    "DocumentId": ...,
}

parent.delete_document(**kwargs)

1. See DeleteDocumentRequestTypeDef

delete_document_version

Deletes a specific version of a document.

Type annotations and code completion for boto3.client("workdocs").delete_document_version method. boto3 documentation

# delete_document_version method definition

def delete_document_version(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    DeletePriorVersions: bool,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_document_version method usage example with argument unpacking

kwargs: DeleteDocumentVersionRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
    "DeletePriorVersions": ...,
}

parent.delete_document_version(**kwargs)

1. See DeleteDocumentVersionRequestTypeDef

delete_folder

Permanently deletes the specified folder and its contents.

Type annotations and code completion for boto3.client("workdocs").delete_folder method. boto3 documentation

# delete_folder method definition

def delete_folder(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_folder method usage example with argument unpacking

kwargs: DeleteFolderRequestTypeDef = {  # (1)
    "FolderId": ...,
}

parent.delete_folder(**kwargs)

1. See DeleteFolderRequestTypeDef

delete_folder_contents

Deletes the contents of the specified folder.

Type annotations and code completion for boto3.client("workdocs").delete_folder_contents method. boto3 documentation

# delete_folder_contents method definition

def delete_folder_contents(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_folder_contents method usage example with argument unpacking

kwargs: DeleteFolderContentsRequestTypeDef = {  # (1)
    "FolderId": ...,
}

parent.delete_folder_contents(**kwargs)

1. See DeleteFolderContentsRequestTypeDef

delete_labels

Deletes the specified list of labels from a resource.

Type annotations and code completion for boto3.client("workdocs").delete_labels method. boto3 documentation

# delete_labels method definition

def delete_labels(
    self,
    *,
    ResourceId: str,
    AuthenticationToken: str = ...,
    Labels: Sequence[str] = ...,
    DeleteAll: bool = ...,
) -> Dict[str, Any]:
    ...

# delete_labels method usage example with argument unpacking

kwargs: DeleteLabelsRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.delete_labels(**kwargs)

1. See DeleteLabelsRequestTypeDef

delete_notification_subscription

Deletes the specified subscription from the specified organization.

Type annotations and code completion for boto3.client("workdocs").delete_notification_subscription method. boto3 documentation

# delete_notification_subscription method definition

def delete_notification_subscription(
    self,
    *,
    SubscriptionId: str,
    OrganizationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_notification_subscription method usage example with argument unpacking

kwargs: DeleteNotificationSubscriptionRequestTypeDef = {  # (1)
    "SubscriptionId": ...,
    "OrganizationId": ...,
}

parent.delete_notification_subscription(**kwargs)

1. See DeleteNotificationSubscriptionRequestTypeDef

delete_user

Deletes the specified user from a Simple AD or Microsoft AD directory.

Type annotations and code completion for boto3.client("workdocs").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    UserId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.delete_user(**kwargs)

1. See DeleteUserRequestTypeDef

describe_activities

Describes the user activities in a specified time period.

Type annotations and code completion for boto3.client("workdocs").describe_activities method. boto3 documentation

# describe_activities method definition

def describe_activities(
    self,
    *,
    AuthenticationToken: str = ...,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    OrganizationId: str = ...,
    ActivityTypes: str = ...,
    ResourceId: str = ...,
    UserId: str = ...,
    IncludeIndirectActivities: bool = ...,
    Limit: int = ...,
    Marker: str = ...,
) -> DescribeActivitiesResponseTypeDef:  # (1)
    ...

1. See DescribeActivitiesResponseTypeDef

# describe_activities method usage example with argument unpacking

kwargs: DescribeActivitiesRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.describe_activities(**kwargs)

1. See DescribeActivitiesRequestTypeDef

describe_comments

List all the comments for the specified document version.

Type annotations and code completion for boto3.client("workdocs").describe_comments method. boto3 documentation

# describe_comments method definition

def describe_comments(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: str = ...,
    Limit: int = ...,
    Marker: str = ...,
) -> DescribeCommentsResponseTypeDef:  # (1)
    ...

1. See DescribeCommentsResponseTypeDef

# describe_comments method usage example with argument unpacking

kwargs: DescribeCommentsRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
}

parent.describe_comments(**kwargs)

1. See DescribeCommentsRequestTypeDef

describe_document_versions

Retrieves the document versions for the specified document.

Type annotations and code completion for boto3.client("workdocs").describe_document_versions method. boto3 documentation

# describe_document_versions method definition

def describe_document_versions(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
    Marker: str = ...,
    Limit: int = ...,
    Include: str = ...,
    Fields: str = ...,
) -> DescribeDocumentVersionsResponseTypeDef:  # (1)
    ...

1. See DescribeDocumentVersionsResponseTypeDef

# describe_document_versions method usage example with argument unpacking

kwargs: DescribeDocumentVersionsRequestTypeDef = {  # (1)
    "DocumentId": ...,
}

parent.describe_document_versions(**kwargs)

1. See DescribeDocumentVersionsRequestTypeDef

describe_folder_contents

Describes the contents of the specified folder, including its documents and subfolders.

Type annotations and code completion for boto3.client("workdocs").describe_folder_contents method. boto3 documentation

# describe_folder_contents method definition

def describe_folder_contents(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
    Sort: ResourceSortTypeType = ...,  # (1)
    Order: OrderTypeType = ...,  # (2)
    Limit: int = ...,
    Marker: str = ...,
    Type: FolderContentTypeType = ...,  # (3)
    Include: str = ...,
) -> DescribeFolderContentsResponseTypeDef:  # (4)
    ...

1. See ResourceSortTypeType
2. See OrderTypeType
3. See FolderContentTypeType
4. See DescribeFolderContentsResponseTypeDef

# describe_folder_contents method usage example with argument unpacking

kwargs: DescribeFolderContentsRequestTypeDef = {  # (1)
    "FolderId": ...,
}

parent.describe_folder_contents(**kwargs)

1. See DescribeFolderContentsRequestTypeDef

describe_groups

Describes the groups specified by the query.

Type annotations and code completion for boto3.client("workdocs").describe_groups method. boto3 documentation

# describe_groups method definition

def describe_groups(
    self,
    *,
    SearchQuery: str,
    AuthenticationToken: str = ...,
    OrganizationId: str = ...,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeGroupsResponseTypeDef:  # (1)
    ...

1. See DescribeGroupsResponseTypeDef

# describe_groups method usage example with argument unpacking

kwargs: DescribeGroupsRequestTypeDef = {  # (1)
    "SearchQuery": ...,
}

parent.describe_groups(**kwargs)

1. See DescribeGroupsRequestTypeDef

describe_notification_subscriptions

Lists the specified notification subscriptions.

Type annotations and code completion for boto3.client("workdocs").describe_notification_subscriptions method. boto3 documentation

# describe_notification_subscriptions method definition

def describe_notification_subscriptions(
    self,
    *,
    OrganizationId: str,
    Marker: str = ...,
    Limit: int = ...,
) -> DescribeNotificationSubscriptionsResponseTypeDef:  # (1)
    ...

1. See DescribeNotificationSubscriptionsResponseTypeDef

# describe_notification_subscriptions method usage example with argument unpacking

kwargs: DescribeNotificationSubscriptionsRequestTypeDef = {  # (1)
    "OrganizationId": ...,
}

parent.describe_notification_subscriptions(**kwargs)

1. See DescribeNotificationSubscriptionsRequestTypeDef

describe_resource_permissions

Describes the permissions of a specified resource.

Type annotations and code completion for boto3.client("workdocs").describe_resource_permissions method. boto3 documentation

# describe_resource_permissions method definition

def describe_resource_permissions(
    self,
    *,
    ResourceId: str,
    AuthenticationToken: str = ...,
    PrincipalId: str = ...,
    Limit: int = ...,
    Marker: str = ...,
) -> DescribeResourcePermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeResourcePermissionsResponseTypeDef

# describe_resource_permissions method usage example with argument unpacking

kwargs: DescribeResourcePermissionsRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.describe_resource_permissions(**kwargs)

1. See DescribeResourcePermissionsRequestTypeDef

describe_root_folders

Describes the current user's special folders; the RootFolder and the RecycleBin.

Type annotations and code completion for boto3.client("workdocs").describe_root_folders method. boto3 documentation

# describe_root_folders method definition

def describe_root_folders(
    self,
    *,
    AuthenticationToken: str,
    Limit: int = ...,
    Marker: str = ...,
) -> DescribeRootFoldersResponseTypeDef:  # (1)
    ...

1. See DescribeRootFoldersResponseTypeDef

# describe_root_folders method usage example with argument unpacking

kwargs: DescribeRootFoldersRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.describe_root_folders(**kwargs)

1. See DescribeRootFoldersRequestTypeDef

describe_users

Describes the specified users.

Type annotations and code completion for boto3.client("workdocs").describe_users method. boto3 documentation

# describe_users method definition

def describe_users(
    self,
    *,
    AuthenticationToken: str = ...,
    OrganizationId: str = ...,
    UserIds: str = ...,
    Query: str = ...,
    Include: UserFilterTypeType = ...,  # (1)
    Order: OrderTypeType = ...,  # (2)
    Sort: UserSortTypeType = ...,  # (3)
    Marker: str = ...,
    Limit: int = ...,
    Fields: str = ...,
) -> DescribeUsersResponseTypeDef:  # (4)
    ...

1. See UserFilterTypeType
2. See OrderTypeType
3. See UserSortTypeType
4. See DescribeUsersResponseTypeDef

# describe_users method usage example with argument unpacking

kwargs: DescribeUsersRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.describe_users(**kwargs)

1. See DescribeUsersRequestTypeDef

get_current_user

Retrieves details of the current user for whom the authentication token was generated.

Type annotations and code completion for boto3.client("workdocs").get_current_user method. boto3 documentation

# get_current_user method definition

def get_current_user(
    self,
    *,
    AuthenticationToken: str,
) -> GetCurrentUserResponseTypeDef:  # (1)
    ...

1. See GetCurrentUserResponseTypeDef

# get_current_user method usage example with argument unpacking

kwargs: GetCurrentUserRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.get_current_user(**kwargs)

1. See GetCurrentUserRequestTypeDef

get_document

Retrieves details of a document.

Type annotations and code completion for boto3.client("workdocs").get_document method. boto3 documentation

# get_document method definition

def get_document(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
    IncludeCustomMetadata: bool = ...,
) -> GetDocumentResponseTypeDef:  # (1)
    ...

1. See GetDocumentResponseTypeDef

# get_document method usage example with argument unpacking

kwargs: GetDocumentRequestTypeDef = {  # (1)
    "DocumentId": ...,
}

parent.get_document(**kwargs)

1. See GetDocumentRequestTypeDef

get_document_path

Retrieves the path information (the hierarchy from the root folder) for the requested document.

Type annotations and code completion for boto3.client("workdocs").get_document_path method. boto3 documentation

# get_document_path method definition

def get_document_path(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
    Limit: int = ...,
    Fields: str = ...,
    Marker: str = ...,
) -> GetDocumentPathResponseTypeDef:  # (1)
    ...

1. See GetDocumentPathResponseTypeDef

# get_document_path method usage example with argument unpacking

kwargs: GetDocumentPathRequestTypeDef = {  # (1)
    "DocumentId": ...,
}

parent.get_document_path(**kwargs)

1. See GetDocumentPathRequestTypeDef

get_document_version

Retrieves version metadata for the specified document.

Type annotations and code completion for boto3.client("workdocs").get_document_version method. boto3 documentation

# get_document_version method definition

def get_document_version(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: str = ...,
    Fields: str = ...,
    IncludeCustomMetadata: bool = ...,
) -> GetDocumentVersionResponseTypeDef:  # (1)
    ...

1. See GetDocumentVersionResponseTypeDef

# get_document_version method usage example with argument unpacking

kwargs: GetDocumentVersionRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
}

parent.get_document_version(**kwargs)

1. See GetDocumentVersionRequestTypeDef

get_folder

Retrieves the metadata of the specified folder.

Type annotations and code completion for boto3.client("workdocs").get_folder method. boto3 documentation

# get_folder method definition

def get_folder(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
    IncludeCustomMetadata: bool = ...,
) -> GetFolderResponseTypeDef:  # (1)
    ...

1. See GetFolderResponseTypeDef

# get_folder method usage example with argument unpacking

kwargs: GetFolderRequestTypeDef = {  # (1)
    "FolderId": ...,
}

parent.get_folder(**kwargs)

1. See GetFolderRequestTypeDef

get_folder_path

Retrieves the path information (the hierarchy from the root folder) for the specified folder.

Type annotations and code completion for boto3.client("workdocs").get_folder_path method. boto3 documentation

# get_folder_path method definition

def get_folder_path(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
    Limit: int = ...,
    Fields: str = ...,
    Marker: str = ...,
) -> GetFolderPathResponseTypeDef:  # (1)
    ...

1. See GetFolderPathResponseTypeDef

# get_folder_path method usage example with argument unpacking

kwargs: GetFolderPathRequestTypeDef = {  # (1)
    "FolderId": ...,
}

parent.get_folder_path(**kwargs)

1. See GetFolderPathRequestTypeDef

get_resources

Retrieves a collection of resources, including folders and documents.

Type annotations and code completion for boto3.client("workdocs").get_resources method. boto3 documentation

# get_resources method definition

def get_resources(
    self,
    *,
    AuthenticationToken: str = ...,
    UserId: str = ...,
    CollectionType: ResourceCollectionTypeType = ...,  # (1)
    Limit: int = ...,
    Marker: str = ...,
) -> GetResourcesResponseTypeDef:  # (2)
    ...

1. See ResourceCollectionTypeType
2. See GetResourcesResponseTypeDef

# get_resources method usage example with argument unpacking

kwargs: GetResourcesRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.get_resources(**kwargs)

1. See GetResourcesRequestTypeDef

initiate_document_version_upload

Creates a new document object and version object.

Type annotations and code completion for boto3.client("workdocs").initiate_document_version_upload method. boto3 documentation

# initiate_document_version_upload method definition

def initiate_document_version_upload(
    self,
    *,
    AuthenticationToken: str = ...,
    Id: str = ...,
    Name: str = ...,
    ContentCreatedTimestamp: TimestampTypeDef = ...,
    ContentModifiedTimestamp: TimestampTypeDef = ...,
    ContentType: str = ...,
    DocumentSizeInBytes: int = ...,
    ParentFolderId: str = ...,
) -> InitiateDocumentVersionUploadResponseTypeDef:  # (1)
    ...

1. See InitiateDocumentVersionUploadResponseTypeDef

# initiate_document_version_upload method usage example with argument unpacking

kwargs: InitiateDocumentVersionUploadRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.initiate_document_version_upload(**kwargs)

1. See InitiateDocumentVersionUploadRequestTypeDef

remove_all_resource_permissions

Removes all the permissions from the specified resource.

Type annotations and code completion for boto3.client("workdocs").remove_all_resource_permissions method. boto3 documentation

# remove_all_resource_permissions method definition

def remove_all_resource_permissions(
    self,
    *,
    ResourceId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# remove_all_resource_permissions method usage example with argument unpacking

kwargs: RemoveAllResourcePermissionsRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.remove_all_resource_permissions(**kwargs)

1. See RemoveAllResourcePermissionsRequestTypeDef

remove_resource_permission

Removes the permission for the specified principal from the specified resource.

Type annotations and code completion for boto3.client("workdocs").remove_resource_permission method. boto3 documentation

# remove_resource_permission method definition

def remove_resource_permission(
    self,
    *,
    ResourceId: str,
    PrincipalId: str,
    AuthenticationToken: str = ...,
    PrincipalType: PrincipalTypeType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See PrincipalTypeType
2. See EmptyResponseMetadataTypeDef

# remove_resource_permission method usage example with argument unpacking

kwargs: RemoveResourcePermissionRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "PrincipalId": ...,
}

parent.remove_resource_permission(**kwargs)

1. See RemoveResourcePermissionRequestTypeDef

restore_document_versions

Recovers a deleted version of an Amazon WorkDocs document.

Type annotations and code completion for boto3.client("workdocs").restore_document_versions method. boto3 documentation

# restore_document_versions method definition

def restore_document_versions(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# restore_document_versions method usage example with argument unpacking

kwargs: RestoreDocumentVersionsRequestTypeDef = {  # (1)
    "DocumentId": ...,
}

parent.restore_document_versions(**kwargs)

1. See RestoreDocumentVersionsRequestTypeDef

search_resources

Searches metadata and the content of folders, documents, document versions, and comments.

Type annotations and code completion for boto3.client("workdocs").search_resources method. boto3 documentation

# search_resources method definition

def search_resources(
    self,
    *,
    AuthenticationToken: str = ...,
    QueryText: str = ...,
    QueryScopes: Sequence[SearchQueryScopeTypeType] = ...,  # (1)
    OrganizationId: str = ...,
    AdditionalResponseFields: Sequence[AdditionalResponseFieldTypeType] = ...,  # (2)
    Filters: FiltersTypeDef = ...,  # (3)
    OrderBy: Sequence[SearchSortResultTypeDef] = ...,  # (4)
    Limit: int = ...,
    Marker: str = ...,
) -> SearchResourcesResponseTypeDef:  # (5)
    ...

1. See Sequence[SearchQueryScopeTypeType]
2. See Sequence[Literal['WEBURL']]
3. See FiltersTypeDef
4. See Sequence[SearchSortResultTypeDef]
5. See SearchResourcesResponseTypeDef

# search_resources method usage example with argument unpacking

kwargs: SearchResourcesRequestTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

parent.search_resources(**kwargs)

1. See SearchResourcesRequestTypeDef

update_document

Updates the specified attributes of a document.

Type annotations and code completion for boto3.client("workdocs").update_document method. boto3 documentation

# update_document method definition

def update_document(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
    Name: str = ...,
    ParentFolderId: str = ...,
    ResourceState: ResourceStateTypeType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ResourceStateTypeType
2. See EmptyResponseMetadataTypeDef

# update_document method usage example with argument unpacking

kwargs: UpdateDocumentRequestTypeDef = {  # (1)
    "DocumentId": ...,
}

parent.update_document(**kwargs)

1. See UpdateDocumentRequestTypeDef

update_document_version

Changes the status of the document version to ACTIVE.

Type annotations and code completion for boto3.client("workdocs").update_document_version method. boto3 documentation

# update_document_version method definition

def update_document_version(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: str = ...,
    VersionStatus: DocumentVersionStatusType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See DocumentVersionStatusType
2. See EmptyResponseMetadataTypeDef

# update_document_version method usage example with argument unpacking

kwargs: UpdateDocumentVersionRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
}

parent.update_document_version(**kwargs)

1. See UpdateDocumentVersionRequestTypeDef

update_folder

Updates the specified attributes of the specified folder.

Type annotations and code completion for boto3.client("workdocs").update_folder method. boto3 documentation

# update_folder method definition

def update_folder(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
    Name: str = ...,
    ParentFolderId: str = ...,
    ResourceState: ResourceStateTypeType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ResourceStateTypeType
2. See EmptyResponseMetadataTypeDef

# update_folder method usage example with argument unpacking

kwargs: UpdateFolderRequestTypeDef = {  # (1)
    "FolderId": ...,
}

parent.update_folder(**kwargs)

1. See UpdateFolderRequestTypeDef

update_user

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Type annotations and code completion for boto3.client("workdocs").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    UserId: str,
    AuthenticationToken: str = ...,
    GivenName: str = ...,
    Surname: str = ...,
    Type: UserTypeType = ...,  # (1)
    StorageRule: StorageRuleTypeTypeDef = ...,  # (2)
    TimeZoneId: str = ...,
    Locale: LocaleTypeType = ...,  # (3)
    GrantPoweruserPrivileges: BooleanEnumTypeType = ...,  # (4)
) -> UpdateUserResponseTypeDef:  # (5)
    ...

1. See UserTypeType
2. See StorageRuleTypeTypeDef
3. See LocaleTypeType
4. See BooleanEnumTypeType
5. See UpdateUserResponseTypeDef

# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("workdocs").get_paginator method with overloads.

• client.get_paginator("describe_activities") -> DescribeActivitiesPaginator
• client.get_paginator("describe_comments") -> DescribeCommentsPaginator
• client.get_paginator("describe_document_versions") -> DescribeDocumentVersionsPaginator
• client.get_paginator("describe_folder_contents") -> DescribeFolderContentsPaginator
• client.get_paginator("describe_groups") -> DescribeGroupsPaginator
• client.get_paginator("describe_notification_subscriptions") -> DescribeNotificationSubscriptionsPaginator
• client.get_paginator("describe_resource_permissions") -> DescribeResourcePermissionsPaginator
• client.get_paginator("describe_root_folders") -> DescribeRootFoldersPaginator
• client.get_paginator("describe_users") -> DescribeUsersPaginator
• client.get_paginator("search_resources") -> SearchResourcesPaginator