amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Description

Adds a new task to a maintenance window.

Synopsis

Creating a Request

data RegisterTaskWithMaintenanceWindow Source #

See: newRegisterTaskWithMaintenanceWindow smart constructor.

Constructors

RegisterTaskWithMaintenanceWindow' 

Fields

  • alarmConfiguration :: Maybe AlarmConfiguration

    The CloudWatch alarm you want to apply to your maintenance window task.

  • clientToken :: Maybe Text

    User-provided idempotency token.

  • cutoffBehavior :: Maybe MaintenanceWindowTaskCutoffBehavior

    Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

    • CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
    • CANCEL_TASK:

      • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
      • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

      The status for tasks that are not completed is TIMED_OUT.

  • description :: Maybe (Sensitive Text)

    An optional description for the task.

  • loggingInfo :: Maybe LoggingInfo

    A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

    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.

  • maxConcurrency :: Maybe Text

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

    Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

    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. This value doesn't affect the running of your task.

  • maxErrors :: Maybe Text

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

    Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

    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. This value doesn't affect the running of your task.

  • name :: Maybe Text

    An optional name for the task.

  • priority :: Maybe Natural

    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.

  • serviceRoleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

  • targets :: Maybe [Target]

    The targets (either managed nodes or maintenance window targets).

    One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

    Specify managed nodes 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>
  • taskInvocationParameters :: Maybe MaintenanceWindowTaskInvocationParameters

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

  • taskParameters :: Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))

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

    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.

  • windowId :: Text

    The ID of the maintenance window the task should be added to.

  • taskArn :: Text

    The ARN of the task to run.

  • taskType :: MaintenanceWindowTaskType

    The type of task being registered.

Instances

Instances details
ToJSON RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

ToHeaders RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

ToPath RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

ToQuery RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

AWSRequest RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Generic RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Associated Types

type Rep RegisterTaskWithMaintenanceWindow :: Type -> Type #

Show RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

NFData RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Eq RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Hashable RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

type AWSResponse RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

type Rep RegisterTaskWithMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

type Rep RegisterTaskWithMaintenanceWindow = D1 ('MetaData "RegisterTaskWithMaintenanceWindow" "Amazonka.SSM.RegisterTaskWithMaintenanceWindow" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "RegisterTaskWithMaintenanceWindow'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "alarmConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlarmConfiguration)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "cutoffBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskCutoffBehavior)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "loggingInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingInfo)) :*: S1 ('MetaSel ('Just "maxConcurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxErrors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serviceRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :*: S1 ('MetaSel ('Just "taskInvocationParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskInvocationParameters)))) :*: ((S1 ('MetaSel ('Just "taskParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text (Sensitive MaintenanceWindowTaskParameterValueExpression))))) :*: S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "taskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "taskType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MaintenanceWindowTaskType))))))

newRegisterTaskWithMaintenanceWindow Source #

Create a value of RegisterTaskWithMaintenanceWindow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_alarmConfiguration - The CloudWatch alarm you want to apply to your maintenance window task.

$sel:clientToken:RegisterTaskWithMaintenanceWindow', registerTaskWithMaintenanceWindow_clientToken - User-provided idempotency token.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_cutoffBehavior - Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

  • CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
  • CANCEL_TASK:

    • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
    • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

    The status for tasks that are not completed is TIMED_OUT.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_description - An optional description for the task.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_loggingInfo - A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

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.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_maxConcurrency - The maximum number of targets this task can be run for, in parallel.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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. This value doesn't affect the running of your task.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_maxErrors - The maximum number of errors allowed before this task stops being scheduled.

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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. This value doesn't affect the running of your task.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_name - An optional name for the task.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_priority - 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.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_serviceRoleArn - The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_targets - The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes 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>

$sel:taskInvocationParameters:RegisterTaskWithMaintenanceWindow', registerTaskWithMaintenanceWindow_taskInvocationParameters - The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_taskParameters - The parameters that should be passed to the task when it is run.

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.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_windowId - The ID of the maintenance window the task should be added to.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_taskArn - The ARN of the task to run.

RegisterTaskWithMaintenanceWindow, registerTaskWithMaintenanceWindow_taskType - The type of task being registered.

Request Lenses

registerTaskWithMaintenanceWindow_alarmConfiguration :: Lens' RegisterTaskWithMaintenanceWindow (Maybe AlarmConfiguration) Source #

The CloudWatch alarm you want to apply to your maintenance window task.

registerTaskWithMaintenanceWindow_cutoffBehavior :: Lens' RegisterTaskWithMaintenanceWindow (Maybe MaintenanceWindowTaskCutoffBehavior) Source #

Indicates whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

  • CONTINUE_TASK: When the cutoff time is reached, any tasks that are running continue. The default value.
  • CANCEL_TASK:

    • For Automation, Lambda, Step Functions tasks: When the cutoff time is reached, any task invocations that are already running continue, but no new task invocations are started.
    • For Run Command tasks: When the cutoff time is reached, the system sends a CancelCommand operation that attempts to cancel the command associated with the task. However, there is no guarantee that the command will be terminated and the underlying process stopped.

    The status for tasks that are not completed is TIMED_OUT.

registerTaskWithMaintenanceWindow_loggingInfo :: Lens' RegisterTaskWithMaintenanceWindow (Maybe LoggingInfo) Source #

A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.

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.

registerTaskWithMaintenanceWindow_maxConcurrency :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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. This value doesn't affect the running of your task.

registerTaskWithMaintenanceWindow_maxErrors :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

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

Although this element is listed as "Required: No", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.

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. This value doesn't affect the running of your task.

registerTaskWithMaintenanceWindow_priority :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Natural) Source #

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.

registerTaskWithMaintenanceWindow_serviceRoleArn :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

For more information, see the following topics in the in the /Amazon Web Services Systems Manager User Guide/:

registerTaskWithMaintenanceWindow_targets :: Lens' RegisterTaskWithMaintenanceWindow (Maybe [Target]) Source #

The targets (either managed nodes or maintenance window targets).

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Specify managed nodes 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>

registerTaskWithMaintenanceWindow_taskInvocationParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe MaintenanceWindowTaskInvocationParameters) Source #

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

registerTaskWithMaintenanceWindow_taskParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) Source #

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

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.

registerTaskWithMaintenanceWindow_windowId :: Lens' RegisterTaskWithMaintenanceWindow Text Source #

The ID of the maintenance window the task should be added to.

Destructuring the Response

data RegisterTaskWithMaintenanceWindowResponse Source #

Constructors

RegisterTaskWithMaintenanceWindowResponse' 

Fields

Instances

Instances details
Generic RegisterTaskWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Read RegisterTaskWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Show RegisterTaskWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

NFData RegisterTaskWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

Eq RegisterTaskWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

type Rep RegisterTaskWithMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.RegisterTaskWithMaintenanceWindow

type Rep RegisterTaskWithMaintenanceWindowResponse = D1 ('MetaData "RegisterTaskWithMaintenanceWindowResponse" "Amazonka.SSM.RegisterTaskWithMaintenanceWindow" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "RegisterTaskWithMaintenanceWindowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "windowTaskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterTaskWithMaintenanceWindowResponse Source #

Create a value of RegisterTaskWithMaintenanceWindowResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RegisterTaskWithMaintenanceWindowResponse, registerTaskWithMaintenanceWindowResponse_windowTaskId - The ID of the task in the maintenance window.

$sel:httpStatus:RegisterTaskWithMaintenanceWindowResponse', registerTaskWithMaintenanceWindowResponse_httpStatus - The response's http status code.

Response Lenses