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)
...
# abort_document_version_upload method usage example with argument unpacking
kwargs: AbortDocumentVersionUploadRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
}
parent.abort_document_version_upload(**kwargs)
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)
...
# activate_user method usage example with argument unpacking
kwargs: ActivateUserRequestRequestTypeDef = { # (1)
"UserId": ...,
}
parent.activate_user(**kwargs)
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)
...
# add_resource_permissions method usage example with argument unpacking
kwargs: AddResourcePermissionsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Principals": ...,
}
parent.add_resource_permissions(**kwargs)
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)
...
# create_comment method usage example with argument unpacking
kwargs: CreateCommentRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
"Text": ...,
}
parent.create_comment(**kwargs)
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)
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)
...
# create_folder method usage example with argument unpacking
kwargs: CreateFolderRequestRequestTypeDef = { # (1)
"ParentFolderId": ...,
}
parent.create_folder(**kwargs)
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: CreateLabelsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"Labels": ...,
}
parent.create_labels(**kwargs)
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)
...
- See SubscriptionProtocolTypeType
- See SubscriptionTypeType
- See CreateNotificationSubscriptionResponseTypeDef
# create_notification_subscription method usage example with argument unpacking
kwargs: CreateNotificationSubscriptionRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
"Endpoint": ...,
"Protocol": ...,
"SubscriptionType": ...,
}
parent.create_notification_subscription(**kwargs)
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)
...
# create_user method usage example with argument unpacking
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"Username": ...,
"GivenName": ...,
"Surname": ...,
"Password": ...,
}
parent.create_user(**kwargs)
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)
...
# deactivate_user method usage example with argument unpacking
kwargs: DeactivateUserRequestRequestTypeDef = { # (1)
"UserId": ...,
}
parent.deactivate_user(**kwargs)
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)
...
# delete_comment method usage example with argument unpacking
kwargs: DeleteCommentRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
"CommentId": ...,
}
parent.delete_comment(**kwargs)
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: DeleteCustomMetadataRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.delete_custom_metadata(**kwargs)
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)
...
# delete_document method usage example with argument unpacking
kwargs: DeleteDocumentRequestRequestTypeDef = { # (1)
"DocumentId": ...,
}
parent.delete_document(**kwargs)
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)
...
# delete_document_version method usage example with argument unpacking
kwargs: DeleteDocumentVersionRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
"DeletePriorVersions": ...,
}
parent.delete_document_version(**kwargs)
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)
...
# delete_folder method usage example with argument unpacking
kwargs: DeleteFolderRequestRequestTypeDef = { # (1)
"FolderId": ...,
}
parent.delete_folder(**kwargs)
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)
...
# delete_folder_contents method usage example with argument unpacking
kwargs: DeleteFolderContentsRequestRequestTypeDef = { # (1)
"FolderId": ...,
}
parent.delete_folder_contents(**kwargs)
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: DeleteLabelsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.delete_labels(**kwargs)
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)
...
# delete_notification_subscription method usage example with argument unpacking
kwargs: DeleteNotificationSubscriptionRequestRequestTypeDef = { # (1)
"SubscriptionId": ...,
"OrganizationId": ...,
}
parent.delete_notification_subscription(**kwargs)
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)
...
# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserId": ...,
}
parent.delete_user(**kwargs)
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)
...
# describe_activities method usage example with argument unpacking
kwargs: DescribeActivitiesRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.describe_activities(**kwargs)
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)
...
# describe_comments method usage example with argument unpacking
kwargs: DescribeCommentsRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
}
parent.describe_comments(**kwargs)
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)
...
# describe_document_versions method usage example with argument unpacking
kwargs: DescribeDocumentVersionsRequestRequestTypeDef = { # (1)
"DocumentId": ...,
}
parent.describe_document_versions(**kwargs)
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)
...
- See ResourceSortTypeType
- See OrderTypeType
- See FolderContentTypeType
- See DescribeFolderContentsResponseTypeDef
# describe_folder_contents method usage example with argument unpacking
kwargs: DescribeFolderContentsRequestRequestTypeDef = { # (1)
"FolderId": ...,
}
parent.describe_folder_contents(**kwargs)
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)
...
# describe_groups method usage example with argument unpacking
kwargs: DescribeGroupsRequestRequestTypeDef = { # (1)
"SearchQuery": ...,
}
parent.describe_groups(**kwargs)
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)
...
# describe_notification_subscriptions method usage example with argument unpacking
kwargs: DescribeNotificationSubscriptionsRequestRequestTypeDef = { # (1)
"OrganizationId": ...,
}
parent.describe_notification_subscriptions(**kwargs)
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)
...
# describe_resource_permissions method usage example with argument unpacking
kwargs: DescribeResourcePermissionsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.describe_resource_permissions(**kwargs)
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)
...
# describe_root_folders method usage example with argument unpacking
kwargs: DescribeRootFoldersRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.describe_root_folders(**kwargs)
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)
...
- See UserFilterTypeType
- See OrderTypeType
- See UserSortTypeType
- See DescribeUsersResponseTypeDef
# describe_users method usage example with argument unpacking
kwargs: DescribeUsersRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.describe_users(**kwargs)
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)
...
# get_current_user method usage example with argument unpacking
kwargs: GetCurrentUserRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.get_current_user(**kwargs)
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)
...
# get_document method usage example with argument unpacking
kwargs: GetDocumentRequestRequestTypeDef = { # (1)
"DocumentId": ...,
}
parent.get_document(**kwargs)
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)
...
# get_document_path method usage example with argument unpacking
kwargs: GetDocumentPathRequestRequestTypeDef = { # (1)
"DocumentId": ...,
}
parent.get_document_path(**kwargs)
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)
...
# get_document_version method usage example with argument unpacking
kwargs: GetDocumentVersionRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
}
parent.get_document_version(**kwargs)
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)
...
# get_folder method usage example with argument unpacking
kwargs: GetFolderRequestRequestTypeDef = { # (1)
"FolderId": ...,
}
parent.get_folder(**kwargs)
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)
...
# get_folder_path method usage example with argument unpacking
kwargs: GetFolderPathRequestRequestTypeDef = { # (1)
"FolderId": ...,
}
parent.get_folder_path(**kwargs)
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)
...
# get_resources method usage example with argument unpacking
kwargs: GetResourcesRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.get_resources(**kwargs)
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)
...
# initiate_document_version_upload method usage example with argument unpacking
kwargs: InitiateDocumentVersionUploadRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.initiate_document_version_upload(**kwargs)
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)
...
# remove_all_resource_permissions method usage example with argument unpacking
kwargs: RemoveAllResourcePermissionsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.remove_all_resource_permissions(**kwargs)
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)
...
# remove_resource_permission method usage example with argument unpacking
kwargs: RemoveResourcePermissionRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"PrincipalId": ...,
}
parent.remove_resource_permission(**kwargs)
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)
...
# restore_document_versions method usage example with argument unpacking
kwargs: RestoreDocumentVersionsRequestRequestTypeDef = { # (1)
"DocumentId": ...,
}
parent.restore_document_versions(**kwargs)
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)
...
- See SearchQueryScopeTypeType
- See AdditionalResponseFieldTypeType
- See FiltersTypeDef
- See SearchSortResultTypeDef
- See SearchResourcesResponseTypeDef
# search_resources method usage example with argument unpacking
kwargs: SearchResourcesRequestRequestTypeDef = { # (1)
"AuthenticationToken": ...,
}
parent.search_resources(**kwargs)
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)
...
# update_document method usage example with argument unpacking
kwargs: UpdateDocumentRequestRequestTypeDef = { # (1)
"DocumentId": ...,
}
parent.update_document(**kwargs)
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)
...
# update_document_version method usage example with argument unpacking
kwargs: UpdateDocumentVersionRequestRequestTypeDef = { # (1)
"DocumentId": ...,
"VersionId": ...,
}
parent.update_document_version(**kwargs)
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)
...
# update_folder method usage example with argument unpacking
kwargs: UpdateFolderRequestRequestTypeDef = { # (1)
"FolderId": ...,
}
parent.update_folder(**kwargs)
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)
...
- See UserTypeType
- See StorageRuleTypeTypeDef
- See LocaleTypeType
- See BooleanEnumTypeType
- See UpdateUserResponseTypeDef
# update_user method usage example with argument unpacking
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"UserId": ...,
}
parent.update_user(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("workdocs").get_paginator
method with overloads.
client.get_paginator("describe_activities")
-> DescribeActivitiesPaginatorclient.get_paginator("describe_comments")
-> DescribeCommentsPaginatorclient.get_paginator("describe_document_versions")
-> DescribeDocumentVersionsPaginatorclient.get_paginator("describe_folder_contents")
-> DescribeFolderContentsPaginatorclient.get_paginator("describe_groups")
-> DescribeGroupsPaginatorclient.get_paginator("describe_notification_subscriptions")
-> DescribeNotificationSubscriptionsPaginatorclient.get_paginator("describe_resource_permissions")
-> DescribeResourcePermissionsPaginatorclient.get_paginator("describe_root_folders")
-> DescribeRootFoldersPaginatorclient.get_paginator("describe_users")
-> DescribeUsersPaginatorclient.get_paginator("search_resources")
-> SearchResourcesPaginator