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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

Synopsis

Creating a Request

cancelCommand #

Arguments

:: Text	`ccCommandId`
-> CancelCommand

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

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

ccInstanceIds - (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.
ccCommandId - The ID of the command you want to cancel.

data CancelCommand #

See: cancelCommand smart constructor.

Instances

Eq CancelCommand #
Methods (==) :: CancelCommand -> CancelCommand -> Bool # (/=) :: CancelCommand -> CancelCommand -> Bool #
Data CancelCommand #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CancelCommand -> c CancelCommand # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CancelCommand # toConstr :: CancelCommand -> Constr # dataTypeOf :: CancelCommand -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CancelCommand) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CancelCommand) # gmapT :: (forall b. Data b => b -> b) -> CancelCommand -> CancelCommand # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CancelCommand -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CancelCommand -> r # gmapQ :: (forall d. Data d => d -> u) -> CancelCommand -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CancelCommand -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CancelCommand -> m CancelCommand # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelCommand -> m CancelCommand # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CancelCommand -> m CancelCommand #
Read CancelCommand #
Methods readsPrec :: Int -> ReadS CancelCommand # readList :: ReadS [CancelCommand] # readPrec :: ReadPrec CancelCommand # readListPrec :: ReadPrec [CancelCommand] #
Show CancelCommand #
Methods showsPrec :: Int -> CancelCommand -> ShowS # show :: CancelCommand -> String # showList :: [CancelCommand] -> ShowS #
Generic CancelCommand #
Associated Types type Rep CancelCommand :: * -> * # Methods from :: CancelCommand -> Rep CancelCommand x # to :: Rep CancelCommand x -> CancelCommand #
Hashable CancelCommand #
Methods hashWithSalt :: Int -> CancelCommand -> Int # hash :: CancelCommand -> Int #
ToJSON CancelCommand #
Methods toJSON :: CancelCommand -> Value # toEncoding :: CancelCommand -> Encoding # toJSONList :: [CancelCommand] -> Value # toEncodingList :: [CancelCommand] -> Encoding #
NFData CancelCommand #
Methods rnf :: CancelCommand -> () #
AWSRequest CancelCommand #
Associated Types type Rs CancelCommand :: * # Methods request :: CancelCommand -> Request CancelCommand # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CancelCommand -> ClientResponse -> m (Response CancelCommand) #
ToHeaders CancelCommand #
Methods toHeaders :: CancelCommand -> [Header] #
ToPath CancelCommand #
Methods toPath :: CancelCommand -> ByteString #
ToQuery CancelCommand #
Methods toQuery :: CancelCommand -> QueryString #
type Rep CancelCommand #
type Rep CancelCommand = D1 * (MetaData "CancelCommand" "Network.AWS.SSM.CancelCommand" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" False) (C1 * (MetaCons "CancelCommand'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ccInstanceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_ccCommandId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))
type Rs CancelCommand #
type Rs CancelCommand = CancelCommandResponse

Request Lenses

ccInstanceIds :: Lens' CancelCommand [Text] #

(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

ccCommandId :: Lens' CancelCommand Text #

The ID of the command you want to cancel.

Destructuring the Response

cancelCommandResponse #

Arguments

:: Int	`ccrsResponseStatus`
-> CancelCommandResponse

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

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

ccrsResponseStatus - -- | The response status code.

data CancelCommandResponse #

Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

See: cancelCommandResponse smart constructor.

Instances

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

Response Lenses

ccrsResponseStatus :: Lens' CancelCommandResponse Int #

- | The response status code.