amazonka-ssm-1.6.1: Amazon Simple Systems Manager (SSM) SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

Synopsis

# Creating a Request

Arguments

 :: Text rtwmwWindowId -> Text rtwmwTaskARN -> Text rtwmwServiceRoleARN -> MaintenanceWindowTaskType rtwmwTaskType -> Text rtwmwMaxConcurrency -> Text rtwmwMaxErrors -> RegisterTaskWithMaintenanceWindow

Creates a value of RegisterTaskWithMaintenanceWindow with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rtwmwTaskParameters - The parameters that should be passed to the task when it is executed.
• rtwmwPriority - The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.
• rtwmwClientToken - User-provided idempotency token.
• rtwmwTaskInvocationParameters - The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
• rtwmwName - An optional name for the task.
• rtwmwLoggingInfo - A structure containing information about an Amazon S3 bucket to write instance-level logs to.
• rtwmwDescription - An optional description for the task.
• rtwmwWindowId - The ID of the Maintenance Window the task should be added to.
• rtwmwTargets - The targets (either instances or Maintenance Window targets). Specify instances using the following format: Key=InstanceIds,Values=instance-id-1,instance-id-2 Specify Maintenance Window targets using the following format: Key=WindowTargetIds,Values=window-target-id-1,window-target-id-2
• rtwmwTaskARN - The ARN of the task to execute
• rtwmwServiceRoleARN - The role that should be assumed when executing the task.
• rtwmwTaskType - The type of task being registered.
• rtwmwMaxConcurrency - The maximum number of targets this task can be run for in parallel.
• rtwmwMaxErrors - The maximum number of errors allowed before this task stops being scheduled.

See: registerTaskWithMaintenanceWindow smart constructor.

Instances

# Request Lenses

The parameters that should be passed to the task when it is executed.

The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

User-provided idempotency token.

The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

An optional name for the task.

A structure containing information about an Amazon S3 bucket to write instance-level logs to.

An optional description for the task.

The ID of the Maintenance Window the task should be added to.

The targets (either instances or Maintenance Window targets). Specify instances using the following format: Key=InstanceIds,Values=instance-id-1,instance-id-2 Specify Maintenance Window targets using the following format: Key=WindowTargetIds,Values=window-target-id-1,window-target-id-2

The ARN of the task to execute

The role that should be assumed when executing the task.

The type of task being registered.

The maximum number of targets this task can be run for in parallel.

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

# Destructuring the Response

Arguments

 :: Int rtwmwrsResponseStatus -> RegisterTaskWithMaintenanceWindowResponse

Creates a value of RegisterTaskWithMaintenanceWindowResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rtwmwrsWindowTaskId - The id of the task in the Maintenance Window.
• rtwmwrsResponseStatus - -- | The response status code.

See: registerTaskWithMaintenanceWindowResponse smart constructor.

Instances