Class: Aws::SSM::Types::GetMaintenanceWindowTaskResult
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::GetMaintenanceWindowTaskResult
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:task_parameters, :description]
Instance Attribute Summary collapse
-
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm you applied to your maintenance window task.
-
#cutoff_behavior ⇒ String
The action to take on tasks when the maintenance window cutoff time is reached.
-
#description ⇒ String
The retrieved task description.
-
#logging_info ⇒ Types::LoggingInfo
The location in Amazon Simple Storage Service (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 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.
-
#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
#alarm_configuration ⇒ Types::AlarmConfiguration
The details for the CloudWatch alarm you applied to your maintenance window task.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#cutoff_behavior ⇒ String
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.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#description ⇒ String
The retrieved task description.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#logging_info ⇒ Types::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>
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#max_concurrency ⇒ String
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>
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#max_errors ⇒ String
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>
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#name ⇒ String
The retrieved task name.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#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.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#service_role_arn ⇒ String
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.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The targets where the task should run.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#task_arn ⇒ String
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.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#task_invocation_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters
The parameters to pass to the task when it runs.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#task_parameters ⇒ Hash<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>
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#task_type ⇒ String
The type of task to run.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#window_id ⇒ String
The retrieved maintenance window ID.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |
#window_task_id ⇒ String
The retrieved maintenance window task ID.
8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/types.rb', line 8348 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, :alarm_configuration) SENSITIVE = [:task_parameters, :description] include Aws::Structure end |