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

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 executes.

• #service_role_arn ⇒ String

  The IAM service role to assume during task execution.

• #targets ⇒ Array<Types::Target>

  The targets where the task should execute.

• #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 executes.

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

  The parameters to pass to the task when it executes.

• #task_type ⇒ String

  The type of task to execute.

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

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_info ⇒ Types::LoggingInfo

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

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

</note>

Returns:

• (Types::LoggingInfo)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_concurrency ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_errors ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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

#name ⇒ String

The retrieved task name.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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

#priority ⇒ Integer

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)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_arn ⇒ String

The IAM service role to assume during task execution.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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

#targets ⇒ Array<Types::Target>

The targets where the task should execute.

Returns:

• (Array<Types::Target>)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_parameters ⇒ Types::MaintenanceWindowTaskInvocationParameters

The parameters to pass to the task when it executes.

Returns:

• (Types::MaintenanceWindowTaskInvocationParameters)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_parameters ⇒ Hash<String,Types::MaintenanceWindowTaskParameterValueExpression>

The parameters to pass to the task when it executes.

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

Returns:

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

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_type ⇒ String

The type of task to execute.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_id ⇒ String

The retrieved Maintenance Window ID.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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_id ⇒ String

The retrieved Maintenance Window task ID.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 6672

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