aws_sdk_quicksight/

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 QuickSight
///
/// Client for invoking operations on Amazon QuickSight. Each operation on Amazon QuickSight 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_quicksight::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_quicksight::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 [`BatchCreateTopicReviewedAnswer`](crate::operation::batch_create_topic_reviewed_answer) operation has
/// a [`Client::batch_create_topic_reviewed_answer`], 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.batch_create_topic_reviewed_answer()
///     .aws_account_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())
    }
}

mod batch_create_topic_reviewed_answer;

mod batch_delete_topic_reviewed_answer;

mod cancel_ingestion;

mod create_account_customization;

mod create_account_subscription;

mod create_analysis;

mod create_brand;

mod create_custom_permissions;

mod create_dashboard;

mod create_data_set;

mod create_data_source;

mod create_folder;

mod create_folder_membership;

mod create_group;

mod create_group_membership;

mod create_iam_policy_assignment;

mod create_ingestion;

mod create_namespace;

mod create_refresh_schedule;

mod create_role_membership;

mod create_template;

mod create_template_alias;

mod create_theme;

mod create_theme_alias;

mod create_topic;

mod create_topic_refresh_schedule;

mod create_vpc_connection;

/// 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_quicksight::Error> {
/// # let client: aws_sdk_quicksight::Client = unimplemented!();
/// use ::http::header::{HeaderName, HeaderValue};
///
/// let result = client.batch_create_topic_reviewed_answer()
///     .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_customization;

mod delete_account_subscription;

mod delete_analysis;

mod delete_brand;

mod delete_brand_assignment;

mod delete_custom_permissions;

mod delete_dashboard;

mod delete_data_set;

mod delete_data_set_refresh_properties;

mod delete_data_source;

mod delete_default_q_business_application;

mod delete_folder;

mod delete_folder_membership;

mod delete_group;

mod delete_group_membership;

mod delete_iam_policy_assignment;

mod delete_identity_propagation_config;

mod delete_namespace;

mod delete_refresh_schedule;

mod delete_role_custom_permission;

mod delete_role_membership;

mod delete_template;

mod delete_template_alias;

mod delete_theme;

mod delete_theme_alias;

mod delete_topic;

mod delete_topic_refresh_schedule;

mod delete_user;

mod delete_user_by_principal_id;

mod delete_user_custom_permission;

mod delete_vpc_connection;

mod describe_account_customization;

mod describe_account_settings;

mod describe_account_subscription;

mod describe_analysis;

mod describe_analysis_definition;

mod describe_analysis_permissions;

mod describe_asset_bundle_export_job;

mod describe_asset_bundle_import_job;

mod describe_brand;

mod describe_brand_assignment;

mod describe_brand_published_version;

mod describe_custom_permissions;

mod describe_dashboard;

mod describe_dashboard_definition;

mod describe_dashboard_permissions;

mod describe_dashboard_snapshot_job;

mod describe_dashboard_snapshot_job_result;

mod describe_dashboards_qa_configuration;

mod describe_data_set;

mod describe_data_set_permissions;

mod describe_data_set_refresh_properties;

mod describe_data_source;

mod describe_data_source_permissions;

mod describe_default_q_business_application;

mod describe_folder;

mod describe_folder_permissions;

mod describe_folder_resolved_permissions;

mod describe_group;

mod describe_group_membership;

mod describe_iam_policy_assignment;

mod describe_ingestion;

mod describe_ip_restriction;

mod describe_key_registration;

mod describe_namespace;

mod describe_q_personalization_configuration;

mod describe_quick_sight_q_search_configuration;

mod describe_refresh_schedule;

mod describe_role_custom_permission;

mod describe_template;

mod describe_template_alias;

mod describe_template_definition;

mod describe_template_permissions;

mod describe_theme;

mod describe_theme_alias;

mod describe_theme_permissions;

mod describe_topic;

mod describe_topic_permissions;

mod describe_topic_refresh;

mod describe_topic_refresh_schedule;

mod describe_user;

mod describe_vpc_connection;

mod generate_embed_url_for_anonymous_user;

mod generate_embed_url_for_registered_user;

mod generate_embed_url_for_registered_user_with_identity;

mod get_dashboard_embed_url;

mod get_session_embed_url;

mod list_analyses;

mod list_asset_bundle_export_jobs;

mod list_asset_bundle_import_jobs;

mod list_brands;

mod list_custom_permissions;

mod list_dashboard_versions;

mod list_dashboards;

mod list_data_sets;

mod list_data_sources;

mod list_folder_members;

mod list_folders;

mod list_folders_for_resource;

mod list_group_memberships;

mod list_groups;

mod list_iam_policy_assignments;

mod list_iam_policy_assignments_for_user;

mod list_identity_propagation_configs;

mod list_ingestions;

mod list_namespaces;

mod list_refresh_schedules;

mod list_role_memberships;

mod list_tags_for_resource;

mod list_template_aliases;

mod list_template_versions;

mod list_templates;

mod list_theme_aliases;

mod list_theme_versions;

mod list_themes;

mod list_topic_refresh_schedules;

mod list_topic_reviewed_answers;

mod list_topics;

mod list_user_groups;

mod list_users;

mod list_vpc_connections;

mod predict_qa_results;

mod put_data_set_refresh_properties;

mod register_user;

mod restore_analysis;

mod search_analyses;

mod search_dashboards;

mod search_data_sets;

mod search_data_sources;

mod search_folders;

mod search_groups;

mod search_topics;

mod start_asset_bundle_export_job;

mod start_asset_bundle_import_job;

mod start_dashboard_snapshot_job;

mod start_dashboard_snapshot_job_schedule;

mod tag_resource;

mod untag_resource;

mod update_account_customization;

mod update_account_settings;

mod update_analysis;

mod update_analysis_permissions;

mod update_application_with_token_exchange_grant;

mod update_brand;

mod update_brand_assignment;

mod update_brand_published_version;

mod update_custom_permissions;

mod update_dashboard;

mod update_dashboard_links;

mod update_dashboard_permissions;

mod update_dashboard_published_version;

mod update_dashboards_qa_configuration;

mod update_data_set;

mod update_data_set_permissions;

mod update_data_source;

mod update_data_source_permissions;

mod update_default_q_business_application;

mod update_folder;

mod update_folder_permissions;

mod update_group;

mod update_iam_policy_assignment;

mod update_identity_propagation_config;

mod update_ip_restriction;

mod update_key_registration;

mod update_public_sharing_settings;

mod update_q_personalization_configuration;

mod update_quick_sight_q_search_configuration;

mod update_refresh_schedule;

mod update_role_custom_permission;

mod update_spice_capacity_configuration;

mod update_template;

mod update_template_alias;

mod update_template_permissions;

mod update_theme;

mod update_theme_alias;

mod update_theme_permissions;

mod update_topic;

mod update_topic_permissions;

mod update_topic_refresh_schedule;

mod update_user;

mod update_user_custom_permission;

mod update_vpc_connection;