AWS SDK for .NET Documentation
DescribeImagesRequest Class
AmazonAmazon.EC2.ModelDescribeImagesRequest Did this page help you?   Yes   No    Tell us about it...
Returns information about AMIs, AKIs, and ARIs. This includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to you include public images, private images that you own, and private images owned by other users for which you have explicit launch permissions.
Declaration Syntax
C#
public class DescribeImagesRequest : EC2Request
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
DescribeImagesRequest()()()()
Initializes a new instance of the DescribeImagesRequest class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExecutableBy
List of executor user IDs. AMIs will be returned for which the specified user(s) have explicit launch permissions.

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 for the Amazon EBS volume (for example, /dev/sdh).
  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
  • block-device-mapping.volume-type - The volume type of the Amazon 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, 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 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).

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ImageId
AMI IDs to describe.

IsSetExecutableBy()()()()
Checks if ExecutableBy property is set

IsSetFilter()()()()
Checks if Filter property is set

IsSetImageId()()()()
Checks if ImageId property is set

IsSetOwner()()()()
Checks if Owner property is set

Owner
Owner(s) for the AMIs to return. Multiple owners can be specified.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithExecutableBy(array<String>[]()[][]) Obsolete.
Sets executor user IDs.

WithFilter(array<Filter>[]()[][]) Obsolete.
Sets filters used to match system-defined properties and user-defined tags associated with the specified Images.

WithImageId(array<String>[]()[][]) Obsolete.
Sets AMI IDs to describe.

WithOwner(array<String>[]()[][]) Obsolete.
Sets owner(s) for the AMIs to return.

Remarks
Launch permissions fall into three categories: 1. public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs. 2. explicit: The owner of the AMI granted launch permissions to a specific user. 3. implicit: A user has implicit launch permissions for all AMIs he or she owns. The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions. If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results. If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own. If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs.
Inheritance Hierarchy
Object
EC2Request
 DescribeImagesRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)