Class: Aws::TimestreamQuery::Types::ScheduledQueryDescription

Inherits:

Struct

• Object
• Struct
• Aws::TimestreamQuery::Types::ScheduledQueryDescription

Includes:

Structure

Defined in:

lib/aws-sdk-timestreamquery/types.rb

Overview

Structure that describes scheduled query.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:query_string]

Instance Attribute Summary

• #arn ⇒ String

  Scheduled query ARN.

• #creation_time ⇒ Time

  Creation time of the scheduled query.

• #error_report_configuration ⇒ Types::ErrorReportConfiguration

  Error-reporting configuration for the scheduled query.

• #kms_key_id ⇒ String

  A customer provided KMS key used to encrypt the scheduled query resource.

• #last_run_summary ⇒ Types::ScheduledQueryRunSummary

  Runtime summary for the last scheduled query run.

• #name ⇒ String

  Name of the scheduled query.

• #next_invocation_time ⇒ Time

  The next time the scheduled query is scheduled to run.

• #notification_configuration ⇒ Types::NotificationConfiguration

  Notification configuration.

• #previous_invocation_time ⇒ Time

  Last time the query was run.

• #query_string ⇒ String

  The query to be run.

• #recently_failed_runs ⇒ Array<Types::ScheduledQueryRunSummary>

  Runtime summary for the last five failed scheduled query runs.

• #schedule_configuration ⇒ Types::ScheduleConfiguration

  Schedule configuration.

• #scheduled_query_execution_role_arn ⇒ String

  IAM role that Timestream uses to run the schedule query.

• #state ⇒ String

  State of the scheduled query.

• #target_configuration ⇒ Types::TargetConfiguration

  Scheduled query target store configuration.

Instance Attribute Details

#arn ⇒ String

Scheduled query ARN.

Returns:

• (String)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#creation_time ⇒ Time

Creation time of the scheduled query.

Returns:

• (Time)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#error_report_configuration ⇒ Types::ErrorReportConfiguration

Error-reporting configuration for the scheduled query.

Returns:

• (Types::ErrorReportConfiguration)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#kms_key_id ⇒ String

A customer provided KMS key used to encrypt the scheduled query resource.

Returns:

• (String)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#last_run_summary ⇒ Types::ScheduledQueryRunSummary

Runtime summary for the last scheduled query run.

Returns:

• (Types::ScheduledQueryRunSummary)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#name ⇒ String

Name of the scheduled query.

Returns:

• (String)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#next_invocation_time ⇒ Time

The next time the scheduled query is scheduled to run.

Returns:

• (Time)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#notification_configuration ⇒ Types::NotificationConfiguration

Notification configuration.

Returns:

• (Types::NotificationConfiguration)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#previous_invocation_time ⇒ Time

Last time the query was run.

Returns:

• (Time)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#query_string ⇒ String

The query to be run.

Returns:

• (String)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#recently_failed_runs ⇒ Array<Types::ScheduledQueryRunSummary>

Runtime summary for the last five failed scheduled query runs.

Returns:

• (Array<Types::ScheduledQueryRunSummary>)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#schedule_configuration ⇒ Types::ScheduleConfiguration

Schedule configuration.

Returns:

• (Types::ScheduleConfiguration)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#scheduled_query_execution_role_arn ⇒ String

IAM role that Timestream uses to run the schedule query.

Returns:

• (String)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#state ⇒ String

State of the scheduled query.

Returns:

• (String)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end

#target_configuration ⇒ Types::TargetConfiguration

Scheduled query target store configuration.

Returns:

• (Types::TargetConfiguration)

# File 'lib/aws-sdk-timestreamquery/types.rb', line 1541

class ScheduledQueryDescription < Struct.new(
  :arn,
  :name,
  :query_string,
  :creation_time,
  :state,
  :previous_invocation_time,
  :next_invocation_time,
  :schedule_configuration,
  :notification_configuration,
  :target_configuration,
  :scheduled_query_execution_role_arn,
  :kms_key_id,
  :error_report_configuration,
  :last_run_summary,
  :recently_failed_runs)
  SENSITIVE = [:query_string]
  include Aws::Structure
end