Class: Aws::CloudWatchLogs::Types::GetScheduledQueryResponse

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::GetScheduledQueryResponse

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Integer

  The time when the scheduled query was created, in Unix epoch time.

• #description ⇒ String

  The description of the scheduled query.

• #destination_configuration ⇒ Types::DestinationConfiguration

  Configuration for destinations where the query results are delivered.

• #execution_role_arn ⇒ String

  The ARN of the IAM role used to execute the scheduled query.

• #last_execution_status ⇒ String

  The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).

• #last_triggered_time ⇒ Integer

  The time when the scheduled query was last executed, in Unix epoch time.

• #last_updated_time ⇒ Integer

  The time when the scheduled query was last updated, in Unix epoch time.

• #log_group_identifiers ⇒ Array<String>

  The log group identifiers being queried by the scheduled query.

• #name ⇒ String

  The name of the scheduled query.

• #query_language ⇒ String

  The query language used by the scheduled query (LogsQL, PPL, or SQL).

• #query_string ⇒ String

  The CloudWatch Logs Insights query string being executed.

• #schedule_end_time ⇒ Integer

  The end time for the query schedule in Unix epoch time.

• #schedule_expression ⇒ String

  The cron expression that defines when the scheduled query runs.

• #schedule_start_time ⇒ Integer

  The start time for the query schedule in Unix epoch time.

• #scheduled_query_arn ⇒ String

  The Amazon Resource Name (ARN) of the scheduled query.

• #start_time_offset ⇒ Integer

  Time offset in seconds from the execution time for the start of the query time range.

• #state ⇒ String

  The current state of the scheduled query (ENABLED or DISABLED).

• #timezone ⇒ String

  The timezone in which the schedule expression is evaluated.

Instance Attribute Details

#creation_time ⇒ Integer

The time when the scheduled query was created, in Unix epoch time.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the scheduled query.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configuration ⇒ Types::DestinationConfiguration

Configuration for destinations where the query results are delivered.

Returns:

• (Types::DestinationConfiguration)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

The ARN of the IAM role used to execute the scheduled query.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_execution_status ⇒ String

The status of the last executed query (Running, Complete, Failed, Timeout, or InvalidQuery).

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_triggered_time ⇒ Integer

The time when the scheduled query was last executed, in Unix epoch time.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time ⇒ Integer

The time when the scheduled query was last updated, in Unix epoch time.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifiers ⇒ Array<String>

The log group identifiers being queried by the scheduled query.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the scheduled query.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#query_language ⇒ String

The query language used by the scheduled query (LogsQL, PPL, or SQL).

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The CloudWatch Logs Insights query string being executed.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_end_time ⇒ Integer

The end time for the query schedule in Unix epoch time.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

The cron expression that defines when the scheduled query runs.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_start_time ⇒ Integer

The start time for the query schedule in Unix epoch time.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_query_arn ⇒ String

The Amazon Resource Name (ARN) of the scheduled query.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time_offset ⇒ Integer

Time offset in seconds from the execution time for the start of the query time range.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the scheduled query (ENABLED or DISABLED).

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ String

The timezone in which the schedule expression is evaluated.

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 3875

class GetScheduledQueryResponse < Struct.new(
  :scheduled_query_arn,
  :name,
  :description,
  :query_language,
  :query_string,
  :log_group_identifiers,
  :schedule_expression,
  :timezone,
  :start_time_offset,
  :destination_configuration,
  :state,
  :last_triggered_time,
  :last_execution_status,
  :schedule_start_time,
  :schedule_end_time,
  :execution_role_arn,
  :creation_time,
  :last_updated_time)
  SENSITIVE = []
  include Aws::Structure
end