Class: Aws::QuickSight::Types::DescribeDashboardSnapshotJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::DescribeDashboardSnapshotJobResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) for the snapshot job.

• #aws_account_id ⇒ String

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

• #created_time ⇒ Time

  The time that the snapshot job was created.

• #dashboard_id ⇒ String

  The ID of the dashboard that you have started a snapshot job for.

• #job_status ⇒ String

  Indicates the status of a job.

• #last_updated_time ⇒ Time

  The time that the snapshot job status was last updated.

• #request_id ⇒ String

  The Amazon Web Services request ID for this operation.

• #snapshot_configuration ⇒ Types::SnapshotConfiguration

  The snapshot configuration of the job.

• #snapshot_job_id ⇒ String

  The ID of the job to be described.

• #status ⇒ Integer

  The HTTP status of the request.

• #user_configuration ⇒ Types::SnapshotUserConfigurationRedacted

  The user configuration for the snapshot job.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

• (String)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#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 20120

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ Time

The time that the snapshot job was created.

Returns:

• (Time)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_id ⇒ String

The ID of the dashboard that you have started a snapshot job for.

Returns:

• (String)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#job_status ⇒ String

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

• COMPLETED - The job was completed successfully.

• FAILED - The job failed to execute.

• QUEUED - The job is queued and hasn't started yet.

• RUNNING - The job is still running.

Returns:

• (String)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Time

The time that the snapshot job status was last updated.

Returns:

• (Time)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#request_id ⇒ String

The Amazon Web Services request ID for this operation.

Returns:

• (String)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_configuration ⇒ Types::SnapshotConfiguration

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

Returns:

• (Types::SnapshotConfiguration)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_job_id ⇒ String

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

• (String)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Integer

The HTTP status of the request

Returns:

• (Integer)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#user_configuration ⇒ Types::SnapshotUserConfigurationRedacted

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

Returns:

• (Types::SnapshotUserConfigurationRedacted)

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

class DescribeDashboardSnapshotJobResponse < Struct.new(
  :aws_account_id,
  :dashboard_id,
  :snapshot_job_id,
  :user_configuration,
  :snapshot_configuration,
  :arn,
  :job_status,
  :created_time,
  :last_updated_time,
  :request_id,
  :status)
  SENSITIVE = []
  include Aws::Structure
end