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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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

Returns:

  • (String)


31075
31076
31077
31078
31079
31080
31081
31082
31083
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 31075

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

#dashboard_idString

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

Returns:

  • (String)


31075
31076
31077
31078
31079
31080
31081
31082
31083
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 31075

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

#snapshot_configurationTypes::SnapshotConfiguration

A structure that describes the configuration of the dashboard snapshot.



31075
31076
31077
31078
31079
31080
31081
31082
31083
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 31075

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

#snapshot_job_idString

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)


31075
31076
31077
31078
31079
31080
31081
31082
31083
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 31075

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

#user_configurationTypes::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.



31075
31076
31077
31078
31079
31080
31081
31082
31083
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 31075

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