Class: Aws::SSM::Types::GetMaintenanceWindowExecutionTaskResult

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::GetMaintenanceWindowExecutionTaskResult

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:task_parameters]

Instance Attribute Summary

• #alarm_configuration ⇒ Types::AlarmConfiguration

  The details for the CloudWatch alarm you applied to your maintenance window task.

• #end_time ⇒ Time

  The time the task execution completed.

• #max_concurrency ⇒ String

  The defined maximum number of task executions that could be run in parallel.

• #max_errors ⇒ String

  The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

• #priority ⇒ Integer

  The priority of the task.

• #service_role ⇒ String

  The role that was assumed when running the task.

• #start_time ⇒ Time

  The time the task execution started.

• #status ⇒ String

  The status of the task.

• #status_details ⇒ String

  The details explaining the status.

• #task_arn ⇒ String

  The Amazon Resource Name (ARN) of the task that ran.

• #task_execution_id ⇒ String

  The ID of the specific task execution in the maintenance window task that was retrieved.

• #task_parameters ⇒ Array<Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>>

  The parameters passed to the task when it was run.

• #triggered_alarms ⇒ Array<Types::AlarmStateInformation>

  The CloudWatch alarms that were invoked by the maintenance window task.

• #type ⇒ String

  The type of task that was run.

• #window_execution_id ⇒ String

  The ID of the maintenance window execution that includes the task.

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

The details for the CloudWatch alarm you applied to your maintenance window task.

Returns:

• (Types::AlarmConfiguration)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#end_time ⇒ Time

The time the task execution completed.

Returns:

• (Time)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#max_concurrency ⇒ String

The defined maximum number of task executions that could be run in parallel.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#max_errors ⇒ String

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#priority ⇒ Integer

The priority of the task.

Returns:

• (Integer)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#service_role ⇒ String

The role that was assumed when running the task.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#start_time ⇒ Time

The time the task execution started.

Returns:

• (Time)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#status ⇒ String

The status of the task.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#status_details ⇒ String

The details explaining the status. Not available for all status values.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#task_arn ⇒ String

The Amazon Resource Name (ARN) of the task that ran.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#task_execution_id ⇒ String

The ID of the specific task execution in the maintenance window task that was retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#task_parameters ⇒ Array<Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>>

The parameters passed to the task when it was run.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

The map has the following format:

• Key: string, between 1 and 255 characters

• Value: an array of strings, each between 1 and 255 characters

Returns:

• (Array<Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#triggered_alarms ⇒ Array<Types::AlarmStateInformation>

The CloudWatch alarms that were invoked by the maintenance window task.

Returns:

• (Array<Types::AlarmStateInformation>)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#type ⇒ String

The type of task that was run.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end

#window_execution_id ⇒ String

The ID of the maintenance window execution that includes the task.

Returns:

• (String)

# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8596

class GetMaintenanceWindowExecutionTaskResult < Struct.new(
  :window_execution_id,
  :task_execution_id,
  :task_arn,
  :service_role,
  :type,
  :task_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :status,
  :status_details,
  :start_time,
  :end_time,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:task_parameters]
  include Aws::Structure
end