Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SSM.RegisterTaskWithMaintenanceWindow

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a new task to a Maintenance Window.

Synopsis

Creating a Request

registerTaskWithMaintenanceWindow #

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.

data RegisterTaskWithMaintenanceWindow #

See: registerTaskWithMaintenanceWindow smart constructor.

Instances

Eq RegisterTaskWithMaintenanceWindow #
Methods (==) :: RegisterTaskWithMaintenanceWindow -> RegisterTaskWithMaintenanceWindow -> Bool # (/=) :: RegisterTaskWithMaintenanceWindow -> RegisterTaskWithMaintenanceWindow -> Bool #
Data RegisterTaskWithMaintenanceWindow #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterTaskWithMaintenanceWindow -> c RegisterTaskWithMaintenanceWindow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterTaskWithMaintenanceWindow # toConstr :: RegisterTaskWithMaintenanceWindow -> Constr # dataTypeOf :: RegisterTaskWithMaintenanceWindow -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterTaskWithMaintenanceWindow) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterTaskWithMaintenanceWindow) # gmapT :: (forall b. Data b => b -> b) -> RegisterTaskWithMaintenanceWindow -> RegisterTaskWithMaintenanceWindow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskWithMaintenanceWindow -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskWithMaintenanceWindow -> r # gmapQ :: (forall d. Data d => d -> u) -> RegisterTaskWithMaintenanceWindow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterTaskWithMaintenanceWindow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterTaskWithMaintenanceWindow -> m RegisterTaskWithMaintenanceWindow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskWithMaintenanceWindow -> m RegisterTaskWithMaintenanceWindow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskWithMaintenanceWindow -> m RegisterTaskWithMaintenanceWindow #
Show RegisterTaskWithMaintenanceWindow #
Methods showsPrec :: Int -> RegisterTaskWithMaintenanceWindow -> ShowS # show :: RegisterTaskWithMaintenanceWindow -> String # showList :: [RegisterTaskWithMaintenanceWindow] -> ShowS #
Generic RegisterTaskWithMaintenanceWindow #
Associated Types type Rep RegisterTaskWithMaintenanceWindow :: * -> * # Methods from :: RegisterTaskWithMaintenanceWindow -> Rep RegisterTaskWithMaintenanceWindow x # to :: Rep RegisterTaskWithMaintenanceWindow x -> RegisterTaskWithMaintenanceWindow #
Hashable RegisterTaskWithMaintenanceWindow #
Methods hashWithSalt :: Int -> RegisterTaskWithMaintenanceWindow -> Int # hash :: RegisterTaskWithMaintenanceWindow -> Int #
ToJSON RegisterTaskWithMaintenanceWindow #
Methods toJSON :: RegisterTaskWithMaintenanceWindow -> Value # toEncoding :: RegisterTaskWithMaintenanceWindow -> Encoding # toJSONList :: [RegisterTaskWithMaintenanceWindow] -> Value # toEncodingList :: [RegisterTaskWithMaintenanceWindow] -> Encoding #
NFData RegisterTaskWithMaintenanceWindow #
Methods rnf :: RegisterTaskWithMaintenanceWindow -> () #
AWSRequest RegisterTaskWithMaintenanceWindow #
Associated Types type Rs RegisterTaskWithMaintenanceWindow :: * # Methods request :: RegisterTaskWithMaintenanceWindow -> Request RegisterTaskWithMaintenanceWindow # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * RegisterTaskWithMaintenanceWindow -> ClientResponse -> m (Response RegisterTaskWithMaintenanceWindow) #
ToHeaders RegisterTaskWithMaintenanceWindow #
Methods toHeaders :: RegisterTaskWithMaintenanceWindow -> [Header] #
ToPath RegisterTaskWithMaintenanceWindow #
Methods toPath :: RegisterTaskWithMaintenanceWindow -> ByteString #
ToQuery RegisterTaskWithMaintenanceWindow #
Methods toQuery :: RegisterTaskWithMaintenanceWindow -> QueryString #
type Rep RegisterTaskWithMaintenanceWindow #
type Rep RegisterTaskWithMaintenanceWindow = D1 * (MetaData "RegisterTaskWithMaintenanceWindow" "Network.AWS.SSM.RegisterTaskWithMaintenanceWindow" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" False) (C1 * (MetaCons "RegisterTaskWithMaintenanceWindow'" PrefixI True) ((::) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwTaskParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive (Map Text (Sensitive MaintenanceWindowTaskParameterValueExpression)))))) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_rtwmwClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwTaskInvocationParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MaintenanceWindowTaskInvocationParameters))) (S1 * (MetaSel (Just Symbol "_rtwmwName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwLoggingInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe LoggingInfo))) (S1 * (MetaSel (Just Symbol "_rtwmwDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text))))))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwWindowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Target])) (S1 * (MetaSel (Just Symbol "_rtwmwTaskARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((::) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rtwmwTaskType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MaintenanceWindowTaskType))) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwMaxConcurrency") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_rtwmwMaxErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))))
type Rs RegisterTaskWithMaintenanceWindow #
type Rs RegisterTaskWithMaintenanceWindow = RegisterTaskWithMaintenanceWindowResponse

Request Lenses

rtwmwTaskParameters :: Lens' RegisterTaskWithMaintenanceWindow (Maybe (HashMap Text MaintenanceWindowTaskParameterValueExpression)) #

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

rtwmwPriority :: Lens' RegisterTaskWithMaintenanceWindow (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.

rtwmwClientToken :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) #

User-provided idempotency token.

rtwmwTaskInvocationParameters :: Lens' RegisterTaskWithMaintenanceWindow (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.

rtwmwName :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) #

An optional name for the task.

rtwmwLoggingInfo :: Lens' RegisterTaskWithMaintenanceWindow (Maybe LoggingInfo) #

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

rtwmwDescription :: Lens' RegisterTaskWithMaintenanceWindow (Maybe Text) #

An optional description for the task.

rtwmwWindowId :: Lens' RegisterTaskWithMaintenanceWindow Text #

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

rtwmwTargets :: Lens' RegisterTaskWithMaintenanceWindow [Target] #

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 :: Lens' RegisterTaskWithMaintenanceWindow Text #

The ARN of the task to execute

rtwmwServiceRoleARN :: Lens' RegisterTaskWithMaintenanceWindow Text #

The role that should be assumed when executing the task.

rtwmwTaskType :: Lens' RegisterTaskWithMaintenanceWindow MaintenanceWindowTaskType #

The type of task being registered.

rtwmwMaxConcurrency :: Lens' RegisterTaskWithMaintenanceWindow Text #

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

rtwmwMaxErrors :: Lens' RegisterTaskWithMaintenanceWindow Text #

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

Destructuring the Response

registerTaskWithMaintenanceWindowResponse #

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.

data RegisterTaskWithMaintenanceWindowResponse #

See: registerTaskWithMaintenanceWindowResponse smart constructor.

Instances

Eq RegisterTaskWithMaintenanceWindowResponse #
Methods (==) :: RegisterTaskWithMaintenanceWindowResponse -> RegisterTaskWithMaintenanceWindowResponse -> Bool # (/=) :: RegisterTaskWithMaintenanceWindowResponse -> RegisterTaskWithMaintenanceWindowResponse -> Bool #
Data RegisterTaskWithMaintenanceWindowResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterTaskWithMaintenanceWindowResponse -> c RegisterTaskWithMaintenanceWindowResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterTaskWithMaintenanceWindowResponse # toConstr :: RegisterTaskWithMaintenanceWindowResponse -> Constr # dataTypeOf :: RegisterTaskWithMaintenanceWindowResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterTaskWithMaintenanceWindowResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterTaskWithMaintenanceWindowResponse) # gmapT :: (forall b. Data b => b -> b) -> RegisterTaskWithMaintenanceWindowResponse -> RegisterTaskWithMaintenanceWindowResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskWithMaintenanceWindowResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskWithMaintenanceWindowResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> RegisterTaskWithMaintenanceWindowResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterTaskWithMaintenanceWindowResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterTaskWithMaintenanceWindowResponse -> m RegisterTaskWithMaintenanceWindowResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskWithMaintenanceWindowResponse -> m RegisterTaskWithMaintenanceWindowResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskWithMaintenanceWindowResponse -> m RegisterTaskWithMaintenanceWindowResponse #
Read RegisterTaskWithMaintenanceWindowResponse #
Methods readsPrec :: Int -> ReadS RegisterTaskWithMaintenanceWindowResponse # readList :: ReadS [RegisterTaskWithMaintenanceWindowResponse] # readPrec :: ReadPrec RegisterTaskWithMaintenanceWindowResponse # readListPrec :: ReadPrec [RegisterTaskWithMaintenanceWindowResponse] #
Show RegisterTaskWithMaintenanceWindowResponse #
Methods showsPrec :: Int -> RegisterTaskWithMaintenanceWindowResponse -> ShowS # show :: RegisterTaskWithMaintenanceWindowResponse -> String # showList :: [RegisterTaskWithMaintenanceWindowResponse] -> ShowS #
Generic RegisterTaskWithMaintenanceWindowResponse #
Associated Types type Rep RegisterTaskWithMaintenanceWindowResponse :: * -> * # Methods from :: RegisterTaskWithMaintenanceWindowResponse -> Rep RegisterTaskWithMaintenanceWindowResponse x # to :: Rep RegisterTaskWithMaintenanceWindowResponse x -> RegisterTaskWithMaintenanceWindowResponse #
NFData RegisterTaskWithMaintenanceWindowResponse #
Methods rnf :: RegisterTaskWithMaintenanceWindowResponse -> () #
type Rep RegisterTaskWithMaintenanceWindowResponse #
type Rep RegisterTaskWithMaintenanceWindowResponse = D1 * (MetaData "RegisterTaskWithMaintenanceWindowResponse" "Network.AWS.SSM.RegisterTaskWithMaintenanceWindow" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" False) (C1 * (MetaCons "RegisterTaskWithMaintenanceWindowResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_rtwmwrsWindowTaskId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_rtwmwrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

rtwmwrsWindowTaskId :: Lens' RegisterTaskWithMaintenanceWindowResponse (Maybe Text) #

The id of the task in the Maintenance Window.

rtwmwrsResponseStatus :: Lens' RegisterTaskWithMaintenanceWindowResponse Int #

- | The response status code.