| 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 |
Amazonka.Lightsail.GetInstances
Description
Returns information about all Amazon Lightsail virtual private servers, or instances.
This operation returns paginated results.
Synopsis
- data GetInstances = GetInstances' {}
- newGetInstances :: GetInstances
- getInstances_pageToken :: Lens' GetInstances (Maybe Text)
- data GetInstancesResponse = GetInstancesResponse' {
- nextPageToken :: Maybe Text
- instances :: Maybe [Instance]
- httpStatus :: Int
- newGetInstancesResponse :: Int -> GetInstancesResponse
- getInstancesResponse_nextPageToken :: Lens' GetInstancesResponse (Maybe Text)
- getInstancesResponse_instances :: Lens' GetInstancesResponse (Maybe [Instance])
- getInstancesResponse_httpStatus :: Lens' GetInstancesResponse Int
Creating a Request
data GetInstances Source #
See: newGetInstances smart constructor.
Constructors
| GetInstances' | |
Instances
newGetInstances :: GetInstances Source #
Create a value of GetInstances 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:GetInstances', getInstances_pageToken - The token to advance to the next page of results from your request.
To get a page token, perform an initial GetInstances 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
getInstances_pageToken :: Lens' GetInstances (Maybe Text) Source #
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetInstances 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 GetInstancesResponse Source #
See: newGetInstancesResponse smart constructor.
Constructors
| GetInstancesResponse' | |
Fields
| |
Instances
newGetInstancesResponse Source #
Arguments
| :: Int | |
| -> GetInstancesResponse |
Create a value of GetInstancesResponse 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:nextPageToken:GetInstancesResponse', getInstancesResponse_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 GetInstances request
and specify the next page token using the pageToken parameter.
$sel:instances:GetInstancesResponse', getInstancesResponse_instances - An array of key-value pairs containing information about your instances.
$sel:httpStatus:GetInstancesResponse', getInstancesResponse_httpStatus - The response's http status code.
Response Lenses
getInstancesResponse_nextPageToken :: Lens' GetInstancesResponse (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 GetInstances request
and specify the next page token using the pageToken parameter.
getInstancesResponse_instances :: Lens' GetInstancesResponse (Maybe [Instance]) Source #
An array of key-value pairs containing information about your instances.
getInstancesResponse_httpStatus :: Lens' GetInstancesResponse Int Source #
The response's http status code.