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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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.

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:



6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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 runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

Returns:

  • (Integer)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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

Returns:



6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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



6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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



6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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

Returns:

  • (String)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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)


6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6824

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