paws.analytics (version 0.7.0)

quicksight_start_dashboard_snapshot_job: Starts an asynchronous job that generates a snapshot of a dashboard's output

Description

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.

See https://www.paws-r-sdk.com/docs/quicksight_start_dashboard_snapshot_job/ for full documentation.

Usage

quicksight_start_dashboard_snapshot_job(
  AwsAccountId,
  DashboardId,
  SnapshotJobId,
  UserConfiguration,
  SnapshotConfiguration
)

Arguments

AwsAccountId

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

DashboardId

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

SnapshotJobId

[required] 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 describe_dashboard_snapshot_job while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

UserConfiguration

[required] 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.

SnapshotConfiguration

[required] A structure that describes the configuration of the dashboard snapshot.