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

Network.AWS.SSM.DescribeDocument

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified SSM document.

Creating a Request

describeDocument Source #

Arguments

:: Text	`ddName`
-> DescribeDocument

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

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

ddName

data DescribeDocument Source #

See: describeDocument smart constructor.

Instances

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

Request Lenses

ddName :: Lens' DescribeDocument Text Source #

The name of the SSM document.

Destructuring the Response

describeDocumentResponse Source #

Arguments

:: Int	`drsResponseStatus`
-> DescribeDocumentResponse

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

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

drsDocument
drsResponseStatus

data DescribeDocumentResponse Source #

See: describeDocumentResponse smart constructor.

Instances

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

Response Lenses

drsDocument :: Lens' DescribeDocumentResponse (Maybe DocumentDescription) Source #

Information about the SSM document.

drsResponseStatus :: Lens' DescribeDocumentResponse Int Source #

The response status code.