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

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

Overview

Structure that describes scheduled query.

Constant Summary collapse

SENSITIVE =
[:query_string]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

Scheduled query ARN.

Returns:

  • (String)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_timeTime

Creation time of the scheduled query.

Returns:

  • (Time)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_configurationTypes::ErrorReportConfiguration

Error-reporting configuration for the scheduled query.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_idString

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

Returns:

  • (String)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_summaryTypes::ScheduledQueryRunSummary

Runtime summary for the last scheduled query run.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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

#nameString

Name of the scheduled query.

Returns:

  • (String)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_timeTime

The next time the scheduled query is scheduled to run.

Returns:

  • (Time)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_configurationTypes::NotificationConfiguration

Notification configuration.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_timeTime

Last time the query was run.

Returns:

  • (Time)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_stringString

The query to be run.

Returns:

  • (String)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_runsArray<Types::ScheduledQueryRunSummary>

Runtime summary for the last five failed scheduled query runs.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_configurationTypes::ScheduleConfiguration

Schedule configuration.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_arnString

IAM role that Timestream uses to run the schedule query.

Returns:

  • (String)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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

#stateString

State of the scheduled query.

Returns:

  • (String)


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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_configurationTypes::TargetConfiguration

Scheduled query target store configuration.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-timestreamquery/lib/aws-sdk-timestreamquery/types.rb', line 1081

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