Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
Synopsis
- data ListDocuments = ListDocuments' {}
- newListDocuments :: ListDocuments
- listDocuments_documentFilterList :: Lens' ListDocuments (Maybe (NonEmpty DocumentFilter))
- listDocuments_filters :: Lens' ListDocuments (Maybe [DocumentKeyValuesFilter])
- listDocuments_nextToken :: Lens' ListDocuments (Maybe Text)
- listDocuments_maxResults :: Lens' ListDocuments (Maybe Natural)
- data ListDocumentsResponse = ListDocumentsResponse' {}
- newListDocumentsResponse :: Int -> ListDocumentsResponse
- listDocumentsResponse_documentIdentifiers :: Lens' ListDocumentsResponse (Maybe [DocumentIdentifier])
- listDocumentsResponse_nextToken :: Lens' ListDocumentsResponse (Maybe Text)
- listDocumentsResponse_httpStatus :: Lens' ListDocumentsResponse Int
Creating a Request
data ListDocuments Source #
See: newListDocuments
smart constructor.
ListDocuments' | |
|
Instances
newListDocuments :: ListDocuments Source #
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
.
$sel: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:nextToken:ListDocuments'
, listDocuments_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
$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.
Request Lenses
listDocuments_documentFilterList :: Lens' ListDocuments (Maybe (NonEmpty DocumentFilter)) Source #
This data type is deprecated. Instead, use Filters
.
listDocuments_filters :: Lens' ListDocuments (Maybe [DocumentKeyValuesFilter]) Source #
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_nextToken :: Lens' ListDocuments (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
listDocuments_maxResults :: Lens' ListDocuments (Maybe Natural) Source #
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
data ListDocumentsResponse Source #
See: newListDocumentsResponse
smart constructor.
ListDocumentsResponse' | |
|
Instances
newListDocumentsResponse Source #
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.
$sel:nextToken: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]) Source #
The names of the SSM documents.
listDocumentsResponse_nextToken :: Lens' ListDocumentsResponse (Maybe Text) Source #
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 Source #
The response's http status code.