Struct aws_sdk_workdocs::client::Client

pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

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

impl<C, M, R> Client<C, M, R>

pub fn with_config(client: Client<C, M, R>, conf: Config) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl<C, M, R> Client<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub fn abort_document_version_upload(
    &self
) -> AbortDocumentVersionUpload<C, M, R>

Constructs a fluent builder for the AbortDocumentVersionUpload operation.

See AbortDocumentVersionUpload for more information about the operation and its arguments.

pub fn activate_user(&self) -> ActivateUser<C, M, R>

Constructs a fluent builder for the ActivateUser operation.

See ActivateUser for more information about the operation and its arguments.

pub fn add_resource_permissions(&self) -> AddResourcePermissions<C, M, R>

Constructs a fluent builder for the AddResourcePermissions operation.

See AddResourcePermissions for more information about the operation and its arguments.

pub fn create_comment(&self) -> CreateComment<C, M, R>

Constructs a fluent builder for the CreateComment operation.

See CreateComment for more information about the operation and its arguments.

pub fn create_custom_metadata(&self) -> CreateCustomMetadata<C, M, R>

Constructs a fluent builder for the CreateCustomMetadata operation.

See CreateCustomMetadata for more information about the operation and its arguments.

pub fn create_folder(&self) -> CreateFolder<C, M, R>

Constructs a fluent builder for the CreateFolder operation.

See CreateFolder for more information about the operation and its arguments.

pub fn create_labels(&self) -> CreateLabels<C, M, R>

Constructs a fluent builder for the CreateLabels operation.

See CreateLabels for more information about the operation and its arguments.

pub fn create_notification_subscription(
    &self
) -> CreateNotificationSubscription<C, M, R>

Constructs a fluent builder for the CreateNotificationSubscription operation.

See CreateNotificationSubscription for more information about the operation and its arguments.

pub fn create_user(&self) -> CreateUser<C, M, R>

Constructs a fluent builder for the CreateUser operation.

See CreateUser for more information about the operation and its arguments.

pub fn deactivate_user(&self) -> DeactivateUser<C, M, R>

Constructs a fluent builder for the DeactivateUser operation.

See DeactivateUser for more information about the operation and its arguments.

pub fn delete_comment(&self) -> DeleteComment<C, M, R>

Constructs a fluent builder for the DeleteComment operation.

See DeleteComment for more information about the operation and its arguments.

pub fn delete_custom_metadata(&self) -> DeleteCustomMetadata<C, M, R>

Constructs a fluent builder for the DeleteCustomMetadata operation.

See DeleteCustomMetadata for more information about the operation and its arguments.

pub fn delete_document(&self) -> DeleteDocument<C, M, R>

Constructs a fluent builder for the DeleteDocument operation.

See DeleteDocument for more information about the operation and its arguments.

pub fn delete_folder(&self) -> DeleteFolder<C, M, R>

Constructs a fluent builder for the DeleteFolder operation.

See DeleteFolder for more information about the operation and its arguments.

pub fn delete_folder_contents(&self) -> DeleteFolderContents<C, M, R>

Constructs a fluent builder for the DeleteFolderContents operation.

See DeleteFolderContents for more information about the operation and its arguments.

pub fn delete_labels(&self) -> DeleteLabels<C, M, R>

Constructs a fluent builder for the DeleteLabels operation.

See DeleteLabels for more information about the operation and its arguments.

pub fn delete_notification_subscription(
    &self
) -> DeleteNotificationSubscription<C, M, R>

Constructs a fluent builder for the DeleteNotificationSubscription operation.

See DeleteNotificationSubscription for more information about the operation and its arguments.

pub fn delete_user(&self) -> DeleteUser<C, M, R>

Constructs a fluent builder for the DeleteUser operation.

See DeleteUser for more information about the operation and its arguments.

pub fn describe_activities(&self) -> DescribeActivities<C, M, R>

Constructs a fluent builder for the DescribeActivities operation.

See DescribeActivities for more information about the operation and its arguments.

pub fn describe_comments(&self) -> DescribeComments<C, M, R>

Constructs a fluent builder for the DescribeComments operation.

See DescribeComments for more information about the operation and its arguments.

pub fn describe_document_versions(&self) -> DescribeDocumentVersions<C, M, R>

Constructs a fluent builder for the DescribeDocumentVersions operation.

See DescribeDocumentVersions for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn describe_folder_contents(&self) -> DescribeFolderContents<C, M, R>

Constructs a fluent builder for the DescribeFolderContents operation.

See DescribeFolderContents for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn describe_groups(&self) -> DescribeGroups<C, M, R>

Constructs a fluent builder for the DescribeGroups operation.

See DescribeGroups for more information about the operation and its arguments.

pub fn describe_notification_subscriptions(
    &self
) -> DescribeNotificationSubscriptions<C, M, R>

Constructs a fluent builder for the DescribeNotificationSubscriptions operation.

See DescribeNotificationSubscriptions for more information about the operation and its arguments.

pub fn describe_resource_permissions(
    &self
) -> DescribeResourcePermissions<C, M, R>

Constructs a fluent builder for the DescribeResourcePermissions operation.

See DescribeResourcePermissions for more information about the operation and its arguments.

pub fn describe_root_folders(&self) -> DescribeRootFolders<C, M, R>

Constructs a fluent builder for the DescribeRootFolders operation.

See DescribeRootFolders for more information about the operation and its arguments.

pub fn describe_users(&self) -> DescribeUsers<C, M, R>

Constructs a fluent builder for the DescribeUsers operation.

See DescribeUsers for more information about the operation and its arguments. This operation supports pagination. See into_paginator().

pub fn get_current_user(&self) -> GetCurrentUser<C, M, R>

Constructs a fluent builder for the GetCurrentUser operation.

See GetCurrentUser for more information about the operation and its arguments.

pub fn get_document(&self) -> GetDocument<C, M, R>

Constructs a fluent builder for the GetDocument operation.

See GetDocument for more information about the operation and its arguments.

pub fn get_document_path(&self) -> GetDocumentPath<C, M, R>

Constructs a fluent builder for the GetDocumentPath operation.

See GetDocumentPath for more information about the operation and its arguments.

pub fn get_document_version(&self) -> GetDocumentVersion<C, M, R>

Constructs a fluent builder for the GetDocumentVersion operation.

See GetDocumentVersion for more information about the operation and its arguments.

pub fn get_folder(&self) -> GetFolder<C, M, R>

Constructs a fluent builder for the GetFolder operation.

See GetFolder for more information about the operation and its arguments.

pub fn get_folder_path(&self) -> GetFolderPath<C, M, R>

Constructs a fluent builder for the GetFolderPath operation.

See GetFolderPath for more information about the operation and its arguments.

pub fn get_resources(&self) -> GetResources<C, M, R>

Constructs a fluent builder for the GetResources operation.

See GetResources for more information about the operation and its arguments.

pub fn initiate_document_version_upload(
    &self
) -> InitiateDocumentVersionUpload<C, M, R>

Constructs a fluent builder for the InitiateDocumentVersionUpload operation.

See InitiateDocumentVersionUpload for more information about the operation and its arguments.

pub fn remove_all_resource_permissions(
    &self
) -> RemoveAllResourcePermissions<C, M, R>

Constructs a fluent builder for the RemoveAllResourcePermissions operation.

See RemoveAllResourcePermissions for more information about the operation and its arguments.

pub fn remove_resource_permission(&self) -> RemoveResourcePermission<C, M, R>

Constructs a fluent builder for the RemoveResourcePermission operation.

See RemoveResourcePermission for more information about the operation and its arguments.

pub fn update_document(&self) -> UpdateDocument<C, M, R>

Constructs a fluent builder for the UpdateDocument operation.

See UpdateDocument for more information about the operation and its arguments.

pub fn update_document_version(&self) -> UpdateDocumentVersion<C, M, R>

Constructs a fluent builder for the UpdateDocumentVersion operation.

See UpdateDocumentVersion for more information about the operation and its arguments.

pub fn update_folder(&self) -> UpdateFolder<C, M, R>

Constructs a fluent builder for the UpdateFolder operation.

See UpdateFolder for more information about the operation and its arguments.

pub fn update_user(&self) -> UpdateUser<C, M, R>

Constructs a fluent builder for the UpdateUser operation.

See UpdateUser for more information about the operation and its arguments.

impl<C> Client<C, DefaultMiddleware, Standard>

pub fn from_conf_conn(conf: Config, conn: C) -> Self

Creates a client with the given service config and connector override.

impl Client<DynConnector, DefaultMiddleware, Standard>

pub fn new(config: &Config) -> Self

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl<C, M, R> Clone for Client<C, M, R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for Client<C, M, R>

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

Formats the value using the given formatter.

impl<C, M, R> From<Client<C, M, R>> for Client<C, M, R>

fn from(client: Client<C, M, R>) -> Self

Performs the conversion.