Network.AWS.SSM.DescribeDocument

Describes the specified Systems Manager document.

Creating a Request

describeDocument

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:

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

data DescribeDocument

See: describeDocument smart constructor.

Instances

Eq DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

(==) :: DescribeDocument -> DescribeDocument -> Bool

(/=) :: DescribeDocument -> DescribeDocument -> Bool

Data DescribeDocument

Defined in Network.AWS.SSM.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

Defined in Network.AWS.SSM.DescribeDocument

Methods

readsPrec :: Int -> ReadS DescribeDocument

readList :: ReadS [DescribeDocument]

readPrec :: ReadPrec DescribeDocument

readListPrec :: ReadPrec [DescribeDocument]

Show DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

showsPrec :: Int -> DescribeDocument -> ShowS

show :: DescribeDocument -> String

showList :: [DescribeDocument] -> ShowS

Generic DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Associated Types

type Rep DescribeDocument :: Type -> Type

Methods

from :: DescribeDocument -> Rep DescribeDocument x

to :: Rep DescribeDocument x -> DescribeDocument

Hashable DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

hashWithSalt :: Int -> DescribeDocument -> Int

hash :: DescribeDocument -> Int

ToJSON DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

toJSON :: DescribeDocument -> Value

toEncoding :: DescribeDocument -> Encoding

toJSONList :: [DescribeDocument] -> Value

toEncodingList :: [DescribeDocument] -> Encoding

AWSRequest DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Associated Types

type Rs DescribeDocument :: Type

Methods

request :: DescribeDocument -> Request DescribeDocument

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeDocument -> ClientResponse -> m (Response DescribeDocument)

ToHeaders DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

toHeaders :: DescribeDocument -> [Header]

ToPath DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

toPath :: DescribeDocument -> ByteString

ToQuery DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

toQuery :: DescribeDocument -> QueryString

NFData DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

Methods

rnf :: DescribeDocument -> ()

type Rep DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

type Rep DescribeDocument = D1 (MetaData "DescribeDocument" "Network.AWS.SSM.DescribeDocument" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "DescribeDocument'" PrefixI True) (S1 (MetaSel (Just "_ddDocumentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ddName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs DescribeDocument

Defined in Network.AWS.SSM.DescribeDocument

type Rs DescribeDocument = DescribeDocumentResponse

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 Systems Manager document.

Destructuring the Response

describeDocumentResponse

Arguments

:: Int

desrsResponseStatus

-> 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:

• desrsDocument - Information about the Systems Manager document.
• desrsResponseStatus - -- | The response status code.

data DescribeDocumentResponse

See: describeDocumentResponse smart constructor.

Instances

Eq DescribeDocumentResponse

Defined in Network.AWS.SSM.DescribeDocument

Methods

(==) :: DescribeDocumentResponse -> DescribeDocumentResponse -> Bool

(/=) :: DescribeDocumentResponse -> DescribeDocumentResponse -> Bool

Data DescribeDocumentResponse

Defined in Network.AWS.SSM.DescribeDocument

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

Defined in Network.AWS.SSM.DescribeDocument

Methods

readsPrec :: Int -> ReadS DescribeDocumentResponse

readList :: ReadS [DescribeDocumentResponse]

readPrec :: ReadPrec DescribeDocumentResponse

readListPrec :: ReadPrec [DescribeDocumentResponse]

Show DescribeDocumentResponse

Defined in Network.AWS.SSM.DescribeDocument

Methods

showsPrec :: Int -> DescribeDocumentResponse -> ShowS

show :: DescribeDocumentResponse -> String

showList :: [DescribeDocumentResponse] -> ShowS

Generic DescribeDocumentResponse

Defined in Network.AWS.SSM.DescribeDocument

Associated Types

type Rep DescribeDocumentResponse :: Type -> Type

Methods

from :: DescribeDocumentResponse -> Rep DescribeDocumentResponse x

to :: Rep DescribeDocumentResponse x -> DescribeDocumentResponse

NFData DescribeDocumentResponse

Defined in Network.AWS.SSM.DescribeDocument

Methods

rnf :: DescribeDocumentResponse -> ()

type Rep DescribeDocumentResponse

Defined in Network.AWS.SSM.DescribeDocument

type Rep DescribeDocumentResponse = D1 (MetaData "DescribeDocumentResponse" "Network.AWS.SSM.DescribeDocument" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "DescribeDocumentResponse'" PrefixI True) (S1 (MetaSel (Just "_desrsDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentDescription)) :*: S1 (MetaSel (Just "_desrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

desrsDocument :: Lens' DescribeDocumentResponse (Maybe DocumentDescription)

Information about the Systems Manager document.

desrsResponseStatus :: Lens' DescribeDocumentResponse Int

• - | The response status code.