| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ResourceExplorer2.ListIndexes
Description
Retrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.
This operation returns paginated results.
Synopsis
- data ListIndexes = ListIndexes' {}
- newListIndexes :: ListIndexes
- listIndexes_maxResults :: Lens' ListIndexes (Maybe Natural)
- listIndexes_nextToken :: Lens' ListIndexes (Maybe Text)
- listIndexes_regions :: Lens' ListIndexes (Maybe [Text])
- listIndexes_type :: Lens' ListIndexes (Maybe IndexType)
- data ListIndexesResponse = ListIndexesResponse' {}
- newListIndexesResponse :: Int -> ListIndexesResponse
- listIndexesResponse_indexes :: Lens' ListIndexesResponse (Maybe [Index])
- listIndexesResponse_nextToken :: Lens' ListIndexesResponse (Maybe Text)
- listIndexesResponse_httpStatus :: Lens' ListIndexesResponse Int
Creating a Request
data ListIndexes Source #
See: newListIndexes smart constructor.
Constructors
| ListIndexes' | |
Fields
| |
Instances
newListIndexes :: ListIndexes Source #
Create a value of ListIndexes 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:maxResults:ListIndexes', listIndexes_maxResults - The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those
included in the current response, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results.
An API operation can return fewer results than the maximum even when
there are more results available. You should check NextToken after
every operation to ensure that you receive all of the results.
ListIndexes, listIndexes_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
$sel:regions:ListIndexes', listIndexes_regions - If specified, limits the response to only information about the index in
the specified list of Amazon Web Services Regions.
ListIndexes, listIndexes_type - If specified, limits the output to only indexes of the specified Type,
either LOCAL or AGGREGATOR.
Use this option to discover the aggregator index for your account.
Request Lenses
listIndexes_maxResults :: Lens' ListIndexes (Maybe Natural) Source #
The maximum number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
appropriate to the operation. If additional items exist beyond those
included in the current response, the NextToken response element is
present and has a value (is not null). Include that value as the
NextToken request parameter in the next call to the operation to get
the next part of the results.
An API operation can return fewer results than the maximum even when
there are more results available. You should check NextToken after
every operation to ensure that you receive all of the results.
listIndexes_nextToken :: Lens' ListIndexes (Maybe Text) Source #
The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
of the previous call's NextToken response to indicate where the
output should continue from.
listIndexes_regions :: Lens' ListIndexes (Maybe [Text]) Source #
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
listIndexes_type :: Lens' ListIndexes (Maybe IndexType) Source #
If specified, limits the output to only indexes of the specified Type,
either LOCAL or AGGREGATOR.
Use this option to discover the aggregator index for your account.
Destructuring the Response
data ListIndexesResponse Source #
See: newListIndexesResponse smart constructor.
Constructors
| ListIndexesResponse' | |
Fields
| |
Instances
newListIndexesResponse Source #
Arguments
| :: Int | |
| -> ListIndexesResponse |
Create a value of ListIndexesResponse 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:indexes:ListIndexesResponse', listIndexesResponse_indexes - A structure that contains the details and status of each index.
ListIndexes, listIndexesResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:httpStatus:ListIndexesResponse', listIndexesResponse_httpStatus - The response's http status code.
Response Lenses
listIndexesResponse_indexes :: Lens' ListIndexesResponse (Maybe [Index]) Source #
A structure that contains the details and status of each index.
listIndexesResponse_nextToken :: Lens' ListIndexesResponse (Maybe Text) Source #
If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
listIndexesResponse_httpStatus :: Lens' ListIndexesResponse Int Source #
The response's http status code.