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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:task_parameters, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#cutoff_behaviorString

The action to take on tasks when the maintenance window cutoff time is reached. `CONTINUE_TASK` means that tasks continue to run. For Automation, Lambda, Step Functions tasks, `CANCEL_TASK` means that currently running task invocations continue, but no new task invocations are started. For Run Command tasks, `CANCEL_TASK` means the system attempts to stop the task by sending a `CancelCommand` operation.

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#descriptionString

The retrieved task description.

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

The location in Amazon Simple Storage Service (Amazon S3) where the task results are logged.

<note markdown=“1”> `LoggingInfo` has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the `OutputS3BucketName` and `OutputS3KeyPrefix` options in the `TaskInvocationParameters` structure. For information about how Amazon Web Services Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

</note>

Returns:


9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_concurrencyString

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

<note markdown=“1”> For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

</note>

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#max_errorsString

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

<note markdown=“1”> For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.

</note>

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#nameString

The retrieved task name.

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#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)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#service_role_arnString

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

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets where the task should run.

Returns:


9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_arnString

The resource that the task used during execution. For `RUN_COMMAND` and `AUTOMATION` task types, the value of `TaskArn` is the SSM 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)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_invocation_parametersTypes::MaintenanceWindowTaskInvocationParameters

The parameters to pass to the task when it runs.


9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

The parameters to pass to the task when it runs.

<note markdown=“1”> `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.

</note>

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#task_typeString

The type of task to run.

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_idString

The retrieved maintenance window ID.

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end

#window_task_idString

The retrieved maintenance window task ID.

Returns:

  • (String)

9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
# File 'lib/aws-sdk-ssm/types.rb', line 9297

class GetMaintenanceWindowTaskResult < Struct.new(
  :window_id,
  :window_task_id,
  :targets,
  :task_arn,
  :service_role_arn,
  :task_type,
  :task_parameters,
  :task_invocation_parameters,
  :priority,
  :max_concurrency,
  :max_errors,
  :logging_info,
  :name,
  :description,
  :cutoff_behavior)
  SENSITIVE = [:task_parameters, :description]
  include Aws::Structure
end