Class: Aws::SSM::Types::GetMaintenanceWindowTaskResult

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::GetMaintenanceWindowTaskResult

Defined in:

(unknown)

Overview

Returned by:

• Client#get_maintenance_window_task

See Also:

• AWS API Documentation

Instance Attribute Summary

• #description ⇒ String

  The retrieved task description.

• #logging_info ⇒ Types::LoggingInfo

  The location in Amazon S3 where the task results are logged.

• #max_concurrency ⇒ String

  The maximum number of targets allowed to run this task in parallel.

• #max_errors ⇒ String

  The maximum number of errors allowed before the task stops being scheduled.

• #name ⇒ String

  The retrieved task name.

• #priority ⇒ Integer

  The priority of the task when it runs.

• #service_role_arn ⇒ String

  The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

• #targets ⇒ Array<Types::Target>

  The targets where the task should run.

• #task_arn ⇒ String

  The resource that the task used during execution.

• #task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

  The parameters to pass to the task when it runs.

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

  The parameters to pass to the task when it runs.

• #task_type ⇒ String

  The type of task to run.

• #window_id ⇒ String

  The retrieved maintenance window ID.

• #window_task_id ⇒ String

  The retrieved maintenance window task ID.

Instance Attribute Details

#description ⇒ String

The retrieved task description.

Returns:

• (String) —

  The retrieved task description.

#logging_info ⇒ Types::LoggingInfo

The location in Amazon S3 where the task results are logged.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

Returns:

• (Types::LoggingInfo) —

  The location in Amazon S3 where the task results are logged.

#max_concurrency ⇒ String

The maximum number of targets allowed to run this task in parallel.

Returns:

• (String) —

  The maximum number of targets allowed to run this task in parallel.

#max_errors ⇒ String

The maximum number of errors allowed before the task stops being scheduled.

Returns:

• (String) —

  The maximum number of errors allowed before the task stops being scheduled.

#name ⇒ String

The retrieved task name.

Returns:

• (String) —

  The retrieved task name.

#priority ⇒ Integer

The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Returns:

• (Integer) —

  The priority of the task when it runs.

#service_role_arn ⇒ String

The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

Returns:

• (String) —

  The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

#targets ⇒ Array<Types::Target>

The targets where the task should run.

Returns:

• (Array<Types::Target>) —

  The targets where the task should run.

#task_arn ⇒ String

The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

Returns:

• (String) —

  The resource that the task used during execution.

#task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

The parameters to pass to the task when it runs.

Returns:

• (Types::MaintenanceWindowTaskInvocationParameters) —

  The parameters to pass to the task when it runs.

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

The parameters to pass to the task when it runs.

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.

Returns:

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

  The parameters to pass to the task when it runs.

#task_type ⇒ String

The type of task to run.

Possible values:

• RUN_COMMAND
• AUTOMATION
• STEP_FUNCTIONS
• LAMBDA

Returns:

• (String) —

  The type of task to run.

#window_id ⇒ String

The retrieved maintenance window ID.

Returns:

• (String) —

  The retrieved maintenance window ID.

#window_task_id ⇒ String

The retrieved maintenance window task ID.

Returns:

• (String) —

  The retrieved maintenance window task ID.