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

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The retrieved task description.

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

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

Returns:



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#max_concurrencyString

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

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#max_errorsString

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

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#nameString

The retrieved task name.

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#priorityInteger

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

Returns:

  • (Integer)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#service_role_arnString

The IAM service role to assume during task execution.

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets where the task should execute.

Returns:



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#task_arnString

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


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#task_invocation_parametersTypes::MaintenanceWindowTaskInvocationParameters

The parameters to pass to the task when it executes.



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#task_parametersHash<String,Types::MaintenanceWindowTaskParameterValueExpression>

The parameters to pass to the task when it executes.



4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#task_typeString

The type of task to execute.

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#window_idString

The retrieved Maintenance Window ID.

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end

#window_task_idString

The retrieved Maintenance Window task ID.

Returns:

  • (String)


4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4847

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)
  include Aws::Structure
end