| 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.Lightsail.GetActiveNames
Description
Returns the names of all active (not deleted) resources.
This operation returns paginated results.
Synopsis
- data GetActiveNames = GetActiveNames' {}
- newGetActiveNames :: GetActiveNames
- getActiveNames_pageToken :: Lens' GetActiveNames (Maybe Text)
- data GetActiveNamesResponse = GetActiveNamesResponse' {
- activeNames :: Maybe [Text]
- nextPageToken :: Maybe Text
- httpStatus :: Int
- newGetActiveNamesResponse :: Int -> GetActiveNamesResponse
- getActiveNamesResponse_activeNames :: Lens' GetActiveNamesResponse (Maybe [Text])
- getActiveNamesResponse_nextPageToken :: Lens' GetActiveNamesResponse (Maybe Text)
- getActiveNamesResponse_httpStatus :: Lens' GetActiveNamesResponse Int
Creating a Request
data GetActiveNames Source #
See: newGetActiveNames smart constructor.
Constructors
| GetActiveNames' | |
Instances
newGetActiveNames :: GetActiveNames Source #
Create a value of GetActiveNames 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:pageToken:GetActiveNames', getActiveNames_pageToken - The token to advance to the next page of results from your request.
To get a page token, perform an initial GetActiveNames request. If
your results are paginated, the response will return a next page token
that you can specify as the page token in a subsequent request.
Request Lenses
getActiveNames_pageToken :: Lens' GetActiveNames (Maybe Text) Source #
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetActiveNames request. If
your results are paginated, the response will return a next page token
that you can specify as the page token in a subsequent request.
Destructuring the Response
data GetActiveNamesResponse Source #
See: newGetActiveNamesResponse smart constructor.
Constructors
| GetActiveNamesResponse' | |
Fields
| |
Instances
newGetActiveNamesResponse Source #
Create a value of GetActiveNamesResponse 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:activeNames:GetActiveNamesResponse', getActiveNamesResponse_activeNames - The list of active names returned by the get active names request.
$sel:nextPageToken:GetActiveNamesResponse', getActiveNamesResponse_nextPageToken - The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetActiveNames
request and specify the next page token using the pageToken parameter.
$sel:httpStatus:GetActiveNamesResponse', getActiveNamesResponse_httpStatus - The response's http status code.
Response Lenses
getActiveNamesResponse_activeNames :: Lens' GetActiveNamesResponse (Maybe [Text]) Source #
The list of active names returned by the get active names request.
getActiveNamesResponse_nextPageToken :: Lens' GetActiveNamesResponse (Maybe Text) Source #
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetActiveNames
request and specify the next page token using the pageToken parameter.
getActiveNamesResponse_httpStatus :: Lens' GetActiveNamesResponse Int Source #
The response's http status code.