Network.AWS.SSM.ListDocuments

Describes one or more of your SSM documents.

This operation returns paginated results.

Creating a Request

listDocuments :: ListDocuments

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

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

• ldDocumentFilterList - One or more filters. Use a filter to return a more specific list of results.
• ldNextToken - The token for the next set of items to return. (You received this token from a previous call.)
• ldMaxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

data ListDocuments

See: listDocuments smart constructor.

Instances

Eq ListDocuments

Methods

(==) :: ListDocuments -> ListDocuments -> Bool

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

Data ListDocuments

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListDocuments -> c ListDocuments

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListDocuments

toConstr :: ListDocuments -> Constr

dataTypeOf :: ListDocuments -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListDocuments)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListDocuments)

gmapT :: (forall b. Data b => b -> b) -> ListDocuments -> ListDocuments

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListDocuments -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListDocuments -> r

gmapQ :: (forall d. Data d => d -> u) -> ListDocuments -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListDocuments -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListDocuments -> m ListDocuments

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDocuments -> m ListDocuments

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDocuments -> m ListDocuments

Read ListDocuments

Methods

readsPrec :: Int -> ReadS ListDocuments

readList :: ReadS [ListDocuments]

readPrec :: ReadPrec ListDocuments

readListPrec :: ReadPrec [ListDocuments]

Show ListDocuments

Methods

showsPrec :: Int -> ListDocuments -> ShowS

show :: ListDocuments -> String

showList :: [ListDocuments] -> ShowS

Generic ListDocuments

Associated Types

type Rep ListDocuments :: * -> *

Methods

from :: ListDocuments -> Rep ListDocuments x

to :: Rep ListDocuments x -> ListDocuments

Hashable ListDocuments

Methods

hashWithSalt :: Int -> ListDocuments -> Int

hash :: ListDocuments -> Int

ToJSON ListDocuments

Methods

toJSON :: ListDocuments -> Value

toEncoding :: ListDocuments -> Encoding

toJSONList :: [ListDocuments] -> Value

toEncodingList :: [ListDocuments] -> Encoding

NFData ListDocuments

Methods

rnf :: ListDocuments -> ()

AWSPager ListDocuments

Methods

page :: ListDocuments -> Rs ListDocuments -> Maybe ListDocuments

AWSRequest ListDocuments

Associated Types

type Rs ListDocuments :: *

Methods

request :: ListDocuments -> Request ListDocuments

response :: MonadResource m => Logger -> Service -> Proxy * ListDocuments -> ClientResponse -> m (Response ListDocuments)

ToPath ListDocuments

Methods

toPath :: ListDocuments -> ByteString

ToHeaders ListDocuments

Methods

toHeaders :: ListDocuments -> [Header]

ToQuery ListDocuments

Methods

toQuery :: ListDocuments -> QueryString

type Rep ListDocuments

type Rep ListDocuments = D1 (MetaData "ListDocuments" "Network.AWS.SSM.ListDocuments" "amazonka-ssm-1.4.5-B1a5iPTYqlbHaMCHVQ4GNL" False) (C1 (MetaCons "ListDocuments'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ldDocumentFilterList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 DocumentFilter)))) ((:*:) (S1 (MetaSel (Just Symbol "_ldNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ldMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))

type Rs ListDocuments

type Rs ListDocuments = ListDocumentsResponse

Request Lenses

ldDocumentFilterList :: Lens' ListDocuments (Maybe (NonEmpty DocumentFilter))

One or more filters. Use a filter to return a more specific list of results.

ldNextToken :: Lens' ListDocuments (Maybe Text)

The token for the next set of items to return. (You received this token from a previous call.)

ldMaxResults :: Lens' ListDocuments (Maybe Natural)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Destructuring the Response

listDocumentsResponse

Arguments

:: Int

ldrsResponseStatus

-> ListDocumentsResponse

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

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

• ldrsDocumentIdentifiers - The names of the SSM documents.
• ldrsNextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
• ldrsResponseStatus - -- | The response status code.

data ListDocumentsResponse

See: listDocumentsResponse smart constructor.

Instances

Eq ListDocumentsResponse

Methods

(==) :: ListDocumentsResponse -> ListDocumentsResponse -> Bool

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

Data ListDocumentsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListDocumentsResponse -> c ListDocumentsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListDocumentsResponse

toConstr :: ListDocumentsResponse -> Constr

dataTypeOf :: ListDocumentsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListDocumentsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListDocumentsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListDocumentsResponse -> ListDocumentsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListDocumentsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListDocumentsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListDocumentsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListDocumentsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListDocumentsResponse -> m ListDocumentsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDocumentsResponse -> m ListDocumentsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDocumentsResponse -> m ListDocumentsResponse

Read ListDocumentsResponse

Methods

readsPrec :: Int -> ReadS ListDocumentsResponse

readList :: ReadS [ListDocumentsResponse]

readPrec :: ReadPrec ListDocumentsResponse

readListPrec :: ReadPrec [ListDocumentsResponse]

Show ListDocumentsResponse

Methods

showsPrec :: Int -> ListDocumentsResponse -> ShowS

show :: ListDocumentsResponse -> String

showList :: [ListDocumentsResponse] -> ShowS

Generic ListDocumentsResponse

Associated Types

type Rep ListDocumentsResponse :: * -> *

Methods

from :: ListDocumentsResponse -> Rep ListDocumentsResponse x

to :: Rep ListDocumentsResponse x -> ListDocumentsResponse

NFData ListDocumentsResponse

Methods

rnf :: ListDocumentsResponse -> ()

type Rep ListDocumentsResponse

type Rep ListDocumentsResponse = D1 (MetaData "ListDocumentsResponse" "Network.AWS.SSM.ListDocuments" "amazonka-ssm-1.4.5-B1a5iPTYqlbHaMCHVQ4GNL" False) (C1 (MetaCons "ListDocumentsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ldrsDocumentIdentifiers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [DocumentIdentifier]))) ((:*:) (S1 (MetaSel (Just Symbol "_ldrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ldrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

ldrsDocumentIdentifiers :: Lens' ListDocumentsResponse [DocumentIdentifier]

The names of the SSM documents.

ldrsNextToken :: Lens' ListDocumentsResponse (Maybe Text)

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

ldrsResponseStatus :: Lens' ListDocumentsResponse Int

• - | The response status code.