Struct aws_sdk_workdocs::client::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.

§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 Config 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

source

pub fn abort_document_version_upload( &self ) -> AbortDocumentVersionUploadFluentBuilder

Constructs a fluent builder for the AbortDocumentVersionUpload operation.

source§

impl Client

source

pub fn activate_user(&self) -> ActivateUserFluentBuilder

Constructs a fluent builder for the ActivateUser operation.

source§

impl Client

source

pub fn add_resource_permissions(&self) -> AddResourcePermissionsFluentBuilder

Constructs a fluent builder for the AddResourcePermissions operation.

source§

impl Client

source

pub fn create_comment(&self) -> CreateCommentFluentBuilder

Constructs a fluent builder for the CreateComment operation.

source§

impl Client

source

pub fn create_custom_metadata(&self) -> CreateCustomMetadataFluentBuilder

Constructs a fluent builder for the CreateCustomMetadata operation.

source§

impl Client

source

pub fn create_folder(&self) -> CreateFolderFluentBuilder

Constructs a fluent builder for the CreateFolder operation.

source§

impl Client

source

pub fn create_labels(&self) -> CreateLabelsFluentBuilder

Constructs a fluent builder for the CreateLabels operation.

source§

impl Client

source

pub fn create_notification_subscription( &self ) -> CreateNotificationSubscriptionFluentBuilder

Constructs a fluent builder for the CreateNotificationSubscription operation.

source§

impl Client

source

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

source§

impl Client

source

pub fn deactivate_user(&self) -> DeactivateUserFluentBuilder

Constructs a fluent builder for the DeactivateUser operation.

source§

impl Client

source

pub fn delete_comment(&self) -> DeleteCommentFluentBuilder

Constructs a fluent builder for the DeleteComment operation.

source§

impl Client

source

pub fn delete_custom_metadata(&self) -> DeleteCustomMetadataFluentBuilder

Constructs a fluent builder for the DeleteCustomMetadata operation.

source§

impl Client

source

pub fn delete_document(&self) -> DeleteDocumentFluentBuilder

Constructs a fluent builder for the DeleteDocument operation.

source§

impl Client

source

pub fn delete_document_version(&self) -> DeleteDocumentVersionFluentBuilder

Constructs a fluent builder for the DeleteDocumentVersion operation.

source§

impl Client

source

pub fn delete_folder(&self) -> DeleteFolderFluentBuilder

Constructs a fluent builder for the DeleteFolder operation.

source§

impl Client

source

pub fn delete_folder_contents(&self) -> DeleteFolderContentsFluentBuilder

Constructs a fluent builder for the DeleteFolderContents operation.

source§

impl Client

source

pub fn delete_labels(&self) -> DeleteLabelsFluentBuilder

Constructs a fluent builder for the DeleteLabels operation.

source§

impl Client

source

pub fn delete_notification_subscription( &self ) -> DeleteNotificationSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteNotificationSubscription operation.

source§

impl Client

source

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

source§

impl Client

source

pub fn describe_activities(&self) -> DescribeActivitiesFluentBuilder

Constructs a fluent builder for the DescribeActivities operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_comments(&self) -> DescribeCommentsFluentBuilder

Constructs a fluent builder for the DescribeComments operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_document_versions( &self ) -> DescribeDocumentVersionsFluentBuilder

Constructs a fluent builder for the DescribeDocumentVersions operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_folder_contents(&self) -> DescribeFolderContentsFluentBuilder

Constructs a fluent builder for the DescribeFolderContents operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_groups(&self) -> DescribeGroupsFluentBuilder

Constructs a fluent builder for the DescribeGroups operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_notification_subscriptions( &self ) -> DescribeNotificationSubscriptionsFluentBuilder

Constructs a fluent builder for the DescribeNotificationSubscriptions operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_resource_permissions( &self ) -> DescribeResourcePermissionsFluentBuilder

Constructs a fluent builder for the DescribeResourcePermissions operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_root_folders(&self) -> DescribeRootFoldersFluentBuilder

Constructs a fluent builder for the DescribeRootFolders operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn describe_users(&self) -> DescribeUsersFluentBuilder

Constructs a fluent builder for the DescribeUsers operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn get_current_user(&self) -> GetCurrentUserFluentBuilder

Constructs a fluent builder for the GetCurrentUser operation.

source§

impl Client

source

pub fn get_document(&self) -> GetDocumentFluentBuilder

Constructs a fluent builder for the GetDocument operation.

source§

impl Client

source

pub fn get_document_path(&self) -> GetDocumentPathFluentBuilder

Constructs a fluent builder for the GetDocumentPath operation.

source§

impl Client

source

pub fn get_document_version(&self) -> GetDocumentVersionFluentBuilder

Constructs a fluent builder for the GetDocumentVersion operation.

source§

impl Client

source

pub fn get_folder(&self) -> GetFolderFluentBuilder

Constructs a fluent builder for the GetFolder operation.

source§

impl Client

source

pub fn get_folder_path(&self) -> GetFolderPathFluentBuilder

Constructs a fluent builder for the GetFolderPath operation.

source§

impl Client

source

pub fn get_resources(&self) -> GetResourcesFluentBuilder

Constructs a fluent builder for the GetResources operation.

source§

impl Client

source

pub fn initiate_document_version_upload( &self ) -> InitiateDocumentVersionUploadFluentBuilder

Constructs a fluent builder for the InitiateDocumentVersionUpload operation.

source§

impl Client

source

pub fn remove_all_resource_permissions( &self ) -> RemoveAllResourcePermissionsFluentBuilder

Constructs a fluent builder for the RemoveAllResourcePermissions operation.

source§

impl Client

source

pub fn remove_resource_permission( &self ) -> RemoveResourcePermissionFluentBuilder

Constructs a fluent builder for the RemoveResourcePermission operation.

source§

impl Client

source

pub fn restore_document_versions(&self) -> RestoreDocumentVersionsFluentBuilder

Constructs a fluent builder for the RestoreDocumentVersions operation.

source§

impl Client

source

pub fn search_resources(&self) -> SearchResourcesFluentBuilder

Constructs a fluent builder for the SearchResources operation. This operation supports pagination; See into_paginator().

source§

impl Client

source

pub fn update_document(&self) -> UpdateDocumentFluentBuilder

Constructs a fluent builder for the UpdateDocument operation.

source§

impl Client

source

pub fn update_document_version(&self) -> UpdateDocumentVersionFluentBuilder

Constructs a fluent builder for the UpdateDocumentVersion operation.

source§

impl Client

source

pub fn update_folder(&self) -> UpdateFolderFluentBuilder

Constructs a fluent builder for the UpdateFolder operation.

source§

impl Client

source

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

source§

impl Client

source

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 and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

source

pub fn config(&self) -> &Config

Returns the client’s configuration.

source§

impl Client

source

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

source§

impl Clone for Client

source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Client

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more