Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
Deregistered images are included in the returned results for an unspecified interval after deregistration.
- describeImages :: DescribeImages
- data DescribeImages
- deseOwners :: Lens' DescribeImages [Text]
- deseExecutableUsers :: Lens' DescribeImages [Text]
- deseFilters :: Lens' DescribeImages [Filter]
- deseImageIds :: Lens' DescribeImages [Text]
- deseDryRun :: Lens' DescribeImages (Maybe Bool)
- describeImagesResponse :: Int -> DescribeImagesResponse
- data DescribeImagesResponse
- desrsImages :: Lens' DescribeImagesResponse [Image]
- desrsResponseStatus :: Lens' DescribeImagesResponse Int
Creating a Request
describeImages :: DescribeImages Source
Creates a value of DescribeImages
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeImages Source
See: describeImages
smart constructor.
Request Lenses
deseOwners :: Lens' DescribeImages [Text] Source
Filters the images by the owner. Specify an AWS account ID, amazon
(owner is Amazon), 'aws-marketplace' (owner is AWS Marketplace), self
(owner is the sender of the request). Omitting this option returns all
images for which you have launch permissions, regardless of ownership.
deseExecutableUsers :: Lens' DescribeImages [Text] Source
Scopes the images by users with explicit launch permissions. Specify an
AWS account ID, self
(the sender of the request), or all
(public
AMIs).
deseFilters :: Lens' DescribeImages [Filter] Source
One or more filters.
architecture
- The image architecture (i386
|x86_64
).- 'block-device-mapping.delete-on-termination' - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
- 'block-device-mapping.device-name' - The device name for the EBS volume (for example, '\/dev\/sdh').
- 'block-device-mapping.snapshot-id' - The ID of the snapshot used for the EBS volume.
- 'block-device-mapping.volume-size' - The volume size of the EBS volume, in GiB.
- 'block-device-mapping.volume-type' - The volume type of the EBS
volume (
gp2
|standard
|io1
). description
- The description of the image (provided during image creation).hypervisor
- The hypervisor type (ovm
|xen
).- 'image-id' - The ID of the image.
- 'image-type' - The image type (
machine
|kernel
|ramdisk
). - 'is-public' - A Boolean that indicates whether the image is public.
- 'kernel-id' - The kernel ID.
- 'manifest-location' - The location of the image manifest.
name
- The name of the AMI (provided during image creation).- 'owner-alias' - The AWS account alias (for example,
amazon
). - 'owner-id' - The AWS account ID of the image owner.
platform
- The platform. To only list Windows-based AMIs, usewindows
.- 'product-code' - The product code.
- 'product-code.type' - The type of the product code (
devpay
|marketplace
). - 'ramdisk-id' - The RAM disk ID.
- 'root-device-name' - The name of the root device volume (for example, '\/dev\/sda1').
- 'root-device-type' - The type of the root device volume (
ebs
| 'instance-store'). state
- The state of the image (available
|pending
|failed
).- 'state-reason-code' - The reason code for the state change.
- 'state-reason-message' - The message for the state change.
tag
:key=value - The key/value combination of a tag assigned to the resource.- 'tag-key' - The key of a tag assigned to the resource. This filter
is independent of the tag-value filter. For example, if you use both
the filter "tag-key=Purpose" and the filter "tag-value=X", you
get any resources assigned both the tag key Purpose (regardless of
what the tag's value is), and the tag value X (regardless of what
the tag's key is). If you want to list only resources where Purpose
is X, see the
tag
:key=value filter. - 'tag-value' - The value of a tag assigned to the resource. This filter is independent of the 'tag-key' filter.
- 'virtualization-type' - The virtualization type (
paravirtual
|hvm
).
deseImageIds :: Lens' DescribeImages [Text] Source
One or more image IDs.
Default: Describes all images available to you.
deseDryRun :: Lens' DescribeImages (Maybe Bool) Source
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
Destructuring the Response
Creates a value of DescribeImagesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeImagesResponse Source
See: describeImagesResponse
smart constructor.
Response Lenses
desrsImages :: Lens' DescribeImagesResponse [Image] Source
Information about one or more images.
desrsResponseStatus :: Lens' DescribeImagesResponse Int Source
The response status code.