aws_sdk_quicksight/operation/start_dashboard_snapshot_job/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_dashboard_snapshot_job::_start_dashboard_snapshot_job_output::StartDashboardSnapshotJobOutputBuilder;
3
4pub use crate::operation::start_dashboard_snapshot_job::_start_dashboard_snapshot_job_input::StartDashboardSnapshotJobInputBuilder;
5
6impl crate::operation::start_dashboard_snapshot_job::builders::StartDashboardSnapshotJobInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.start_dashboard_snapshot_job();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `StartDashboardSnapshotJob`.
24///
25/// <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>
26/// <ul>
27/// <li>
28/// <p>1 Paginated PDF</p></li>
29/// <li>
30/// <p>1 Excel workbook that includes up to 5 table or pivot table visuals</p></li>
31/// <li>
32/// <p>5 CSVs from table or pivot table visuals</p></li>
33/// </ul>
34/// <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>
35/// <p><b>StartDashboardSnapshotJob API throttling</b></p>
36/// <p>Amazon QuickSight 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, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.</p>
37/// <p><b>Common throttling scenarios</b></p>
38/// <p>The following list provides information about the most commin throttling scenarios that can occur.</p>
39/// <ul>
40/// <li>
41/// <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>
42/// <li>
43/// <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 Amazon QuickSight API in one second, a <code>ThrottlingException</code> is returned.</p></li>
44/// </ul>
45/// <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>
46/// <p><b>Best practices to handle throttling</b></p>
47/// <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 Amazon QuickSight 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>
48/// <p>The time that it takes to process a job can be impacted by the following factors:</p>
49/// <ul>
50/// <li>
51/// <p>The dataset type (Direct Query or SPICE).</p></li>
52/// <li>
53/// <p>The size of the dataset.</p></li>
54/// <li>
55/// <p>The complexity of the calculated fields that are used in the dashboard.</p></li>
56/// <li>
57/// <p>The number of visuals that are on a sheet.</p></li>
58/// <li>
59/// <p>The types of visuals that are on the sheet.</p></li>
60/// <li>
61/// <p>The number of formats and snapshots that are requested in the job configuration.</p></li>
62/// <li>
63/// <p>The size of the generated snapshots.</p></li>
64/// </ul>
65#[derive(::std::clone::Clone, ::std::fmt::Debug)]
66pub struct StartDashboardSnapshotJobFluentBuilder {
67 handle: ::std::sync::Arc<crate::client::Handle>,
68 inner: crate::operation::start_dashboard_snapshot_job::builders::StartDashboardSnapshotJobInputBuilder,
69 config_override: ::std::option::Option<crate::config::Builder>,
70}
71impl
72 crate::client::customize::internal::CustomizableSend<
73 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
74 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
75 > for StartDashboardSnapshotJobFluentBuilder
76{
77 fn send(
78 self,
79 config_override: crate::config::Builder,
80 ) -> crate::client::customize::internal::BoxFuture<
81 crate::client::customize::internal::SendResult<
82 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
83 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
84 >,
85 > {
86 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
87 }
88}
89impl StartDashboardSnapshotJobFluentBuilder {
90 /// Creates a new `StartDashboardSnapshotJobFluentBuilder`.
91 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
92 Self {
93 handle,
94 inner: ::std::default::Default::default(),
95 config_override: ::std::option::Option::None,
96 }
97 }
98 /// Access the StartDashboardSnapshotJob as a reference.
99 pub fn as_input(&self) -> &crate::operation::start_dashboard_snapshot_job::builders::StartDashboardSnapshotJobInputBuilder {
100 &self.inner
101 }
102 /// Sends the request and returns the response.
103 ///
104 /// If an error occurs, an `SdkError` will be returned with additional details that
105 /// can be matched against.
106 ///
107 /// By default, any retryable failures will be retried twice. Retry behavior
108 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
109 /// set when configuring the client.
110 pub async fn send(
111 self,
112 ) -> ::std::result::Result<
113 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
114 ::aws_smithy_runtime_api::client::result::SdkError<
115 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
116 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
117 >,
118 > {
119 let input = self
120 .inner
121 .build()
122 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
123 let runtime_plugins = crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJob::operation_runtime_plugins(
124 self.handle.runtime_plugins.clone(),
125 &self.handle.conf,
126 self.config_override,
127 );
128 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJob::orchestrate(&runtime_plugins, input).await
129 }
130
131 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
132 pub fn customize(
133 self,
134 ) -> crate::client::customize::CustomizableOperation<
135 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobOutput,
136 crate::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobError,
137 Self,
138 > {
139 crate::client::customize::CustomizableOperation::new(self)
140 }
141 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
142 self.set_config_override(::std::option::Option::Some(config_override.into()));
143 self
144 }
145
146 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
147 self.config_override = config_override;
148 self
149 }
150 /// <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
151 pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
152 self.inner = self.inner.aws_account_id(input.into());
153 self
154 }
155 /// <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
156 pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157 self.inner = self.inner.set_aws_account_id(input);
158 self
159 }
160 /// <p>The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.</p>
161 pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
162 self.inner.get_aws_account_id()
163 }
164 /// <p>The ID of the dashboard that you want to start a snapshot job for.</p>
165 pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166 self.inner = self.inner.dashboard_id(input.into());
167 self
168 }
169 /// <p>The ID of the dashboard that you want to start a snapshot job for.</p>
170 pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
171 self.inner = self.inner.set_dashboard_id(input);
172 self
173 }
174 /// <p>The ID of the dashboard that you want to start a snapshot job for.</p>
175 pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
176 self.inner.get_dashboard_id()
177 }
178 /// <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>
179 pub fn snapshot_job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
180 self.inner = self.inner.snapshot_job_id(input.into());
181 self
182 }
183 /// <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>
184 pub fn set_snapshot_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
185 self.inner = self.inner.set_snapshot_job_id(input);
186 self
187 }
188 /// <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>
189 pub fn get_snapshot_job_id(&self) -> &::std::option::Option<::std::string::String> {
190 self.inner.get_snapshot_job_id()
191 }
192 /// <p>A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.</p>
193 pub fn user_configuration(mut self, input: crate::types::SnapshotUserConfiguration) -> Self {
194 self.inner = self.inner.user_configuration(input);
195 self
196 }
197 /// <p>A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.</p>
198 pub fn set_user_configuration(mut self, input: ::std::option::Option<crate::types::SnapshotUserConfiguration>) -> Self {
199 self.inner = self.inner.set_user_configuration(input);
200 self
201 }
202 /// <p>A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.</p>
203 pub fn get_user_configuration(&self) -> &::std::option::Option<crate::types::SnapshotUserConfiguration> {
204 self.inner.get_user_configuration()
205 }
206 /// <p>A structure that describes the configuration of the dashboard snapshot.</p>
207 pub fn snapshot_configuration(mut self, input: crate::types::SnapshotConfiguration) -> Self {
208 self.inner = self.inner.snapshot_configuration(input);
209 self
210 }
211 /// <p>A structure that describes the configuration of the dashboard snapshot.</p>
212 pub fn set_snapshot_configuration(mut self, input: ::std::option::Option<crate::types::SnapshotConfiguration>) -> Self {
213 self.inner = self.inner.set_snapshot_configuration(input);
214 self
215 }
216 /// <p>A structure that describes the configuration of the dashboard snapshot.</p>
217 pub fn get_snapshot_configuration(&self) -> &::std::option::Option<crate::types::SnapshotConfiguration> {
218 self.inner.get_snapshot_configuration()
219 }
220}