StartDashboardSnapshotJob

Source: src/AWS/QuickSight/StartDashboardSnapshotJob.ts

Runtime binding for quicksight:StartDashboardSnapshotJob.

Starts an asynchronous snapshot job that exports the bound Dashboard as a PDF, CSV, or Excel file delivered to S3 or returned as a download URL. AwsAccountId and DashboardId are injected from the binding; poll the job with AWS.QuickSight.DescribeDashboardSnapshotJob. Provide the implementation with Effect.provide(AWS.QuickSight.StartDashboardSnapshotJobHttp).

Dashboard Snapshots

// init — bind the operation to the dashboard
const startSnapshotJob =
  yield* AWS.QuickSight.StartDashboardSnapshotJob(dashboard);

// runtime
const { SnapshotJobId } = yield* startSnapshotJob({
  SnapshotJobId: crypto.randomUUID(),
  UserConfiguration: { AnonymousUsers: [] },
  SnapshotConfiguration: {
    FileGroups: [{ Files: [{ FormatType: "PDF" }] }],
  },
});