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.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_workdocs::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_workdocs::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AbortDocumentVersionUpload
operation has
a Client::abort_document_version_upload
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.abort_document_version_upload()
.authentication_token("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn abort_document_version_upload(
&self,
) -> AbortDocumentVersionUploadFluentBuilder
pub fn abort_document_version_upload( &self, ) -> AbortDocumentVersionUploadFluentBuilder
Constructs a fluent builder for the AbortDocumentVersionUpload
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe ID of the version.
- On success, responds with
AbortDocumentVersionUploadOutput
- On failure, responds with
SdkError<AbortDocumentVersionUploadError>
Source§impl Client
impl Client
Sourcepub fn activate_user(&self) -> ActivateUserFluentBuilder
pub fn activate_user(&self) -> ActivateUserFluentBuilder
Constructs a fluent builder for the ActivateUser
operation.
- The fluent builder is configurable:
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe ID of the user.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services 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>
Source§impl Client
impl Client
Sourcepub fn add_resource_permissions(&self) -> AddResourcePermissionsFluentBuilder
pub fn add_resource_permissions(&self) -> AddResourcePermissionsFluentBuilder
Constructs a fluent builder for the AddResourcePermissions
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
principals(SharePrincipal)
/set_principals(Option<Vec::<SharePrincipal>>)
:
required: trueThe users, groups, or organization being granted permission.
notification_options(NotificationOptions)
/set_notification_options(Option<NotificationOptions>)
:
required: falseThe notification options.
- On success, responds with
AddResourcePermissionsOutput
with field(s):share_results(Option<Vec::<ShareResult>>)
:The share results.
- On failure, responds with
SdkError<AddResourcePermissionsError>
Source§impl Client
impl Client
Sourcepub fn create_comment(&self) -> CreateCommentFluentBuilder
pub fn create_comment(&self) -> CreateCommentFluentBuilder
Constructs a fluent builder for the CreateComment
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe ID of the document version.
parent_id(impl Into<String>)
/set_parent_id(Option<String>)
:
required: falseThe ID of the parent comment.
thread_id(impl Into<String>)
/set_thread_id(Option<String>)
:
required: falseThe ID of the root comment in the thread.
text(impl Into<String>)
/set_text(Option<String>)
:
required: trueThe text of the comment.
visibility(CommentVisibilityType)
/set_visibility(Option<CommentVisibilityType>)
:
required: falseThe 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(Option<bool>)
:
required: falseSet 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>
Source§impl Client
impl Client
Sourcepub fn create_custom_metadata(&self) -> CreateCustomMetadataFluentBuilder
pub fn create_custom_metadata(&self) -> CreateCustomMetadataFluentBuilder
Constructs a fluent builder for the CreateCustomMetadata
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: falseThe ID of the version, if the custom metadata is being added to a document version.
custom_metadata(impl Into<String>, impl Into<String>)
/set_custom_metadata(Option<HashMap::<String, String>>)
:
required: trueCustom metadata in the form of name-value pairs.
- On success, responds with
CreateCustomMetadataOutput
- On failure, responds with
SdkError<CreateCustomMetadataError>
Source§impl Client
impl Client
Sourcepub fn create_folder(&self) -> CreateFolderFluentBuilder
pub fn create_folder(&self) -> CreateFolderFluentBuilder
Constructs a fluent builder for the CreateFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the new folder.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn create_labels(&self) -> CreateLabelsFluentBuilder
pub fn create_labels(&self) -> CreateLabelsFluentBuilder
Constructs a fluent builder for the CreateLabels
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
labels(impl Into<String>)
/set_labels(Option<Vec::<String>>)
:
required: trueList of labels to add to the resource.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
- On success, responds with
CreateLabelsOutput
- On failure, responds with
SdkError<CreateLabelsError>
Source§impl Client
impl Client
Sourcepub fn create_notification_subscription(
&self,
) -> CreateNotificationSubscriptionFluentBuilder
pub fn create_notification_subscription( &self, ) -> CreateNotificationSubscriptionFluentBuilder
Constructs a fluent builder for the CreateNotificationSubscription
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: trueThe ID of the organization.
endpoint(impl Into<String>)
/set_endpoint(Option<String>)
:
required: trueThe 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>)
:
required: trueThe protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.
subscription_type(SubscriptionType)
/set_subscription_type(Option<SubscriptionType>)
:
required: trueThe notification type.
- On success, responds with
CreateNotificationSubscriptionOutput
with field(s):subscription(Option<Subscription>)
:The subscription.
- On failure, responds with
SdkError<CreateNotificationSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn create_user(&self) -> CreateUserFluentBuilder
pub fn create_user(&self) -> CreateUserFluentBuilder
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: falseThe ID of the organization.
username(impl Into<String>)
/set_username(Option<String>)
:
required: trueThe login name of the user.
email_address(impl Into<String>)
/set_email_address(Option<String>)
:
required: falseThe email address of the user.
given_name(impl Into<String>)
/set_given_name(Option<String>)
:
required: trueThe given name of the user.
surname(impl Into<String>)
/set_surname(Option<String>)
:
required: trueThe surname of the user.
password(impl Into<String>)
/set_password(Option<String>)
:
required: trueThe password of the user.
time_zone_id(impl Into<String>)
/set_time_zone_id(Option<String>)
:
required: falseThe time zone ID of the user.
storage_rule(StorageRuleType)
/set_storage_rule(Option<StorageRuleType>)
:
required: falseThe amount of storage for the user.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services 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>
Source§impl Client
impl Client
Sourcepub fn deactivate_user(&self) -> DeactivateUserFluentBuilder
pub fn deactivate_user(&self) -> DeactivateUserFluentBuilder
Constructs a fluent builder for the DeactivateUser
operation.
- The fluent builder is configurable:
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe ID of the user.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
- On success, responds with
DeactivateUserOutput
- On failure, responds with
SdkError<DeactivateUserError>
Source§impl Client
impl Client
Sourcepub fn delete_comment(&self) -> DeleteCommentFluentBuilder
pub fn delete_comment(&self) -> DeleteCommentFluentBuilder
Constructs a fluent builder for the DeleteComment
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe ID of the document version.
comment_id(impl Into<String>)
/set_comment_id(Option<String>)
:
required: trueThe ID of the comment.
- On success, responds with
DeleteCommentOutput
- On failure, responds with
SdkError<DeleteCommentError>
Source§impl Client
impl Client
Sourcepub fn delete_custom_metadata(&self) -> DeleteCustomMetadataFluentBuilder
pub fn delete_custom_metadata(&self) -> DeleteCustomMetadataFluentBuilder
Constructs a fluent builder for the DeleteCustomMetadata
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource, either a document or folder.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: falseThe ID of the version, if the custom metadata is being deleted from a document version.
keys(impl Into<String>)
/set_keys(Option<Vec::<String>>)
:
required: falseList of properties to remove.
delete_all(bool)
/set_delete_all(Option<bool>)
:
required: falseFlag to indicate removal of all custom metadata properties from the specified resource.
- On success, responds with
DeleteCustomMetadataOutput
- On failure, responds with
SdkError<DeleteCustomMetadataError>
Source§impl Client
impl Client
Sourcepub fn delete_document(&self) -> DeleteDocumentFluentBuilder
pub fn delete_document(&self) -> DeleteDocumentFluentBuilder
Constructs a fluent builder for the DeleteDocument
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
- On success, responds with
DeleteDocumentOutput
- On failure, responds with
SdkError<DeleteDocumentError>
Source§impl Client
impl Client
Sourcepub fn delete_document_version(&self) -> DeleteDocumentVersionFluentBuilder
pub fn delete_document_version(&self) -> DeleteDocumentVersionFluentBuilder
Constructs a fluent builder for the DeleteDocumentVersion
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document associated with the version being deleted.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe ID of the version being deleted.
delete_prior_versions(bool)
/set_delete_prior_versions(Option<bool>)
:
required: trueDeletes all versions of a document prior to the current version.
- On success, responds with
DeleteDocumentVersionOutput
- On failure, responds with
SdkError<DeleteDocumentVersionError>
Source§impl Client
impl Client
Sourcepub fn delete_folder(&self) -> DeleteFolderFluentBuilder
pub fn delete_folder(&self) -> DeleteFolderFluentBuilder
Constructs a fluent builder for the DeleteFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:
required: trueThe ID of the folder.
- On success, responds with
DeleteFolderOutput
- On failure, responds with
SdkError<DeleteFolderError>
Source§impl Client
impl Client
Sourcepub fn delete_folder_contents(&self) -> DeleteFolderContentsFluentBuilder
pub fn delete_folder_contents(&self) -> DeleteFolderContentsFluentBuilder
Constructs a fluent builder for the DeleteFolderContents
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:
required: trueThe ID of the folder.
- On success, responds with
DeleteFolderContentsOutput
- On failure, responds with
SdkError<DeleteFolderContentsError>
Source§impl Client
impl Client
Sourcepub fn delete_labels(&self) -> DeleteLabelsFluentBuilder
pub fn delete_labels(&self) -> DeleteLabelsFluentBuilder
Constructs a fluent builder for the DeleteLabels
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
labels(impl Into<String>)
/set_labels(Option<Vec::<String>>)
:
required: falseList of labels to delete from the resource.
delete_all(bool)
/set_delete_all(Option<bool>)
:
required: falseFlag to request removal of all labels from the specified resource.
- On success, responds with
DeleteLabelsOutput
- On failure, responds with
SdkError<DeleteLabelsError>
Source§impl Client
impl Client
Sourcepub fn delete_notification_subscription(
&self,
) -> DeleteNotificationSubscriptionFluentBuilder
pub fn delete_notification_subscription( &self, ) -> DeleteNotificationSubscriptionFluentBuilder
Constructs a fluent builder for the DeleteNotificationSubscription
operation.
- The fluent builder is configurable:
subscription_id(impl Into<String>)
/set_subscription_id(Option<String>)
:
required: trueThe ID of the subscription.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: trueThe ID of the organization.
- On success, responds with
DeleteNotificationSubscriptionOutput
- On failure, responds with
SdkError<DeleteNotificationSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn delete_user(&self) -> DeleteUserFluentBuilder
pub fn delete_user(&self) -> DeleteUserFluentBuilder
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon Web Services credentials.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe ID of the user.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
Source§impl Client
impl Client
Sourcepub fn describe_activities(&self) -> DescribeActivitiesFluentBuilder
pub fn describe_activities(&self) -> DescribeActivitiesFluentBuilder
Constructs a fluent builder for the DescribeActivities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseSpecifies 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>)
:
required: falseThe document or folder ID for which to describe activity types.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe 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(Option<bool>)
:
required: falseIncludes 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>)
:
required: falseThe maximum number of items to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_comments(&self) -> DescribeCommentsFluentBuilder
pub fn describe_comments(&self) -> DescribeCommentsFluentBuilder
Constructs a fluent builder for the DescribeComments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe ID of the document version.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of items to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_document_versions(
&self,
) -> DescribeDocumentVersionsFluentBuilder
pub fn describe_document_versions( &self, ) -> DescribeDocumentVersionsFluentBuilder
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>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of versions to return with this call.
include(impl Into<String>)
/set_include(Option<String>)
:
required: falseA comma-separated list of values. Specify “INITIALIZED” to include incomplete versions.
fields(impl Into<String>)
/set_fields(Option<String>)
:
required: falseSpecify “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>
Source§impl Client
impl Client
Sourcepub fn describe_folder_contents(&self) -> DescribeFolderContentsFluentBuilder
pub fn describe_folder_contents(&self) -> DescribeFolderContentsFluentBuilder
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>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:
required: trueThe ID of the folder.
sort(ResourceSortType)
/set_sort(Option<ResourceSortType>)
:
required: falseThe sorting criteria.
order(OrderType)
/set_order(Option<OrderType>)
:
required: falseThe order for the contents of the folder.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of items to return with this call.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe marker for the next set of results. This marker was received from a previous call.
r#type(FolderContentType)
/set_type(Option<FolderContentType>)
:
required: falseThe type of items.
include(impl Into<String>)
/set_include(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_groups(&self) -> DescribeGroupsFluentBuilder
pub fn describe_groups(&self) -> DescribeGroupsFluentBuilder
Constructs a fluent builder for the DescribeGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
search_query(impl Into<String>)
/set_search_query(Option<String>)
:
required: trueA query to describe groups by group name.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: falseThe ID of the organization.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_notification_subscriptions(
&self,
) -> DescribeNotificationSubscriptionsFluentBuilder
pub fn describe_notification_subscriptions( &self, ) -> DescribeNotificationSubscriptionsFluentBuilder
Constructs a fluent builder for the DescribeNotificationSubscriptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: trueThe ID of the organization.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_resource_permissions(
&self,
) -> DescribeResourcePermissionsFluentBuilder
pub fn describe_resource_permissions( &self, ) -> DescribeResourcePermissionsFluentBuilder
Constructs a fluent builder for the DescribeResourcePermissions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: falseThe ID of the principal to filter permissions by.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of items to return with this call.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_root_folders(&self) -> DescribeRootFoldersFluentBuilder
pub fn describe_root_folders(&self) -> DescribeRootFoldersFluentBuilder
Constructs a fluent builder for the DescribeRootFolders
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: trueAmazon WorkDocs authentication token.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of items to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn describe_users(&self) -> DescribeUsersFluentBuilder
pub fn describe_users(&self) -> DescribeUsersFluentBuilder
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>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: falseThe ID of the organization.
user_ids(impl Into<String>)
/set_user_ids(Option<String>)
:
required: falseThe IDs of the users.
query(impl Into<String>)
/set_query(Option<String>)
:
required: falseA query to filter users by user name. Remember the following about the
Userids
andQuery
parameters:-
If you don’t use either parameter, the API returns a paginated list of all users on the site.
-
If you use both parameters, the API ignores the
Query
parameter. -
The
Userid
parameter only returns user names that match a corresponding user ID. -
The
Query
parameter runs a “prefix” search for users by theGivenName
,SurName
, orUserName
fields included in a CreateUser API call. For example, querying onMa
returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying onMa J
only returns Mateo Jackson.
-
include(UserFilterType)
/set_include(Option<UserFilterType>)
:
required: falseThe state of the users. Specify “ALL” to include inactive users.
order(OrderType)
/set_order(Option<OrderType>)
:
required: falseThe order for the results.
sort(UserSortType)
/set_sort(Option<UserSortType>)
:
required: falseThe sorting criteria.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe marker for the next set of results. (You received this marker from a previous call.)
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of items to return.
fields(impl Into<String>)
/set_fields(Option<String>)
:
required: falseA 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>
Source§impl Client
impl Client
Sourcepub fn get_current_user(&self) -> GetCurrentUserFluentBuilder
pub fn get_current_user(&self) -> GetCurrentUserFluentBuilder
Constructs a fluent builder for the GetCurrentUser
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: trueAmazon WorkDocs authentication token.
- On success, responds with
GetCurrentUserOutput
with field(s):user(Option<User>)
:Metadata of the user.
- On failure, responds with
SdkError<GetCurrentUserError>
Source§impl Client
impl Client
Sourcepub fn get_document(&self) -> GetDocumentFluentBuilder
pub fn get_document(&self) -> GetDocumentFluentBuilder
Constructs a fluent builder for the GetDocument
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
include_custom_metadata(bool)
/set_include_custom_metadata(Option<bool>)
:
required: falseSet 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>
Source§impl Client
impl Client
Sourcepub fn get_document_path(&self) -> GetDocumentPathFluentBuilder
pub fn get_document_path(&self) -> GetDocumentPathFluentBuilder
Constructs a fluent builder for the GetDocumentPath
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of levels in the hierarchy to return.
fields(impl Into<String>)
/set_fields(Option<String>)
:
required: falseA comma-separated list of values. Specify
NAME
to include the names of the parent folders.marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThis value is not supported.
- On success, responds with
GetDocumentPathOutput
with field(s):path(Option<ResourcePath>)
:The path information.
- On failure, responds with
SdkError<GetDocumentPathError>
Source§impl Client
impl Client
Sourcepub fn get_document_version(&self) -> GetDocumentVersionFluentBuilder
pub fn get_document_version(&self) -> GetDocumentVersionFluentBuilder
Constructs a fluent builder for the GetDocumentVersion
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe version ID of the document.
fields(impl Into<String>)
/set_fields(Option<String>)
:
required: falseA comma-separated list of values. Specify “SOURCE” to include a URL for the source document.
include_custom_metadata(bool)
/set_include_custom_metadata(Option<bool>)
:
required: falseSet 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>
Source§impl Client
impl Client
Sourcepub fn get_folder(&self) -> GetFolderFluentBuilder
pub fn get_folder(&self) -> GetFolderFluentBuilder
Constructs a fluent builder for the GetFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:
required: trueThe ID of the folder.
include_custom_metadata(bool)
/set_include_custom_metadata(Option<bool>)
:
required: falseSet 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>
Source§impl Client
impl Client
Sourcepub fn get_folder_path(&self) -> GetFolderPathFluentBuilder
pub fn get_folder_path(&self) -> GetFolderPathFluentBuilder
Constructs a fluent builder for the GetFolderPath
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:
required: trueThe ID of the folder.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of levels in the hierarchy to return.
fields(impl Into<String>)
/set_fields(Option<String>)
:
required: falseA comma-separated list of values. Specify “NAME” to include the names of the parent folders.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThis value is not supported.
- On success, responds with
GetFolderPathOutput
with field(s):path(Option<ResourcePath>)
:The path information.
- On failure, responds with
SdkError<GetFolderPathError>
Source§impl Client
impl Client
Sourcepub fn get_resources(&self) -> GetResourcesFluentBuilder
pub fn get_resources(&self) -> GetResourcesFluentBuilder
Constructs a fluent builder for the GetResources
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseThe Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: falseThe 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>)
:
required: falseThe collection type.
limit(i32)
/set_limit(Option<i32>)
:
required: falseThe maximum number of resources to return.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn initiate_document_version_upload(
&self,
) -> InitiateDocumentVersionUploadFluentBuilder
pub fn initiate_document_version_upload( &self, ) -> InitiateDocumentVersionUploadFluentBuilder
Constructs a fluent builder for the InitiateDocumentVersionUpload
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
id(impl Into<String>)
/set_id(Option<String>)
:
required: falseThe ID of the document.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the document.
content_created_timestamp(DateTime)
/set_content_created_timestamp(Option<DateTime>)
:
required: falseThe timestamp when the content of the document was originally created.
content_modified_timestamp(DateTime)
/set_content_modified_timestamp(Option<DateTime>)
:
required: falseThe timestamp when the content of the document was modified.
content_type(impl Into<String>)
/set_content_type(Option<String>)
:
required: falseThe content type of the document.
document_size_in_bytes(i64)
/set_document_size_in_bytes(Option<i64>)
:
required: falseThe size of the document, in bytes.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn remove_all_resource_permissions(
&self,
) -> RemoveAllResourcePermissionsFluentBuilder
pub fn remove_all_resource_permissions( &self, ) -> RemoveAllResourcePermissionsFluentBuilder
Constructs a fluent builder for the RemoveAllResourcePermissions
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
- On success, responds with
RemoveAllResourcePermissionsOutput
- On failure, responds with
SdkError<RemoveAllResourcePermissionsError>
Source§impl Client
impl Client
Sourcepub fn remove_resource_permission(
&self,
) -> RemoveResourcePermissionFluentBuilder
pub fn remove_resource_permission( &self, ) -> RemoveResourcePermissionFluentBuilder
Constructs a fluent builder for the RemoveResourcePermission
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:
required: trueThe ID of the resource.
principal_id(impl Into<String>)
/set_principal_id(Option<String>)
:
required: trueThe principal ID of the resource.
principal_type(PrincipalType)
/set_principal_type(Option<PrincipalType>)
:
required: falseThe principal type of the resource.
- On success, responds with
RemoveResourcePermissionOutput
- On failure, responds with
SdkError<RemoveResourcePermissionError>
Source§impl Client
impl Client
Sourcepub fn restore_document_versions(&self) -> RestoreDocumentVersionsFluentBuilder
pub fn restore_document_versions(&self) -> RestoreDocumentVersionsFluentBuilder
Constructs a fluent builder for the RestoreDocumentVersions
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
- On success, responds with
RestoreDocumentVersionsOutput
- On failure, responds with
SdkError<RestoreDocumentVersionsError>
Source§impl Client
impl Client
Sourcepub fn search_resources(&self) -> SearchResourcesFluentBuilder
pub fn search_resources(&self) -> SearchResourcesFluentBuilder
Constructs a fluent builder for the SearchResources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
query_text(impl Into<String>)
/set_query_text(Option<String>)
:
required: falseThe String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
query_scopes(SearchQueryScopeType)
/set_query_scopes(Option<Vec::<SearchQueryScopeType>>)
:
required: falseFilter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
organization_id(impl Into<String>)
/set_organization_id(Option<String>)
:
required: falseFilters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
additional_response_fields(AdditionalResponseFieldType)
/set_additional_response_fields(Option<Vec::<AdditionalResponseFieldType>>)
:
required: falseA list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
filters(Filters)
/set_filters(Option<Filters>)
:
required: falseFilters results based on entity metadata.
order_by(SearchSortResult)
/set_order_by(Option<Vec::<SearchSortResult>>)
:
required: falseOrder by results in one or more categories.
limit(i32)
/set_limit(Option<i32>)
:
required: falseMax results count per page.
marker(impl Into<String>)
/set_marker(Option<String>)
:
required: falseThe marker for the next set of results.
- On success, responds with
SearchResourcesOutput
with field(s):items(Option<Vec::<ResponseItem>>)
:List of Documents, Folders, Comments, and Document Versions matching the query.
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<SearchResourcesError>
Source§impl Client
impl Client
Sourcepub fn update_document(&self) -> UpdateDocumentFluentBuilder
pub fn update_document(&self) -> UpdateDocumentFluentBuilder
Constructs a fluent builder for the UpdateDocument
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the document.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:
required: falseThe ID of the parent folder.
resource_state(ResourceStateType)
/set_resource_state(Option<ResourceStateType>)
:
required: falseThe resource state of the document. Only ACTIVE and RECYCLED are supported.
- On success, responds with
UpdateDocumentOutput
- On failure, responds with
SdkError<UpdateDocumentError>
Source§impl Client
impl Client
Sourcepub fn update_document_version(&self) -> UpdateDocumentVersionFluentBuilder
pub fn update_document_version(&self) -> UpdateDocumentVersionFluentBuilder
Constructs a fluent builder for the UpdateDocumentVersion
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
document_id(impl Into<String>)
/set_document_id(Option<String>)
:
required: trueThe ID of the document.
version_id(impl Into<String>)
/set_version_id(Option<String>)
:
required: trueThe version ID of the document.
version_status(DocumentVersionStatus)
/set_version_status(Option<DocumentVersionStatus>)
:
required: falseThe status of the version.
- On success, responds with
UpdateDocumentVersionOutput
- On failure, responds with
SdkError<UpdateDocumentVersionError>
Source§impl Client
impl Client
Sourcepub fn update_folder(&self) -> UpdateFolderFluentBuilder
pub fn update_folder(&self) -> UpdateFolderFluentBuilder
Constructs a fluent builder for the UpdateFolder
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
folder_id(impl Into<String>)
/set_folder_id(Option<String>)
:
required: trueThe ID of the folder.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the folder.
parent_folder_id(impl Into<String>)
/set_parent_folder_id(Option<String>)
:
required: falseThe ID of the parent folder.
resource_state(ResourceStateType)
/set_resource_state(Option<ResourceStateType>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_user(&self) -> UpdateUserFluentBuilder
pub fn update_user(&self) -> UpdateUserFluentBuilder
Constructs a fluent builder for the UpdateUser
operation.
- The fluent builder is configurable:
authentication_token(impl Into<String>)
/set_authentication_token(Option<String>)
:
required: falseAmazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: trueThe ID of the user.
given_name(impl Into<String>)
/set_given_name(Option<String>)
:
required: falseThe given name of the user.
surname(impl Into<String>)
/set_surname(Option<String>)
:
required: falseThe surname of the user.
r#type(UserType)
/set_type(Option<UserType>)
:
required: falseThe type of the user.
storage_rule(StorageRuleType)
/set_storage_rule(Option<StorageRuleType>)
:
required: falseThe amount of storage for the user.
time_zone_id(impl Into<String>)
/set_time_zone_id(Option<String>)
:
required: falseThe time zone ID of the user.
locale(LocaleType)
/set_locale(Option<LocaleType>)
:
required: falseThe locale of the user.
grant_poweruser_privileges(BooleanEnumType)
/set_grant_poweruser_privileges(Option<BooleanEnumType>)
:
required: falseBoolean value to determine whether the user is granted Power user privileges.
- On success, responds with
UpdateUserOutput
with field(s):user(Option<User>)
:The user information.
- On failure, responds with
SdkError<UpdateUserError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);