Amazonka.SSM.ListDocuments

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.

This operation returns paginated results.

Creating a Request

data ListDocuments

See: newListDocuments smart constructor.

Constructors

ListDocuments'

Fields

• documentFilterList :: Maybe (NonEmpty DocumentFilter)

  This data type is deprecated. Instead, use Filters.

• filters :: Maybe [DocumentKeyValuesFilter]

  One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

  This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

• maxResults :: 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.

• nextToken :: Maybe Text

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

Instances

ToJSON ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

toJSON :: ListDocuments -> Value

toEncoding :: ListDocuments -> Encoding

toJSONList :: [ListDocuments] -> Value

toEncodingList :: [ListDocuments] -> Encoding

ToHeaders ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

toHeaders :: ListDocuments -> [Header]

ToPath ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

toPath :: ListDocuments -> ByteString

ToQuery ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

toQuery :: ListDocuments -> QueryString

AWSPager ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

page :: ListDocuments -> AWSResponse ListDocuments -> Maybe ListDocuments

AWSRequest ListDocuments

Defined in Amazonka.SSM.ListDocuments

Associated Types

type AWSResponse ListDocuments

Methods

request :: (Service -> Service) -> ListDocuments -> Request ListDocuments

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDocuments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDocuments)))

Generic ListDocuments

Defined in Amazonka.SSM.ListDocuments

Associated Types

type Rep ListDocuments :: Type -> Type

Methods

from :: ListDocuments -> Rep ListDocuments x

to :: Rep ListDocuments x -> ListDocuments

Read ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

readsPrec :: Int -> ReadS ListDocuments

readList :: ReadS [ListDocuments]

readPrec :: ReadPrec ListDocuments

readListPrec :: ReadPrec [ListDocuments]

Show ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

showsPrec :: Int -> ListDocuments -> ShowS

show :: ListDocuments -> String

showList :: [ListDocuments] -> ShowS

NFData ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

rnf :: ListDocuments -> ()

Eq ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

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

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

Hashable ListDocuments

Defined in Amazonka.SSM.ListDocuments

Methods

hashWithSalt :: Int -> ListDocuments -> Int

hash :: ListDocuments -> Int

type AWSResponse ListDocuments

Defined in Amazonka.SSM.ListDocuments

type AWSResponse ListDocuments = ListDocumentsResponse

type Rep ListDocuments

Defined in Amazonka.SSM.ListDocuments

type Rep ListDocuments = D1 ('MetaData "ListDocuments" "Amazonka.SSM.ListDocuments" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListDocuments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentFilterList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DocumentFilter))) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentKeyValuesFilter]))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListDocuments :: ListDocuments

Create a value of ListDocuments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentFilterList:ListDocuments', listDocuments_documentFilterList - This data type is deprecated. Instead, use Filters.

ListDocuments, listDocuments_filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

$sel:maxResults:ListDocuments', listDocuments_maxResults - 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.

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

Request Lenses

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

This data type is deprecated. Instead, use Filters.

listDocuments_filters :: Lens' ListDocuments (Maybe [DocumentKeyValuesFilter])

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

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

listDocuments_nextToken :: Lens' ListDocuments (Maybe Text)

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

Destructuring the Response

data ListDocumentsResponse

See: newListDocumentsResponse smart constructor.

Constructors

ListDocumentsResponse'

Fields

• documentIdentifiers :: Maybe [DocumentIdentifier]

  The names of the SSM documents.

• nextToken :: 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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListDocumentsResponse

Defined in Amazonka.SSM.ListDocuments

Associated Types

type Rep ListDocumentsResponse :: Type -> Type

Methods

from :: ListDocumentsResponse -> Rep ListDocumentsResponse x

to :: Rep ListDocumentsResponse x -> ListDocumentsResponse

Read ListDocumentsResponse

Defined in Amazonka.SSM.ListDocuments

Methods

readsPrec :: Int -> ReadS ListDocumentsResponse

readList :: ReadS [ListDocumentsResponse]

readPrec :: ReadPrec ListDocumentsResponse

readListPrec :: ReadPrec [ListDocumentsResponse]

Show ListDocumentsResponse

Defined in Amazonka.SSM.ListDocuments

Methods

showsPrec :: Int -> ListDocumentsResponse -> ShowS

show :: ListDocumentsResponse -> String

showList :: [ListDocumentsResponse] -> ShowS

NFData ListDocumentsResponse

Defined in Amazonka.SSM.ListDocuments

Methods

rnf :: ListDocumentsResponse -> ()

Eq ListDocumentsResponse

Defined in Amazonka.SSM.ListDocuments

Methods

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

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

type Rep ListDocumentsResponse

Defined in Amazonka.SSM.ListDocuments

type Rep ListDocumentsResponse = D1 ('MetaData "ListDocumentsResponse" "Amazonka.SSM.ListDocuments" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListDocumentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentIdentifier])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDocumentsResponse

Arguments

:: Int

$sel:httpStatus:ListDocumentsResponse'

-> ListDocumentsResponse

Create a value of ListDocumentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:documentIdentifiers:ListDocumentsResponse', listDocumentsResponse_documentIdentifiers - The names of the SSM documents.

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

$sel:httpStatus:ListDocumentsResponse', listDocumentsResponse_httpStatus - The response's http status code.

Response Lenses

listDocumentsResponse_documentIdentifiers :: Lens' ListDocumentsResponse (Maybe [DocumentIdentifier])

The names of the SSM documents.

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

listDocumentsResponse_httpStatus :: Lens' ListDocumentsResponse Int

The response's http status code.