You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The retrieved task description.

Returns:

  • (String)

    The retrieved task description.

#logging_infoTypes::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:

#max_concurrencyString

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_errorsString

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.

#nameString

The retrieved task name.

Returns:

  • (String)

    The retrieved task name.

#priorityInteger

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_arnString

The IAM service role to assume during task execution.

Returns:

  • (String)

    The IAM service role to assume during task execution.

#targetsArray<Types::Target>

The targets where the task should run.

Returns:

  • (Array<Types::Target>)

    The targets where the task should run.

#task_arnString

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_FUNCTION tasks, the value is the state machine ARN.

Returns:

  • (String)

    The resource that the task used during execution.

#task_invocation_parametersTypes::MaintenanceWindowTaskInvocationParameters

The parameters to pass to the task when it runs.

Returns:

#task_parametersHash<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:

#task_typeString

The type of task to run.

Possible values:

  • RUN_COMMAND
  • AUTOMATION
  • STEP_FUNCTIONS
  • LAMBDA

Returns:

  • (String)

    The type of task to run.

#window_idString

The retrieved Maintenance Window ID.

Returns:

  • (String)

    The retrieved Maintenance Window ID.

#window_task_idString

The retrieved Maintenance Window task ID.

Returns:

  • (String)

    The retrieved Maintenance Window task ID.