Network.AWS.SSM.UpdateMaintenanceWindowTask

Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:

Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

Service role ARN.

Task parameters.

Task priority.

Task MaxConcurrency and MaxErrors.

Log location.

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

Creating a Request

updateMaintenanceWindowTask

Arguments

:: Text

umwtWindowId

-> Text

umwtWindowTaskId

-> UpdateMaintenanceWindowTask

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

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

• umwtServiceRoleARN - The IAM service role ARN to modify. The system assumes this role during task execution.
• umwtReplace - If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.
• umwtTaskParameters - The parameters to modify. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters
• umwtPriority - The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
• umwtTaskARN - The task ARN to modify.
• umwtMaxErrors - The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
• umwtTaskInvocationParameters - The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.
• umwtName - The new task name to specify.
• umwtTargets - The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.
• umwtLoggingInfo - The new logging location in Amazon S3 to specify.
• umwtDescription - The new task description to specify.
• umwtMaxConcurrency - The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
• umwtWindowId - The Maintenance Window ID that contains the task to modify.
• umwtWindowTaskId - The task ID to modify.

data UpdateMaintenanceWindowTask

See: updateMaintenanceWindowTask smart constructor.

Instances

Eq UpdateMaintenanceWindowTask

Methods

(==) :: UpdateMaintenanceWindowTask -> UpdateMaintenanceWindowTask -> Bool

(/=) :: UpdateMaintenanceWindowTask -> UpdateMaintenanceWindowTask -> Bool

Data UpdateMaintenanceWindowTask

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateMaintenanceWindowTask -> c UpdateMaintenanceWindowTask

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateMaintenanceWindowTask

toConstr :: UpdateMaintenanceWindowTask -> Constr

dataTypeOf :: UpdateMaintenanceWindowTask -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateMaintenanceWindowTask)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateMaintenanceWindowTask)

gmapT :: (forall b. Data b => b -> b) -> UpdateMaintenanceWindowTask -> UpdateMaintenanceWindowTask

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateMaintenanceWindowTask -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateMaintenanceWindowTask -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateMaintenanceWindowTask -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateMaintenanceWindowTask -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateMaintenanceWindowTask -> m UpdateMaintenanceWindowTask

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateMaintenanceWindowTask -> m UpdateMaintenanceWindowTask

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateMaintenanceWindowTask -> m UpdateMaintenanceWindowTask

Show UpdateMaintenanceWindowTask

Methods

showsPrec :: Int -> UpdateMaintenanceWindowTask -> ShowS

show :: UpdateMaintenanceWindowTask -> String

showList :: [UpdateMaintenanceWindowTask] -> ShowS

Generic UpdateMaintenanceWindowTask

Associated Types

type Rep UpdateMaintenanceWindowTask :: * -> *

Methods

from :: UpdateMaintenanceWindowTask -> Rep UpdateMaintenanceWindowTask x

to :: Rep UpdateMaintenanceWindowTask x -> UpdateMaintenanceWindowTask

Hashable UpdateMaintenanceWindowTask

Methods

hashWithSalt :: Int -> UpdateMaintenanceWindowTask -> Int

hash :: UpdateMaintenanceWindowTask -> Int

ToJSON UpdateMaintenanceWindowTask

Methods

toJSON :: UpdateMaintenanceWindowTask -> Value

toEncoding :: UpdateMaintenanceWindowTask -> Encoding

toJSONList :: [UpdateMaintenanceWindowTask] -> Value

toEncodingList :: [UpdateMaintenanceWindowTask] -> Encoding

NFData UpdateMaintenanceWindowTask

Methods

rnf :: UpdateMaintenanceWindowTask -> ()

AWSRequest UpdateMaintenanceWindowTask

Associated Types

type Rs UpdateMaintenanceWindowTask :: *

Methods

request :: UpdateMaintenanceWindowTask -> Request UpdateMaintenanceWindowTask

response :: MonadResource m => Logger -> Service -> Proxy * UpdateMaintenanceWindowTask -> ClientResponse -> m (Response UpdateMaintenanceWindowTask)

ToQuery UpdateMaintenanceWindowTask

Methods

toQuery :: UpdateMaintenanceWindowTask -> QueryString

ToPath UpdateMaintenanceWindowTask

Methods

toPath :: UpdateMaintenanceWindowTask -> ByteString

ToHeaders UpdateMaintenanceWindowTask

Methods

toHeaders :: UpdateMaintenanceWindowTask -> [Header]

type Rep UpdateMaintenanceWindowTask

type Rep UpdateMaintenanceWindowTask = D1 (MetaData "UpdateMaintenanceWindowTask" "Network.AWS.SSM.UpdateMaintenanceWindowTask" "amazonka-ssm-1.5.0-7otWUS4XVRaHT5J0sMcEDs" False) (C1 (MetaCons "UpdateMaintenanceWindowTask'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtReplace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_umwtTaskParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive (Map Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_umwtTaskARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtMaxErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_umwtTaskInvocationParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskInvocationParameters)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Target]))) (S1 (MetaSel (Just Symbol "_umwtLoggingInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LoggingInfo))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_umwtMaxConcurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtWindowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_umwtWindowTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs UpdateMaintenanceWindowTask

type Rs UpdateMaintenanceWindowTask = UpdateMaintenanceWindowTaskResponse

Request Lenses

umwtServiceRoleARN :: Lens' UpdateMaintenanceWindowTask (Maybe Text)

The IAM service role ARN to modify. The system assumes this role during task execution.

umwtReplace :: Lens' UpdateMaintenanceWindowTask (Maybe Bool)

If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.

umwtTaskParameters :: Lens' UpdateMaintenanceWindowTask (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))

The parameters to modify. The map has the following format: Key: string, between 1 and 255 characters Value: an array of strings, each string is between 1 and 255 characters

umwtPriority :: Lens' UpdateMaintenanceWindowTask (Maybe Natural)

The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

umwtTaskARN :: Lens' UpdateMaintenanceWindowTask (Maybe Text)

The task ARN to modify.

umwtMaxErrors :: Lens' UpdateMaintenanceWindowTask (Maybe Text)

The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

umwtTaskInvocationParameters :: Lens' UpdateMaintenanceWindowTask (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.

umwtName :: Lens' UpdateMaintenanceWindowTask (Maybe Text)

The new task name to specify.

umwtTargets :: Lens' UpdateMaintenanceWindowTask [Target]

The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

umwtLoggingInfo :: Lens' UpdateMaintenanceWindowTask (Maybe LoggingInfo)

The new logging location in Amazon S3 to specify.

umwtDescription :: Lens' UpdateMaintenanceWindowTask (Maybe Text)

The new task description to specify.

umwtMaxConcurrency :: Lens' UpdateMaintenanceWindowTask (Maybe Text)

The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

umwtWindowId :: Lens' UpdateMaintenanceWindowTask Text

The Maintenance Window ID that contains the task to modify.

umwtWindowTaskId :: Lens' UpdateMaintenanceWindowTask Text

The task ID to modify.

Destructuring the Response

updateMaintenanceWindowTaskResponse

Arguments

:: Int

umwtrsResponseStatus

-> UpdateMaintenanceWindowTaskResponse

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

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

• umwtrsServiceRoleARN - The updated service role ARN value.
• umwtrsWindowTaskId - The task ID of the Maintenance Window that was updated.
• umwtrsTaskParameters - The updated parameter values.
• umwtrsPriority - The updated priority value.
• umwtrsTaskARN - The updated task ARN value.
• umwtrsMaxErrors - The updated MaxErrors value.
• umwtrsTaskInvocationParameters - The updated parameter values.
• umwtrsName - The updated task name.
• umwtrsTargets - The updated target values.
• umwtrsLoggingInfo - The updated logging information in Amazon S3.
• umwtrsDescription - The updated task description.
• umwtrsMaxConcurrency - The updated MaxConcurrency value.
• umwtrsWindowId - The ID of the Maintenance Window that was updated.
• umwtrsResponseStatus - -- | The response status code.

data UpdateMaintenanceWindowTaskResponse

See: updateMaintenanceWindowTaskResponse smart constructor.

Instances

Eq UpdateMaintenanceWindowTaskResponse

Methods

(==) :: UpdateMaintenanceWindowTaskResponse -> UpdateMaintenanceWindowTaskResponse -> Bool

(/=) :: UpdateMaintenanceWindowTaskResponse -> UpdateMaintenanceWindowTaskResponse -> Bool

Data UpdateMaintenanceWindowTaskResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateMaintenanceWindowTaskResponse -> c UpdateMaintenanceWindowTaskResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateMaintenanceWindowTaskResponse

toConstr :: UpdateMaintenanceWindowTaskResponse -> Constr

dataTypeOf :: UpdateMaintenanceWindowTaskResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateMaintenanceWindowTaskResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateMaintenanceWindowTaskResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateMaintenanceWindowTaskResponse -> UpdateMaintenanceWindowTaskResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateMaintenanceWindowTaskResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateMaintenanceWindowTaskResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateMaintenanceWindowTaskResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateMaintenanceWindowTaskResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateMaintenanceWindowTaskResponse -> m UpdateMaintenanceWindowTaskResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateMaintenanceWindowTaskResponse -> m UpdateMaintenanceWindowTaskResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateMaintenanceWindowTaskResponse -> m UpdateMaintenanceWindowTaskResponse

Show UpdateMaintenanceWindowTaskResponse

Methods

showsPrec :: Int -> UpdateMaintenanceWindowTaskResponse -> ShowS

show :: UpdateMaintenanceWindowTaskResponse -> String

showList :: [UpdateMaintenanceWindowTaskResponse] -> ShowS

Generic UpdateMaintenanceWindowTaskResponse

Associated Types

type Rep UpdateMaintenanceWindowTaskResponse :: * -> *

Methods

from :: UpdateMaintenanceWindowTaskResponse -> Rep UpdateMaintenanceWindowTaskResponse x

to :: Rep UpdateMaintenanceWindowTaskResponse x -> UpdateMaintenanceWindowTaskResponse

NFData UpdateMaintenanceWindowTaskResponse

Methods

rnf :: UpdateMaintenanceWindowTaskResponse -> ()

type Rep UpdateMaintenanceWindowTaskResponse

type Rep UpdateMaintenanceWindowTaskResponse = D1 (MetaData "UpdateMaintenanceWindowTaskResponse" "Network.AWS.SSM.UpdateMaintenanceWindowTask" "amazonka-ssm-1.5.0-7otWUS4XVRaHT5J0sMcEDs" False) (C1 (MetaCons "UpdateMaintenanceWindowTaskResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsWindowTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_umwtrsTaskParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive (Map Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_umwtrsTaskARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsMaxErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_umwtrsTaskInvocationParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MaintenanceWindowTaskInvocationParameters)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Target]))) (S1 (MetaSel (Just Symbol "_umwtrsLoggingInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LoggingInfo))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_umwtrsMaxConcurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_umwtrsWindowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_umwtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

umwtrsServiceRoleARN :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The updated service role ARN value.

umwtrsWindowTaskId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The task ID of the Maintenance Window that was updated.

umwtrsTaskParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression))

The updated parameter values.

umwtrsPriority :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Natural)

The updated priority value.

umwtrsTaskARN :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The updated task ARN value.

umwtrsMaxErrors :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The updated MaxErrors value.

umwtrsTaskInvocationParameters :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe MaintenanceWindowTaskInvocationParameters)

The updated parameter values.

umwtrsName :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The updated task name.

umwtrsTargets :: Lens' UpdateMaintenanceWindowTaskResponse [Target]

The updated target values.

umwtrsLoggingInfo :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe LoggingInfo)

The updated logging information in Amazon S3.

umwtrsDescription :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The updated task description.

umwtrsMaxConcurrency :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The updated MaxConcurrency value.

umwtrsWindowId :: Lens' UpdateMaintenanceWindowTaskResponse (Maybe Text)

The ID of the Maintenance Window that was updated.

umwtrsResponseStatus :: Lens' UpdateMaintenanceWindowTaskResponse Int

• - | The response status code.