Struct aws_sdk_workdocs::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for Amazon WorkDocs
Client for invoking operations on Amazon WorkDocs. Each operation on Amazon WorkDocs is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_workdocs::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_workdocs::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_workdocs::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn abort_document_version_upload(&self) -> AbortDocumentVersionUpload
pub fn abort_document_version_upload(&self) -> AbortDocumentVersionUpload
Constructs a fluent builder for the AbortDocumentVersionUpload
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The ID of the version.
- On success, responds with
AbortDocumentVersionUploadOutput
- On failure, responds with
SdkError<AbortDocumentVersionUploadError>
sourcepub fn activate_user(&self) -> ActivateUser
pub fn activate_user(&self) -> ActivateUser
Constructs a fluent builder for the ActivateUser
operation.
- The fluent builder is configurable:
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The ID of the user.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
- On success, responds with
ActivateUserOutput
with field(s):user(Option<User>)
:The user information.
- On failure, responds with
SdkError<ActivateUserError>
sourcepub fn add_resource_permissions(&self) -> AddResourcePermissions
pub fn add_resource_permissions(&self) -> AddResourcePermissions
Constructs a fluent builder for the AddResourcePermissions
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
principals(Vec<SharePrincipal>)
/set_principals(Option<Vec<SharePrincipal>>)
:The users, groups, or organization being granted permission.
notification_options(NotificationOptions)
/set_notification_options(Option<NotificationOptions>)
:The notification options.
- On success, responds with
AddResourcePermissionsOutput
with field(s):share_results(Option<Vec<ShareResult>>)
:The share results.
- On failure, responds with
SdkError<AddResourcePermissionsError>
sourcepub fn create_comment(&self) -> CreateComment
pub fn create_comment(&self) -> CreateComment
Constructs a fluent builder for the CreateComment
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The ID of the document version.
parent_id(impl Into<String>)
/set_parent_id(Option<String>)
:The ID of the parent comment.
thread_id(impl Into<String>)
/set_thread_id(Option<String>)
:The ID of the root comment in the thread.
text(impl Into<String>)
/set_text(Option<String>)
:The text of the comment.
visibility(CommentVisibilityType)
/set_visibility(Option<CommentVisibilityType>)
:The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
notify_collaborators(bool)
/set_notify_collaborators(bool)
:Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
- On success, responds with
CreateCommentOutput
with field(s):comment(Option<Comment>)
:The comment that has been created.
- On failure, responds with
SdkError<CreateCommentError>
sourcepub fn create_custom_metadata(&self) -> CreateCustomMetadata
pub fn create_custom_metadata(&self) -> CreateCustomMetadata
Constructs a fluent builder for the CreateCustomMetadata
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The ID of the version, if the custom metadata is being added to a document version.
custom_metadata(HashMap<String, String>)
/set_custom_metadata(Option<HashMap<String, String>>)
:Custom metadata in the form of name-value pairs.
- On success, responds with
CreateCustomMetadataOutput
- On failure, responds with
SdkError<CreateCustomMetadataError>
sourcepub fn create_folder(&self) -> CreateFolder
pub fn create_folder(&self) -> CreateFolder
Constructs a fluent builder for the CreateFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the new folder.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:The ID of the parent folder.
- On success, responds with
CreateFolderOutput
with field(s):metadata(Option<FolderMetadata>)
:The metadata of the folder.
- On failure, responds with
SdkError<CreateFolderError>
sourcepub fn create_labels(&self) -> CreateLabels
pub fn create_labels(&self) -> CreateLabels
Constructs a fluent builder for the CreateLabels
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
labels(Vec<String>)
/set_labels(Option<Vec<String>>)
:List of labels to add to the resource.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
- On success, responds with
CreateLabelsOutput
- On failure, responds with
SdkError<CreateLabelsError>
sourcepub fn create_notification_subscription(&self) -> CreateNotificationSubscription
pub fn create_notification_subscription(&self) -> CreateNotificationSubscription
Constructs a fluent builder for the CreateNotificationSubscription
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization.
endpoint(impl Into<String>)
/set_endpoint(Option<String>)
:The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with
https
.protocol(SubscriptionProtocolType)
/set_protocol(Option<SubscriptionProtocolType>)
:The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.
subscription_type(SubscriptionType)
/set_subscription_type(Option<SubscriptionType>)
:The notification type.
- On success, responds with
CreateNotificationSubscriptionOutput
with field(s):subscription(Option<Subscription>)
:The subscription.
- On failure, responds with
SdkError<CreateNotificationSubscriptionError>
sourcepub fn create_user(&self) -> CreateUser
pub fn create_user(&self) -> CreateUser
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization.
username(impl Into<String>)
/set_username(Option<String>)
:The login name of the user.
email_address(impl Into<String>)
/set_email_address(Option<String>)
:The email address of the user.
given_name(impl Into<String>)
/set_given_name(Option<String>)
:The given name of the user.
surname(impl Into<String>)
/set_surname(Option<String>)
:The surname of the user.
password(impl Into<String>)
/set_password(Option<String>)
:The password of the user.
time_zone_id(impl Into<String>)
/set_time_zone_id(Option<String>)
:The time zone ID of the user.
storage_rule(StorageRuleType)
/set_storage_rule(Option<StorageRuleType>)
:The amount of storage for the user.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
- On success, responds with
CreateUserOutput
with field(s):user(Option<User>)
:The user information.
- On failure, responds with
SdkError<CreateUserError>
sourcepub fn deactivate_user(&self) -> DeactivateUser
pub fn deactivate_user(&self) -> DeactivateUser
Constructs a fluent builder for the DeactivateUser
operation.
- The fluent builder is configurable:
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The ID of the user.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
- On success, responds with
DeactivateUserOutput
- On failure, responds with
SdkError<DeactivateUserError>
sourcepub fn delete_comment(&self) -> DeleteComment
pub fn delete_comment(&self) -> DeleteComment
Constructs a fluent builder for the DeleteComment
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The ID of the document version.
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:The ID of the comment.
- On success, responds with
DeleteCommentOutput
- On failure, responds with
SdkError<DeleteCommentError>
sourcepub fn delete_custom_metadata(&self) -> DeleteCustomMetadata
pub fn delete_custom_metadata(&self) -> DeleteCustomMetadata
Constructs a fluent builder for the DeleteCustomMetadata
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource, either a document or folder.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The ID of the version, if the custom metadata is being deleted from a document version.
keys(Vec<String>)
/set_keys(Option<Vec<String>>)
:List of properties to remove.
delete_all(bool)
/set_delete_all(bool)
:Flag to indicate removal of all custom metadata properties from the specified resource.
- On success, responds with
DeleteCustomMetadataOutput
- On failure, responds with
SdkError<DeleteCustomMetadataError>
sourcepub fn delete_document(&self) -> DeleteDocument
pub fn delete_document(&self) -> DeleteDocument
Constructs a fluent builder for the DeleteDocument
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
- On success, responds with
DeleteDocumentOutput
- On failure, responds with
SdkError<DeleteDocumentError>
sourcepub fn delete_folder(&self) -> DeleteFolder
pub fn delete_folder(&self) -> DeleteFolder
Constructs a fluent builder for the DeleteFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:The ID of the folder.
- On success, responds with
DeleteFolderOutput
- On failure, responds with
SdkError<DeleteFolderError>
sourcepub fn delete_folder_contents(&self) -> DeleteFolderContents
pub fn delete_folder_contents(&self) -> DeleteFolderContents
Constructs a fluent builder for the DeleteFolderContents
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:The ID of the folder.
- On success, responds with
DeleteFolderContentsOutput
- On failure, responds with
SdkError<DeleteFolderContentsError>
sourcepub fn delete_labels(&self) -> DeleteLabels
pub fn delete_labels(&self) -> DeleteLabels
Constructs a fluent builder for the DeleteLabels
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
labels(Vec<String>)
/set_labels(Option<Vec<String>>)
:List of labels to delete from the resource.
delete_all(bool)
/set_delete_all(bool)
:Flag to request removal of all labels from the specified resource.
- On success, responds with
DeleteLabelsOutput
- On failure, responds with
SdkError<DeleteLabelsError>
sourcepub fn delete_notification_subscription(&self) -> DeleteNotificationSubscription
pub fn delete_notification_subscription(&self) -> DeleteNotificationSubscription
Constructs a fluent builder for the DeleteNotificationSubscription
operation.
- The fluent builder is configurable:
subscription_id(impl Into<String>)
/set_subscription_id(Option<String>)
:The ID of the subscription.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization.
- On success, responds with
DeleteNotificationSubscriptionOutput
- On failure, responds with
SdkError<DeleteNotificationSubscriptionError>
sourcepub fn delete_user(&self) -> DeleteUser
pub fn delete_user(&self) -> DeleteUser
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The ID of the user.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
sourcepub fn describe_activities(&self) -> DescribeActivities
pub fn describe_activities(&self) -> DescribeActivities
Constructs a fluent builder for the DescribeActivities
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
activity_types(impl Into<String>)
/set_activity_types(Option<String>)
:Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The document or folder ID for which to describe activity types.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.
include_indirect_activities(bool)
/set_include_indirect_activities(bool)
:Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results.
- On success, responds with
DescribeActivitiesOutput
with field(s):user_activities(Option<Vec<Activity>>)
:The list of activities for the specified user and time period.
marker(Option<String>)
:The marker for the next set of results.
- On failure, responds with
SdkError<DescribeActivitiesError>
sourcepub fn describe_comments(&self) -> DescribeComments
pub fn describe_comments(&self) -> DescribeComments
Constructs a fluent builder for the DescribeComments
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The ID of the document version.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. This marker was received from a previous call.
- On success, responds with
DescribeCommentsOutput
with field(s):comments(Option<Vec<Comment>>)
:The list of comments for the specified document version.
marker(Option<String>)
:The marker for the next set of results. This marker was received from a previous call.
- On failure, responds with
SdkError<DescribeCommentsError>
sourcepub fn describe_document_versions(&self) -> DescribeDocumentVersions
pub fn describe_document_versions(&self) -> DescribeDocumentVersions
Constructs a fluent builder for the DescribeDocumentVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:The maximum number of versions to return with this call.
include(impl Into<String>)
/set_include(Option<String>)
:A comma-separated list of values. Specify “INITIALIZED” to include incomplete versions.
fields(impl Into<String>)
/set_fields(Option<String>)
:Specify “SOURCE” to include initialized versions and a URL for the source document.
- On success, responds with
DescribeDocumentVersionsOutput
with field(s):document_versions(Option<Vec<DocumentVersionMetadata>>)
:The document versions.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<DescribeDocumentVersionsError>
sourcepub fn describe_folder_contents(&self) -> DescribeFolderContents
pub fn describe_folder_contents(&self) -> DescribeFolderContents
Constructs a fluent builder for the DescribeFolderContents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:The ID of the folder.
sort(ResourceSortType)
/set_sort(Option<ResourceSortType>)
:The sorting criteria.
order(OrderType)
/set_order(Option<OrderType>)
:The order for the contents of the folder.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return with this call.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. This marker was received from a previous call.
r#type(FolderContentType)
/set_type(Option<FolderContentType>)
:The type of items.
include(impl Into<String>)
/set_include(Option<String>)
:The contents to include. Specify “INITIALIZED” to include initialized documents.
- On success, responds with
DescribeFolderContentsOutput
with field(s):folders(Option<Vec<FolderMetadata>>)
:The subfolders in the specified folder.
documents(Option<Vec<DocumentMetadata>>)
:The documents in the specified folder.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<DescribeFolderContentsError>
sourcepub fn describe_groups(&self) -> DescribeGroups
pub fn describe_groups(&self) -> DescribeGroups
Constructs a fluent builder for the DescribeGroups
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
search_query(impl Into<String>)
/set_search_query(Option<String>)
:A query to describe groups by group name.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return with this call.
- On success, responds with
DescribeGroupsOutput
with field(s):groups(Option<Vec<GroupMetadata>>)
:The list of groups.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<DescribeGroupsError>
sourcepub fn describe_notification_subscriptions(
&self
) -> DescribeNotificationSubscriptions
pub fn describe_notification_subscriptions(
&self
) -> DescribeNotificationSubscriptions
Constructs a fluent builder for the DescribeNotificationSubscriptions
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return with this call.
- On success, responds with
DescribeNotificationSubscriptionsOutput
with field(s):subscriptions(Option<Vec<Subscription>>)
:The subscriptions.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<DescribeNotificationSubscriptionsError>
sourcepub fn describe_resource_permissions(&self) -> DescribeResourcePermissions
pub fn describe_resource_permissions(&self) -> DescribeResourcePermissions
Constructs a fluent builder for the DescribeResourcePermissions
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:The ID of the principal to filter permissions by.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return with this call.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call)
- On success, responds with
DescribeResourcePermissionsOutput
with field(s):principals(Option<Vec<Principal>>)
:The principals.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<DescribeResourcePermissionsError>
sourcepub fn describe_root_folders(&self) -> DescribeRootFolders
pub fn describe_root_folders(&self) -> DescribeRootFolders
Constructs a fluent builder for the DescribeRootFolders
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
- On success, responds with
DescribeRootFoldersOutput
with field(s):folders(Option<Vec<FolderMetadata>>)
:The user’s special folders.
marker(Option<String>)
:The marker for the next set of results.
- On failure, responds with
SdkError<DescribeRootFoldersError>
sourcepub fn describe_users(&self) -> DescribeUsers
pub fn describe_users(&self) -> DescribeUsers
Constructs a fluent builder for the DescribeUsers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:The ID of the organization.
user_ids(impl Into<String>)
/set_user_ids(Option<String>)
:The IDs of the users.
query(impl Into<String>)
/set_query(Option<String>)
:A query to filter users by user name.
include(UserFilterType)
/set_include(Option<UserFilterType>)
:The state of the users. Specify “ALL” to include inactive users.
order(OrderType)
/set_order(Option<OrderType>)
:The order for the results.
sort(UserSortType)
/set_sort(Option<UserSortType>)
:The sorting criteria.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:The maximum number of items to return.
fields(impl Into<String>)
/set_fields(Option<String>)
:A comma-separated list of values. Specify “STORAGE_METADATA” to include the user storage quota and utilization information.
- On success, responds with
DescribeUsersOutput
with field(s):users(Option<Vec<User>>)
:The users.
total_number_of_users(Option<i64>)
:The total number of users included in the results.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<DescribeUsersError>
sourcepub fn get_current_user(&self) -> GetCurrentUser
pub fn get_current_user(&self) -> GetCurrentUser
Constructs a fluent builder for the GetCurrentUser
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token.
- On success, responds with
GetCurrentUserOutput
with field(s):user(Option<User>)
:Metadata of the user.
- On failure, responds with
SdkError<GetCurrentUserError>
sourcepub fn get_document(&self) -> GetDocument
pub fn get_document(&self) -> GetDocument
Constructs a fluent builder for the GetDocument
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
include_custom_metadata(bool)
/set_include_custom_metadata(bool)
:Set this to
TRUE
to include custom metadata in the response.
- On success, responds with
GetDocumentOutput
with field(s):metadata(Option<DocumentMetadata>)
:The metadata details of the document.
custom_metadata(Option<HashMap<String, String>>)
:The custom metadata on the document.
- On failure, responds with
SdkError<GetDocumentError>
sourcepub fn get_document_path(&self) -> GetDocumentPath
pub fn get_document_path(&self) -> GetDocumentPath
Constructs a fluent builder for the GetDocumentPath
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of levels in the hierarchy to return.
fields(impl Into<String>)
/set_fields(Option<String>)
:A comma-separated list of values. Specify
NAME
to include the names of the parent folders.marker(impl Into<String>)
/set_marker(Option<String>)
:This value is not supported.
- On success, responds with
GetDocumentPathOutput
with field(s):path(Option<ResourcePath>)
:The path information.
- On failure, responds with
SdkError<GetDocumentPathError>
sourcepub fn get_document_version(&self) -> GetDocumentVersion
pub fn get_document_version(&self) -> GetDocumentVersion
Constructs a fluent builder for the GetDocumentVersion
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The version ID of the document.
fields(impl Into<String>)
/set_fields(Option<String>)
:A comma-separated list of values. Specify “SOURCE” to include a URL for the source document.
include_custom_metadata(bool)
/set_include_custom_metadata(bool)
:Set this to TRUE to include custom metadata in the response.
- On success, responds with
GetDocumentVersionOutput
with field(s):metadata(Option<DocumentVersionMetadata>)
:The version metadata.
custom_metadata(Option<HashMap<String, String>>)
:The custom metadata on the document version.
- On failure, responds with
SdkError<GetDocumentVersionError>
sourcepub fn get_folder(&self) -> GetFolder
pub fn get_folder(&self) -> GetFolder
Constructs a fluent builder for the GetFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:The ID of the folder.
include_custom_metadata(bool)
/set_include_custom_metadata(bool)
:Set to TRUE to include custom metadata in the response.
- On success, responds with
GetFolderOutput
with field(s):metadata(Option<FolderMetadata>)
:The metadata of the folder.
custom_metadata(Option<HashMap<String, String>>)
:The custom metadata on the folder.
- On failure, responds with
SdkError<GetFolderError>
sourcepub fn get_folder_path(&self) -> GetFolderPath
pub fn get_folder_path(&self) -> GetFolderPath
Constructs a fluent builder for the GetFolderPath
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:The ID of the folder.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of levels in the hierarchy to return.
fields(impl Into<String>)
/set_fields(Option<String>)
:A comma-separated list of values. Specify “NAME” to include the names of the parent folders.
marker(impl Into<String>)
/set_marker(Option<String>)
:This value is not supported.
- On success, responds with
GetFolderPathOutput
with field(s):path(Option<ResourcePath>)
:The path information.
- On failure, responds with
SdkError<GetFolderPathError>
sourcepub fn get_resources(&self) -> GetResources
pub fn get_resources(&self) -> GetResources
Constructs a fluent builder for the GetResources
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.
collection_type(ResourceCollectionType)
/set_collection_type(Option<ResourceCollectionType>)
:The collection type.
limit(i32)
/set_limit(Option<i32>)
:The maximum number of resources to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results. This marker was received from a previous call.
- On success, responds with
GetResourcesOutput
with field(s):folders(Option<Vec<FolderMetadata>>)
:The folders in the specified folder.
documents(Option<Vec<DocumentMetadata>>)
:The documents in the specified collection.
marker(Option<String>)
:The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
- On failure, responds with
SdkError<GetResourcesError>
sourcepub fn initiate_document_version_upload(&self) -> InitiateDocumentVersionUpload
pub fn initiate_document_version_upload(&self) -> InitiateDocumentVersionUpload
Constructs a fluent builder for the InitiateDocumentVersionUpload
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the document.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the document.
content_created_timestamp(DateTime)
/set_content_created_timestamp(Option<DateTime>)
:The timestamp when the content of the document was originally created.
content_modified_timestamp(DateTime)
/set_content_modified_timestamp(Option<DateTime>)
:The timestamp when the content of the document was modified.
content_type(impl Into<String>)
/set_content_type(Option<String>)
:The content type of the document.
document_size_in_bytes(i64)
/set_document_size_in_bytes(Option<i64>)
:The size of the document, in bytes.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:The ID of the parent folder.
- On success, responds with
InitiateDocumentVersionUploadOutput
with field(s):metadata(Option<DocumentMetadata>)
:The document metadata.
upload_metadata(Option<UploadMetadata>)
:The upload metadata.
- On failure, responds with
SdkError<InitiateDocumentVersionUploadError>
sourcepub fn remove_all_resource_permissions(&self) -> RemoveAllResourcePermissions
pub fn remove_all_resource_permissions(&self) -> RemoveAllResourcePermissions
Constructs a fluent builder for the RemoveAllResourcePermissions
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
- On success, responds with
RemoveAllResourcePermissionsOutput
- On failure, responds with
SdkError<RemoveAllResourcePermissionsError>
sourcepub fn remove_resource_permission(&self) -> RemoveResourcePermission
pub fn remove_resource_permission(&self) -> RemoveResourcePermission
Constructs a fluent builder for the RemoveResourcePermission
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:The ID of the resource.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:The principal ID of the resource.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:The principal type of the resource.
- On success, responds with
RemoveResourcePermissionOutput
- On failure, responds with
SdkError<RemoveResourcePermissionError>
sourcepub fn update_document(&self) -> UpdateDocument
pub fn update_document(&self) -> UpdateDocument
Constructs a fluent builder for the UpdateDocument
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the document.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:The ID of the parent folder.
resource_state(ResourceStateType)
/set_resource_state(Option<ResourceStateType>)
:The resource state of the document. Only ACTIVE and RECYCLED are supported.
- On success, responds with
UpdateDocumentOutput
- On failure, responds with
SdkError<UpdateDocumentError>
sourcepub fn update_document_version(&self) -> UpdateDocumentVersion
pub fn update_document_version(&self) -> UpdateDocumentVersion
Constructs a fluent builder for the UpdateDocumentVersion
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:The ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:The version ID of the document.
version_status(DocumentVersionStatus)
/set_version_status(Option<DocumentVersionStatus>)
:The status of the version.
- On success, responds with
UpdateDocumentVersionOutput
- On failure, responds with
SdkError<UpdateDocumentVersionError>
sourcepub fn update_folder(&self) -> UpdateFolder
pub fn update_folder(&self) -> UpdateFolder
Constructs a fluent builder for the UpdateFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:The ID of the folder.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the folder.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:The ID of the parent folder.
resource_state(ResourceStateType)
/set_resource_state(Option<ResourceStateType>)
:The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.
- On success, responds with
UpdateFolderOutput
- On failure, responds with
SdkError<UpdateFolderError>
sourcepub fn update_user(&self) -> UpdateUser
pub fn update_user(&self) -> UpdateUser
Constructs a fluent builder for the UpdateUser
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:The ID of the user.
given_name(impl Into<String>)
/set_given_name(Option<String>)
:The given name of the user.
surname(impl Into<String>)
/set_surname(Option<String>)
:The surname of the user.
r#type(UserType)
/set_type(Option<UserType>)
:The type of the user.
storage_rule(StorageRuleType)
/set_storage_rule(Option<StorageRuleType>)
:The amount of storage for the user.
time_zone_id(impl Into<String>)
/set_time_zone_id(Option<String>)
:The time zone ID of the user.
locale(LocaleType)
/set_locale(Option<LocaleType>)
:The locale of the user.
grant_poweruser_privileges(BooleanEnumType)
/set_grant_poweruser_privileges(Option<BooleanEnumType>)
:Boolean value to determine whether the user is granted Poweruser privileges.
- On success, responds with
UpdateUserOutput
with field(s):user(Option<User>)
:The user information.
- On failure, responds with
SdkError<UpdateUserError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more