| 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.GetBlueprints
Description
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
This operation returns paginated results.
Synopsis
- data GetBlueprints = GetBlueprints' {}
- newGetBlueprints :: GetBlueprints
- getBlueprints_includeInactive :: Lens' GetBlueprints (Maybe Bool)
- getBlueprints_pageToken :: Lens' GetBlueprints (Maybe Text)
- data GetBlueprintsResponse = GetBlueprintsResponse' {
- blueprints :: Maybe [Blueprint]
- nextPageToken :: Maybe Text
- httpStatus :: Int
- newGetBlueprintsResponse :: Int -> GetBlueprintsResponse
- getBlueprintsResponse_blueprints :: Lens' GetBlueprintsResponse (Maybe [Blueprint])
- getBlueprintsResponse_nextPageToken :: Lens' GetBlueprintsResponse (Maybe Text)
- getBlueprintsResponse_httpStatus :: Lens' GetBlueprintsResponse Int
Creating a Request
data GetBlueprints Source #
See: newGetBlueprints smart constructor.
Constructors
| GetBlueprints' | |
Fields
| |
Instances
newGetBlueprints :: GetBlueprints Source #
Create a value of GetBlueprints 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:includeInactive:GetBlueprints', getBlueprints_includeInactive - A Boolean value indicating whether to include inactive results in your
request.
$sel:pageToken:GetBlueprints', getBlueprints_pageToken - The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBlueprints 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
getBlueprints_includeInactive :: Lens' GetBlueprints (Maybe Bool) Source #
A Boolean value indicating whether to include inactive results in your request.
getBlueprints_pageToken :: Lens' GetBlueprints (Maybe Text) Source #
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetBlueprints 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 GetBlueprintsResponse Source #
See: newGetBlueprintsResponse smart constructor.
Constructors
| GetBlueprintsResponse' | |
Fields
| |
Instances
newGetBlueprintsResponse Source #
Create a value of GetBlueprintsResponse 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:blueprints:GetBlueprintsResponse', getBlueprintsResponse_blueprints - An array of key-value pairs that contains information about the
available blueprints.
$sel:nextPageToken:GetBlueprintsResponse', getBlueprintsResponse_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 GetBlueprints request
and specify the next page token using the pageToken parameter.
$sel:httpStatus:GetBlueprintsResponse', getBlueprintsResponse_httpStatus - The response's http status code.
Response Lenses
getBlueprintsResponse_blueprints :: Lens' GetBlueprintsResponse (Maybe [Blueprint]) Source #
An array of key-value pairs that contains information about the available blueprints.
getBlueprintsResponse_nextPageToken :: Lens' GetBlueprintsResponse (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 GetBlueprints request
and specify the next page token using the pageToken parameter.
getBlueprintsResponse_httpStatus :: Lens' GetBlueprintsResponse Int Source #
The response's http status code.