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 the list of images that you have access to.
Synopsis
- data ListImages = ListImages' {}
- newListImages :: ListImages
- listImages_filters :: Lens' ListImages (Maybe (NonEmpty Filter))
- listImages_owner :: Lens' ListImages (Maybe Ownership)
- listImages_byName :: Lens' ListImages (Maybe Bool)
- listImages_nextToken :: Lens' ListImages (Maybe Text)
- listImages_includeDeprecated :: Lens' ListImages (Maybe Bool)
- listImages_maxResults :: Lens' ListImages (Maybe Natural)
- data ListImagesResponse = ListImagesResponse' {
- requestId :: Maybe Text
- imageVersionList :: Maybe [ImageVersion]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListImagesResponse :: Int -> ListImagesResponse
- listImagesResponse_requestId :: Lens' ListImagesResponse (Maybe Text)
- listImagesResponse_imageVersionList :: Lens' ListImagesResponse (Maybe [ImageVersion])
- listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text)
- listImagesResponse_httpStatus :: Lens' ListImagesResponse Int
Creating a Request
data ListImages Source #
See: newListImages
smart constructor.
ListImages' | |
|
Instances
newListImages :: ListImages Source #
Create a value of ListImages
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:filters:ListImages'
, listImages_filters
- Use the following filters to streamline results:
name
osVersion
platform
type
version
$sel:owner:ListImages'
, listImages_owner
- The owner defines which images you want to list. By default, this
request will only show images owned by your account. You can use this
field to specify if you want to view images owned by yourself, by
Amazon, or those images that have been shared with you by other
customers.
$sel:byName:ListImages'
, listImages_byName
- Requests a list of images with a specific recipe name.
$sel:nextToken:ListImages'
, listImages_nextToken
- A token to specify where to start paginating. This is the NextToken from
a previously truncated response.
$sel:includeDeprecated:ListImages'
, listImages_includeDeprecated
- Includes deprecated images in the response list.
$sel:maxResults:ListImages'
, listImages_maxResults
- The maximum items to return in a request.
Request Lenses
listImages_filters :: Lens' ListImages (Maybe (NonEmpty Filter)) Source #
Use the following filters to streamline results:
name
osVersion
platform
type
version
listImages_owner :: Lens' ListImages (Maybe Ownership) Source #
The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
listImages_byName :: Lens' ListImages (Maybe Bool) Source #
Requests a list of images with a specific recipe name.
listImages_nextToken :: Lens' ListImages (Maybe Text) Source #
A token to specify where to start paginating. This is the NextToken from a previously truncated response.
listImages_includeDeprecated :: Lens' ListImages (Maybe Bool) Source #
Includes deprecated images in the response list.
listImages_maxResults :: Lens' ListImages (Maybe Natural) Source #
The maximum items to return in a request.
Destructuring the Response
data ListImagesResponse Source #
See: newListImagesResponse
smart constructor.
ListImagesResponse' | |
|
Instances
newListImagesResponse Source #
Create a value of ListImagesResponse
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:requestId:ListImagesResponse'
, listImagesResponse_requestId
- The request ID that uniquely identifies this request.
$sel:imageVersionList:ListImagesResponse'
, listImagesResponse_imageVersionList
- The list of image semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
$sel:nextToken:ListImages'
, listImagesResponse_nextToken
- The next token used for paginated responses. When this is not empty,
there are additional elements that the service has not included in this
request. Use this token with the next request to retrieve additional
objects.
$sel:httpStatus:ListImagesResponse'
, listImagesResponse_httpStatus
- The response's http status code.
Response Lenses
listImagesResponse_requestId :: Lens' ListImagesResponse (Maybe Text) Source #
The request ID that uniquely identifies this request.
listImagesResponse_imageVersionList :: Lens' ListImagesResponse (Maybe [ImageVersion]) Source #
The list of image semantic versions.
The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text) Source #
The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.
listImagesResponse_httpStatus :: Lens' ListImagesResponse Int Source #
The response's http status code.