aws_sdk_workspaces/

client.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[derive(Debug)]
pub(crate) struct Handle {
    pub(crate) conf: crate::Config,
    #[allow(dead_code)] // unused when a service does not provide any operations
    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
}

/// Client for Amazon WorkSpaces
///
/// Client for invoking operations on Amazon WorkSpaces. Each operation on Amazon WorkSpaces 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:
/// ```rust,no_run
/// # async fn wrapper() {
/// let config = aws_config::load_from_env().await;
/// let client = aws_sdk_workspaces::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`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
/// done as follows:
///
/// ```rust,no_run
/// # async fn wrapper() {
/// let sdk_config = ::aws_config::load_from_env().await;
/// let config = aws_sdk_workspaces::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.
///
/// [`Config`]: crate::Config
/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
/// [`aws-config` docs]: https://docs.rs/aws-config/*
/// [`aws-config`]: https://crates.io/crates/aws-config
/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
/// # Using the `Client`
///
/// A client has a function for every operation that can be performed by the service.
/// For example, the [`AcceptAccountLinkInvitation`](crate::operation::accept_account_link_invitation) operation has
/// a [`Client::accept_account_link_invitation`], 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:
///
/// ```rust,ignore
/// let result = client.accept_account_link_invitation()
///     .link_id("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`](crate::client::customize) module for more
/// information.
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct Client {
    handle: ::std::sync::Arc<Handle>,
}

impl Client {
    /// Creates a new client from the service [`Config`](crate::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.
    #[track_caller]
    pub fn from_conf(conf: crate::Config) -> Self {
        let handle = Handle {
            conf: conf.clone(),
            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
        };
        if let Err(err) = Self::validate_config(&handle) {
            panic!("Invalid client configuration: {err}");
        }
        Self {
            handle: ::std::sync::Arc::new(handle),
        }
    }

    /// Returns the client's configuration.
    pub fn config(&self) -> &crate::Config {
        &self.handle.conf
    }

    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
        handle
            .runtime_plugins
            .apply_client_configuration(&mut cfg)?
            .validate_base_client_config(&cfg)?;
        Ok(())
    }
}

impl Client {
    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
    ///
    /// # 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.
    #[track_caller]
    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }
}

impl Client {
    /// Returns the type registry for this service.
    ///
    /// The registry contains an entry for every structure shape in the service
    /// closure (excluding only synthetic operation input/output shapes),
    /// keyed by [`ShapeId`](::aws_smithy_schema::ShapeId). It is primarily useful for deserializing
    /// a [`Document`](::aws_smithy_types::Document) into a typed shape:
    ///
    /// ```ignore
    /// let registry = MyClient::registry();
    /// let typed = registry.deserialize_document(&doc)?;
    /// // Downcast to the concrete type you expected.
    /// ```
    pub fn registry() -> &'static ::aws_smithy_schema::registry::TypeRegistry {
        &crate::type_registry::REGISTRY
    }
}

impl Client {
    /// Returns the service-wide error registry.
    ///
    /// The registry contains an entry for every `@error`-trait structure shape
    /// in the service closure, keyed by [`ShapeId`](::aws_smithy_schema::ShapeId). Use it to reify a
    /// discriminated [`Document`](::aws_smithy_types::Document) into a typed error variant via
    /// [`TypeRegistry::deserialize_document`](::aws_smithy_schema::registry::TypeRegistry::deserialize_document).
    ///
    /// This registry is provided for third-party `Document`-based error handling.
    /// Internally it also serves as the widening fallback when the schema-serde
    /// error path reifies an error code that an operation does not model directly
    /// (the operation's own error registry is consulted first).
    ///
    /// ```ignore
    /// let registry = MyClient::error_registry();
    /// let typed = registry.deserialize_document(&doc)?;
    /// // Downcast to the concrete error variant you expected.
    /// ```
    pub fn error_registry() -> &'static ::aws_smithy_schema::registry::TypeRegistry {
        &crate::error_type_registry::REGISTRY
    }
}

mod accept_account_link_invitation;

mod associate_connection_alias;

mod associate_ip_groups;

mod associate_workspace_application;

mod authorize_ip_rules;

mod copy_workspace_image;

mod create_account_link_invitation;

mod create_connect_client_add_in;

mod create_connection_alias;

mod create_ip_group;

mod create_standby_workspaces;

mod create_tags;

mod create_updated_workspace_image;

mod create_workspace_bundle;

mod create_workspace_image;

mod create_workspaces;

mod create_workspaces_pool;

/// Operation customization and supporting types.
///
/// The underlying HTTP requests made during an operation can be customized
/// by calling the `customize()` method on the builder returned from a client
/// operation call. For example, this can be used to add an additional HTTP header:
///
/// ```ignore
/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_workspaces::Error> {
/// # let client: aws_sdk_workspaces::Client = unimplemented!();
/// use ::http_1x::header::{HeaderName, HeaderValue};
///
/// let result = client.accept_account_link_invitation()
///     .customize()
///     .mutate_request(|req| {
///         // Add `x-example-header` with value
///         req.headers_mut()
///             .insert(
///                 HeaderName::from_static("x-example-header"),
///                 HeaderValue::from_static("1"),
///             );
///     })
///     .send()
///     .await;
/// # }
/// ```
pub mod customize;

mod delete_account_link_invitation;

mod delete_client_branding;

mod delete_connect_client_add_in;

mod delete_connection_alias;

mod delete_ip_group;

mod delete_tags;

mod delete_workspace_bundle;

mod delete_workspace_image;

mod deploy_workspace_applications;

mod deregister_workspace_directory;

mod describe_account;

mod describe_account_modifications;

mod describe_application_associations;

mod describe_applications;

mod describe_bundle_associations;

mod describe_client_branding;

mod describe_client_properties;

mod describe_connect_client_add_ins;

mod describe_connection_alias_permissions;

mod describe_connection_aliases;

mod describe_custom_workspace_image_import;

mod describe_image_associations;

mod describe_ip_groups;

mod describe_tags;

mod describe_workspace_associations;

mod describe_workspace_bundles;

mod describe_workspace_directories;

mod describe_workspace_image_permissions;

mod describe_workspace_images;

mod describe_workspace_snapshots;

mod describe_workspaces;

mod describe_workspaces_connection_status;

mod describe_workspaces_pool_sessions;

mod describe_workspaces_pools;

mod disassociate_connection_alias;

mod disassociate_ip_groups;

mod disassociate_workspace_application;

mod get_account_link;

mod import_client_branding;

mod import_custom_workspace_image;

mod import_workspace_image;

mod list_account_links;

mod list_available_management_cidr_ranges;

mod migrate_workspace;

mod modify_account;

mod modify_certificate_based_auth_properties;

mod modify_client_properties;

mod modify_endpoint_encryption_mode;

mod modify_saml_properties;

mod modify_selfservice_permissions;

mod modify_streaming_properties;

mod modify_workspace_access_properties;

mod modify_workspace_creation_properties;

mod modify_workspace_properties;

mod modify_workspace_state;

mod reboot_workspaces;

mod rebuild_workspaces;

mod register_workspace_directory;

mod reject_account_link_invitation;

mod restore_workspace;

mod revoke_ip_rules;

mod start_workspaces;

mod start_workspaces_pool;

mod stop_workspaces;

mod stop_workspaces_pool;

mod terminate_workspaces;

mod terminate_workspaces_pool;

mod terminate_workspaces_pool_session;

mod update_connect_client_add_in;

mod update_connection_alias_permission;

mod update_rules_of_ip_group;

mod update_workspace_bundle;

mod update_workspace_image_permission;

mod update_workspaces_pool;