pub struct StartDashboardSnapshotJobFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to StartDashboardSnapshotJob.
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.
-
1 Paginated PDF
-
1 Excel workbook that includes up to 5 table or pivot table visuals
-
5 CSVs from table or pivot table visuals
The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.
StartDashboardSnapshotJob API throttling
Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. 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.
Common throttling scenarios
The following list provides information about the most commin throttling scenarios that can occur.
-
A large number of
SnapshotExportAPI jobs are running simultaneously on an Amazon Web Services account. When a newStartDashboardSnapshotJobis created and there are already 12 jobs with theRUNNINGstatus, the new job request fails and returns aLimitExceededExceptionerror. Wait for a current job to comlpete before you resubmit the new job. -
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a
ThrottlingExceptionis returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling
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 (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
-
The dataset type (Direct Query or SPICE).
-
The size of the dataset.
-
The complexity of the calculated fields that are used in the dashboard.
-
The number of visuals that are on a sheet.
-
The types of visuals that are on the sheet.
-
The number of formats and snapshots that are requested in the job configuration.
-
The size of the generated snapshots.
Implementations§
Source§impl StartDashboardSnapshotJobFluentBuilder
impl StartDashboardSnapshotJobFluentBuilder
Sourcepub fn as_input(&self) -> &StartDashboardSnapshotJobInputBuilder
pub fn as_input(&self) -> &StartDashboardSnapshotJobInputBuilder
Access the StartDashboardSnapshotJob as a reference.
Sourcepub async fn send(
self,
) -> Result<StartDashboardSnapshotJobOutput, SdkError<StartDashboardSnapshotJobError, HttpResponse>>
pub async fn send( self, ) -> Result<StartDashboardSnapshotJobOutput, SdkError<StartDashboardSnapshotJobError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<StartDashboardSnapshotJobOutput, StartDashboardSnapshotJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartDashboardSnapshotJobOutput, StartDashboardSnapshotJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn aws_account_id(self, input: impl Into<String>) -> Self
pub fn aws_account_id(self, input: impl Into<String>) -> Self
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
Sourcepub fn set_aws_account_id(self, input: Option<String>) -> Self
pub fn set_aws_account_id(self, input: Option<String>) -> Self
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
Sourcepub fn get_aws_account_id(&self) -> &Option<String>
pub fn get_aws_account_id(&self) -> &Option<String>
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
Sourcepub fn dashboard_id(self, input: impl Into<String>) -> Self
pub fn dashboard_id(self, input: impl Into<String>) -> Self
The ID of the dashboard that you want to start a snapshot job for.
Sourcepub fn set_dashboard_id(self, input: Option<String>) -> Self
pub fn set_dashboard_id(self, input: Option<String>) -> Self
The ID of the dashboard that you want to start a snapshot job for.
Sourcepub fn get_dashboard_id(&self) -> &Option<String>
pub fn get_dashboard_id(&self) -> &Option<String>
The ID of the dashboard that you want to start a snapshot job for.
Sourcepub fn snapshot_job_id(self, input: impl Into<String>) -> Self
pub fn snapshot_job_id(self, input: impl Into<String>) -> Self
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 DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
Sourcepub fn set_snapshot_job_id(self, input: Option<String>) -> Self
pub fn set_snapshot_job_id(self, input: Option<String>) -> Self
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 DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
Sourcepub fn get_snapshot_job_id(&self) -> &Option<String>
pub fn get_snapshot_job_id(&self) -> &Option<String>
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 DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
Sourcepub fn user_configuration(self, input: SnapshotUserConfiguration) -> Self
pub fn user_configuration(self, input: SnapshotUserConfiguration) -> Self
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.
Sourcepub fn set_user_configuration(
self,
input: Option<SnapshotUserConfiguration>,
) -> Self
pub fn set_user_configuration( self, input: Option<SnapshotUserConfiguration>, ) -> Self
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.
Sourcepub fn get_user_configuration(&self) -> &Option<SnapshotUserConfiguration>
pub fn get_user_configuration(&self) -> &Option<SnapshotUserConfiguration>
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.
Sourcepub fn snapshot_configuration(self, input: SnapshotConfiguration) -> Self
pub fn snapshot_configuration(self, input: SnapshotConfiguration) -> Self
A structure that describes the configuration of the dashboard snapshot.
Sourcepub fn set_snapshot_configuration(
self,
input: Option<SnapshotConfiguration>,
) -> Self
pub fn set_snapshot_configuration( self, input: Option<SnapshotConfiguration>, ) -> Self
A structure that describes the configuration of the dashboard snapshot.
Sourcepub fn get_snapshot_configuration(&self) -> &Option<SnapshotConfiguration>
pub fn get_snapshot_configuration(&self) -> &Option<SnapshotConfiguration>
A structure that describes the configuration of the dashboard snapshot.
Trait Implementations§
Source§impl Clone for StartDashboardSnapshotJobFluentBuilder
impl Clone for StartDashboardSnapshotJobFluentBuilder
Source§fn clone(&self) -> StartDashboardSnapshotJobFluentBuilder
fn clone(&self) -> StartDashboardSnapshotJobFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for StartDashboardSnapshotJobFluentBuilder
impl !RefUnwindSafe for StartDashboardSnapshotJobFluentBuilder
impl Send for StartDashboardSnapshotJobFluentBuilder
impl Sync for StartDashboardSnapshotJobFluentBuilder
impl Unpin for StartDashboardSnapshotJobFluentBuilder
impl !UnwindSafe for StartDashboardSnapshotJobFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);