Struct aws_sdk_quicksight::operation::start_dashboard_snapshot_job::StartDashboardSnapshotJobInput

#[non_exhaustive]
pub struct StartDashboardSnapshotJobInput {
    pub aws_account_id: Option<String>,
    pub dashboard_id: Option<String>,
    pub snapshot_job_id: Option<String>,
    pub user_configuration: Option<SnapshotUserConfiguration>,
    pub snapshot_configuration: Option<SnapshotConfiguration>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aws_account_id: Option<String>

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

dashboard_id: Option<String>

The ID of the dashboard that you want to start a snapshot job for.

snapshot_job_id: 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.

user_configuration: 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.

snapshot_configuration: Option<SnapshotConfiguration>

A structure that describes the configuration of the dashboard snapshot.

Implementations

impl StartDashboardSnapshotJobInput

pub fn aws_account_id(&self) -> Option<&str>

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

pub fn dashboard_id(&self) -> Option<&str>

The ID of the dashboard that you want to start a snapshot job for.

pub fn snapshot_job_id(&self) -> Option<&str>

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.

pub fn 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.

pub fn snapshot_configuration(&self) -> Option<&SnapshotConfiguration>

A structure that describes the configuration of the dashboard snapshot.

impl StartDashboardSnapshotJobInput

pub fn builder() -> StartDashboardSnapshotJobInputBuilder

Creates a new builder-style object to manufacture StartDashboardSnapshotJobInput.

Trait Implementations

impl Clone for StartDashboardSnapshotJobInput

fn clone(&self) -> StartDashboardSnapshotJobInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartDashboardSnapshotJobInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StartDashboardSnapshotJobInput

fn eq(&self, other: &StartDashboardSnapshotJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartDashboardSnapshotJobInput