aws_sdk_quicksight/operation/start_dashboard_snapshot_job/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_dashboard_snapshot_job::_start_dashboard_snapshot_job_output::StartDashboardSnapshotJobOutputBuilder;

pub use crate::operation::start_dashboard_snapshot_job::_start_dashboard_snapshot_job_input::StartDashboardSnapshotJobInputBuilder;

impl crate::operation::start_dashboard_snapshot_job::builders::StartDashboardSnapshotJobInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.start_dashboard_snapshot_job();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `StartDashboardSnapshotJob`.
///
/// <p>Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.</p>
/// <ul>
/// <li>
/// <p>1 Paginated PDF</p></li>
/// <li>
/// <p>1 Excel workbook that includes up to 5 table or pivot table visuals</p></li>
/// <li>
/// <p>5 CSVs from table or pivot table visuals</p></li>
/// </ul>
/// <p>The status of a submitted job can be polled with the <code>DescribeDashboardSnapshotJob</code> API. When you call the <code>DescribeDashboardSnapshotJob</code> API, check the <code>JobStatus</code> field in the response. Once the job reaches a <code>COMPLETED</code> or <code>FAILED</code> status, use the <code>DescribeDashboardSnapshotJobResult</code> API to obtain the URLs for the generated files. If the job fails, the <code>DescribeDashboardSnapshotJobResult</code> API returns detailed information about the error that occurred.</p>
/// <p><b>StartDashboardSnapshotJob API throttling</b></p>
/// <p>Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the <code>StartDashboardSnapshotJob</code>. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users.</p>
/// <p><b>Common throttling scenarios</b></p>
/// <p>The following list provides information about the most commin throttling scenarios that can occur.</p>
/// <ul>
/// <li>
/// <p><b>A large number of <code>SnapshotExport</code> API jobs are running simultaneously on an Amazon Web Services account.</b> When a new <code>StartDashboardSnapshotJob</code> is created and there are already 12 jobs with the <code>RUNNING</code> status, the new job request fails and returns a <code>LimitExceededException</code> error. Wait for a current job to comlpete before you resubmit the new job.</p></li>
/// <li>
/// <p><b>A large number of API requests are submitted on an Amazon Web Services account.</b> When a user makes more than 10 API calls to the Quick Sight API in one second, a <code>ThrottlingException</code> is returned.</p></li>
/// </ul>
/// <p>If your use case requires a higher throttling limit, contact your account admin or <a href="http://aws.amazon.com/contact-us/">Amazon Web ServicesSupport</a> to explore options to tailor a more optimal expereince for your account.</p>
/// <p><b>Best practices to handle throttling</b></p>
/// <p>If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example <code>(12 minutes * 9 = 108 minutes)</code>. Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.</p>
/// <p>The time that it takes to process a job can be impacted by the following factors:</p>
/// <ul>
/// <li>
/// <p>The dataset type (Direct Query or SPICE).</p></li>
/// <li>
/// <p>The size of the dataset.</p></li>
/// <li>
/// <p>The complexity of the calculated fields that are used in the dashboard.</p></li>
/// <li>
/// <p>The number of visuals that are on a sheet.</p></li>
/// <li>
/// <p>The types of visuals that are on the sheet.</p></li>
/// <li>
/// <p>The number of formats and snapshots that are requested in the job configuration.</p></li>
/// <li>
/// <p>The size of the generated snapshots.</p></li>
/// </ul>
/// <p><b>Registered user support</b></p>
/// <p>You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html">identity-enhanced IAM role session credentials</a>. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings.</p>
/// <p>To generate snapshots for registered Quick Sight users, you need to:</p>
/// <ul>
/// <li>
/// <p>Obtain identity-enhanced IAM role session credentials from AWS Security Token Service (STS).</p></li>
/// <li>
/// <p>Use these credentials to call the Snapshot Job APIs.</p></li>
/// </ul>
/// <p>Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).</p>
/// <p>If your Quick Sight users are backed by <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Identity Center</a>, then you need to set up a <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/setuptrustedtokenissuer.html">trusted token issuer</a>. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:</p>
/// <ul>
/// <li>
/// <p>Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back.</p></li>
/// <li>
/// <p>Use the OIDC API, <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateTokenWithIAM.html">CreateTokenWithIAM</a>, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token.</p></li>
/// <li>
/// <p>Call STS AssumeRole API as you normally would, but provide an extra <code>ProvidedContexts</code> parameter in the API request. The list of contexts must have a single trusted context assertion. The <code>ProviderArn</code> should be <code>arn:aws:iam::aws:contextProvider/IdentityCenter</code> while <code>ContextAssertion</code> will be the identity token you received in response from CreateTokenWithIAM</p></li>
/// </ul>
/// <p>For more details, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-identity-enhanced-iam-role-sessions.html">IdC documentation on Identity-enhanced IAM role sessions</a>.</p>
/// <p>To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below:</p>
/// <ul>
/// <li>
/// <p>Call Quick Sight <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetIdentityContext.html">GetIdentityContext API</a> to get identity token.</p></li>
/// <li>
/// <p>Call STS AssumeRole API as you normally would, but provide extra <code>ProvidedContexts</code> parameter in the API request. The list of contexts must have a single trusted context assertion. The <code>ProviderArn</code> should be <code>arn:aws:iam::aws:contextProvider/QuickSight</code> while <code>ContextAssertion</code> will be the identity token you received in response from GetIdentityContext</p></li>
/// </ul>
/// <p>After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user.</p><important>
/// <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
/// </important>
/// <p><b>Possible error scenarios</b></p>
/// <p>The request fails with an Access Denied error in the following scenarios:</p>
/// <ul>
/// <li>
/// <p>The credentials have expired.</p></li>
/// <li>
/// <p>The impersonated Quick Sight user doesn't have access to the specified dashboard.</p></li>
/// <li>
/// <p>The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see <a href="https://docs.aws.amazon.com/quicksuite/latest/userguide/create-custom-permisions-profile.html">Customizing access to Amazon Quick Sight capabilities</a>.</p></li>
/// </ul>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartDashboardSnapshotJobFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::start_dashboard_snapshot_job::builders::StartDashboardSnapshotJobInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
    > for StartDashboardSnapshotJobFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
            crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl StartDashboardSnapshotJobFluentBuilder {
    /// Creates a new `StartDashboardSnapshotJobFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the StartDashboardSnapshotJob as a reference.
    pub fn as_input(&self) -> &crate::operation::start_dashboard_snapshot_job::builders::StartDashboardSnapshotJobInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJob::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJob::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
        crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.aws_account_id(input.into());
        self
    }
    /// <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_aws_account_id(input);
        self
    }
    /// <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_aws_account_id()
    }
    /// <p>The ID of the dashboard that you want to start a snapshot job for.</p>
    pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.dashboard_id(input.into());
        self
    }
    /// <p>The ID of the dashboard that you want to start a snapshot job for.</p>
    pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_dashboard_id(input);
        self
    }
    /// <p>The ID of the dashboard that you want to start a snapshot job for.</p>
    pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_dashboard_id()
    }
    /// <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
    pub fn snapshot_job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.snapshot_job_id(input.into());
        self
    }
    /// <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
    pub fn set_snapshot_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_snapshot_job_id(input);
        self
    }
    /// <p>An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a <code>DescribeDashboardSnapshotJob</code> while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.</p>
    pub fn get_snapshot_job_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_snapshot_job_id()
    }
    /// <p>A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.</p><important>
    /// <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
    /// </important>
    pub fn user_configuration(mut self, input: crate::types::SnapshotUserConfiguration) -> Self {
        self.inner = self.inner.user_configuration(input);
        self
    }
    /// <p>A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.</p><important>
    /// <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
    /// </important>
    pub fn set_user_configuration(mut self, input: ::std::option::Option<crate::types::SnapshotUserConfiguration>) -> Self {
        self.inner = self.inner.set_user_configuration(input);
        self
    }
    /// <p>A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.</p><important>
    /// <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
    /// </important>
    pub fn get_user_configuration(&self) -> &::std::option::Option<crate::types::SnapshotUserConfiguration> {
        self.inner.get_user_configuration()
    }
    /// <p>A structure that describes the configuration of the dashboard snapshot.</p>
    pub fn snapshot_configuration(mut self, input: crate::types::SnapshotConfiguration) -> Self {
        self.inner = self.inner.snapshot_configuration(input);
        self
    }
    /// <p>A structure that describes the configuration of the dashboard snapshot.</p>
    pub fn set_snapshot_configuration(mut self, input: ::std::option::Option<crate::types::SnapshotConfiguration>) -> Self {
        self.inner = self.inner.set_snapshot_configuration(input);
        self
    }
    /// <p>A structure that describes the configuration of the dashboard snapshot.</p>
    pub fn get_snapshot_configuration(&self) -> &::std::option::Option<crate::types::SnapshotConfiguration> {
        self.inner.get_snapshot_configuration()
    }
}