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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


35352
35353
35354
35355
35356
35357
35358
35359
35360
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 35352

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) 


35352
35353
35354
35355
35356
35357
35358
35359
35360
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 35352

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:



35352
35353
35354
35355
35356
35357
35358
35359
35360
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 35352

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) 


35352
35353
35354
35355
35356
35357
35358
35359
35360
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 35352

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:



35352
35353
35354
35355
35356
35357
35358
35359
35360
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 35352

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