amazonka-ssm-1.4.5: Amazon Simple Systems Manager (SSM) SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SSM.DescribeDocument

Contents

Description

Describes the specified SSM document.

Synopsis

Creating a Request

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:

  • ddDocumentVersion - The document version for which you want information. Can be a specific version or the default version.
  • ddName - The name of the SSM document.

data DescribeDocument #

See: describeDocument smart constructor.

Instances

Eq DescribeDocument # 
Data DescribeDocument # 

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 # 
Show DescribeDocument # 
Generic DescribeDocument # 
Hashable DescribeDocument # 
ToJSON DescribeDocument # 
NFData DescribeDocument # 

Methods

rnf :: DescribeDocument -> () #

AWSRequest DescribeDocument # 
ToQuery DescribeDocument # 
ToPath DescribeDocument # 
ToHeaders DescribeDocument # 
type Rep DescribeDocument # 
type Rep DescribeDocument = D1 (MetaData "DescribeDocument" "Network.AWS.SSM.DescribeDocument" "amazonka-ssm-1.4.5-1XugwZI5i6oEK9zpTg7Crt" False) (C1 (MetaCons "DescribeDocument'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddDocumentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs DescribeDocument # 

Request Lenses

ddDocumentVersion :: Lens' DescribeDocument (Maybe Text) #

The document version for which you want information. Can be a specific version or the default version.

ddName :: Lens' DescribeDocument Text #

The name of the SSM document.

Destructuring the Response

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:

data DescribeDocumentResponse #

See: describeDocumentResponse smart constructor.

Instances

Eq DescribeDocumentResponse # 
Data DescribeDocumentResponse # 

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 # 
Show DescribeDocumentResponse # 
Generic DescribeDocumentResponse # 
NFData DescribeDocumentResponse # 
type Rep DescribeDocumentResponse # 
type Rep DescribeDocumentResponse = D1 (MetaData "DescribeDocumentResponse" "Network.AWS.SSM.DescribeDocument" "amazonka-ssm-1.4.5-1XugwZI5i6oEK9zpTg7Crt" False) (C1 (MetaCons "DescribeDocumentResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drsDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentDescription))) (S1 (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

drsDocument :: Lens' DescribeDocumentResponse (Maybe DocumentDescription) #

Information about the SSM document.

drsResponseStatus :: Lens' DescribeDocumentResponse Int #

  • - | The response status code.