Skip to content

WorkDocsClient#

Index > WorkDocs > WorkDocsClient

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

WorkDocsClient#

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

# WorkDocsClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_workdocs.client import Exceptions

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

Methods#

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: AbortDocumentVersionUploadRequestRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
}

parent.abort_document_version_upload(**kwargs)
  1. See AbortDocumentVersionUploadRequestRequestTypeDef

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: ActivateUserRequestRequestTypeDef = {  # (1)
    "UserId": ...,
}

parent.activate_user(**kwargs)
  1. See ActivateUserRequestRequestTypeDef

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 SharePrincipalTypeDef
  2. See NotificationOptionsTypeDef
  3. See AddResourcePermissionsResponseTypeDef
# add_resource_permissions method usage example with argument unpacking

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

parent.add_resource_permissions(**kwargs)
  1. See AddResourcePermissionsRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: CreateCommentRequestRequestTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
    "Text": ...,
}

parent.create_comment(**kwargs)
  1. See CreateCommentRequestRequestTypeDef

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: CreateCustomMetadataRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "CustomMetadata": ...,
}

parent.create_custom_metadata(**kwargs)
  1. See CreateCustomMetadataRequestRequestTypeDef

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: CreateFolderRequestRequestTypeDef = {  # (1)
    "ParentFolderId": ...,
}

parent.create_folder(**kwargs)
  1. See CreateFolderRequestRequestTypeDef

create_labels#

Adds the specified list of labels to the given resource (a document or folder) See also: AWS API Documentation.

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: CreateLabelsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "Labels": ...,
}

parent.create_labels(**kwargs)
  1. See CreateLabelsRequestRequestTypeDef

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: CreateNotificationSubscriptionRequestRequestTypeDef = {  # (1)
    "OrganizationId": ...,
    "Endpoint": ...,
    "Protocol": ...,
    "SubscriptionType": ...,
}

parent.create_notification_subscription(**kwargs)
  1. See CreateNotificationSubscriptionRequestRequestTypeDef

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