Network.AWS.EC2.DescribeImages

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.

Creating a Request

describeImages :: DescribeImages

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:

• deseOwners - Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft ). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
• deseExecutableUsers - 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 - 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 specified in the block device mapping (for example, devsdh or xvdh ). * 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 | io1 | st1 | sc1 | standard ). * description - The description of the image (provided during image creation). * ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. * 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 - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft ) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. * owner-id - The AWS account ID of the image owner. * platform - The platform. To only list Windows-based AMIs, use windows . * 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 device name of the root device volume (for example, devsda1 ). * 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. * sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. * tag :key =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * 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 - One or more image IDs. Default: Describes all images available to you.
• deseDryRun - 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 .

data DescribeImages

Contains the parameters for DescribeImages.

See: describeImages smart constructor.

Instances

Eq DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

(==) :: DescribeImages -> DescribeImages -> Bool

(/=) :: DescribeImages -> DescribeImages -> Bool

Data DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeImages -> c DescribeImages

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeImages

toConstr :: DescribeImages -> Constr

dataTypeOf :: DescribeImages -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeImages)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeImages)

gmapT :: (forall b. Data b => b -> b) -> DescribeImages -> DescribeImages

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImages -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImages -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeImages -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeImages -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeImages -> m DescribeImages

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImages -> m DescribeImages

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImages -> m DescribeImages

Read DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

readsPrec :: Int -> ReadS DescribeImages

readList :: ReadS [DescribeImages]

readPrec :: ReadPrec DescribeImages

readListPrec :: ReadPrec [DescribeImages]

Show DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

showsPrec :: Int -> DescribeImages -> ShowS

show :: DescribeImages -> String

showList :: [DescribeImages] -> ShowS

Generic DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Associated Types

type Rep DescribeImages :: Type -> Type

Methods

from :: DescribeImages -> Rep DescribeImages x

to :: Rep DescribeImages x -> DescribeImages

Hashable DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

hashWithSalt :: Int -> DescribeImages -> Int

hash :: DescribeImages -> Int

AWSRequest DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Associated Types

type Rs DescribeImages :: Type

Methods

request :: DescribeImages -> Request DescribeImages

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeImages -> ClientResponse -> m (Response DescribeImages)

ToHeaders DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

toHeaders :: DescribeImages -> [Header]

ToPath DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

toPath :: DescribeImages -> ByteString

ToQuery DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

toQuery :: DescribeImages -> QueryString

NFData DescribeImages

Defined in Network.AWS.EC2.DescribeImages

Methods

rnf :: DescribeImages -> ()

type Rep DescribeImages

Defined in Network.AWS.EC2.DescribeImages

type Rep DescribeImages = D1 (MetaData "DescribeImages" "Network.AWS.EC2.DescribeImages" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "DescribeImages'" PrefixI True) ((S1 (MetaSel (Just "_deseOwners") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_deseExecutableUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_deseFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 (MetaSel (Just "_deseImageIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_deseDryRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))

type Rs DescribeImages

Defined in Network.AWS.EC2.DescribeImages

type Rs DescribeImages = DescribeImagesResponse

Request Lenses

deseOwners :: Lens' DescribeImages [Text]

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft ). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

deseExecutableUsers :: Lens' DescribeImages [Text]

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]

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 specified in the block device mapping (for example, devsdh or xvdh ). * 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 | io1 | st1 | sc1 | standard ). * description - The description of the image (provided during image creation). * ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled. * 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 - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft ) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console. * owner-id - The AWS account ID of the image owner. * platform - The platform. To only list Windows-based AMIs, use windows . * 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 device name of the root device volume (for example, devsda1 ). * 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. * sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled. * tag :key =value - The keyvalue combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value. * 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]

One or more image IDs. Default: Describes all images available to you.

deseDryRun :: Lens' DescribeImages (Maybe Bool)

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

describeImagesResponse

Arguments

:: Int

diirsResponseStatus

-> DescribeImagesResponse

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:

• diirsImages - Information about one or more images.
• diirsResponseStatus - -- | The response status code.

data DescribeImagesResponse

Contains the output of DescribeImages.

See: describeImagesResponse smart constructor.

Instances

Eq DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

Methods

(==) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool

(/=) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool

Data DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeImagesResponse -> c DescribeImagesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeImagesResponse

toConstr :: DescribeImagesResponse -> Constr

dataTypeOf :: DescribeImagesResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeImagesResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeImagesResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeImagesResponse -> DescribeImagesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImagesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImagesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeImagesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeImagesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeImagesResponse -> m DescribeImagesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImagesResponse -> m DescribeImagesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImagesResponse -> m DescribeImagesResponse

Read DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

Methods

readsPrec :: Int -> ReadS DescribeImagesResponse

readList :: ReadS [DescribeImagesResponse]

readPrec :: ReadPrec DescribeImagesResponse

readListPrec :: ReadPrec [DescribeImagesResponse]

Show DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

Methods

showsPrec :: Int -> DescribeImagesResponse -> ShowS

show :: DescribeImagesResponse -> String

showList :: [DescribeImagesResponse] -> ShowS

Generic DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

Associated Types

type Rep DescribeImagesResponse :: Type -> Type

Methods

from :: DescribeImagesResponse -> Rep DescribeImagesResponse x

to :: Rep DescribeImagesResponse x -> DescribeImagesResponse

NFData DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

Methods

rnf :: DescribeImagesResponse -> ()

type Rep DescribeImagesResponse

Defined in Network.AWS.EC2.DescribeImages

type Rep DescribeImagesResponse = D1 (MetaData "DescribeImagesResponse" "Network.AWS.EC2.DescribeImages" "amazonka-ec2-1.6.1-GgG1M0FWcBrE5I5IM2QktE" False) (C1 (MetaCons "DescribeImagesResponse'" PrefixI True) (S1 (MetaSel (Just "_diirsImages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Image])) :*: S1 (MetaSel (Just "_diirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

diirsImages :: Lens' DescribeImagesResponse [Image]

Information about one or more images.

diirsResponseStatus :: Lens' DescribeImagesResponse Int

• - | The response status code.