Class: Aws::QuickSight::Types::StartDashboardSnapshotJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::StartDashboardSnapshotJobRequest

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aws_account_id ⇒ String

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

• #dashboard_id ⇒ String

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

• #snapshot_configuration ⇒ Types::SnapshotConfiguration

  A structure that describes the configuration of the dashboard snapshot.

• #snapshot_job_id ⇒ String

  An ID for the dashboard snapshot job.

• #user_configuration ⇒ Types::SnapshotUserConfiguration

  A structure that contains information about the users that the dashboard snapshot is generated for.

Instance Attribute Details

#aws_account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 43574

class StartDashboardSnapshotJobRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 43574

class StartDashboardSnapshotJobRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_configuration ⇒ Types::SnapshotConfiguration

A structure that describes the configuration of the dashboard snapshot.

Returns:

• (Types::SnapshotConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 43574

class StartDashboardSnapshotJobRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_job_id ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 43574

class StartDashboardSnapshotJobRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_configuration ⇒ Types::SnapshotUserConfiguration

A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.

When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.

Returns:

• (Types::SnapshotUserConfiguration)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 43574

class StartDashboardSnapshotJobRequest < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration)
  SENSITIVE = []
  include Aws::Structure
end