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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Synopsis

deleteDocument :: Text -> DeleteDocument
data DeleteDocument
dddName :: Lens' DeleteDocument Text
deleteDocumentResponse :: Int -> DeleteDocumentResponse
data DeleteDocumentResponse
ddrsResponseStatus :: Lens' DeleteDocumentResponse Int

Creating a Request

deleteDocument #

Arguments

:: Text	`dddName`
-> DeleteDocument

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

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

dddName - The name of the document.

data DeleteDocument #

See: deleteDocument smart constructor.

Instances

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

Request Lenses

dddName :: Lens' DeleteDocument Text #

The name of the document.

Destructuring the Response

deleteDocumentResponse #

Arguments

:: Int	`ddrsResponseStatus`
-> DeleteDocumentResponse

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

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

ddrsResponseStatus - -- | The response status code.

data DeleteDocumentResponse #

See: deleteDocumentResponse smart constructor.

Instances

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

Response Lenses

ddrsResponseStatus :: Lens' DeleteDocumentResponse Int #

- | The response status code.