Describe Images

ec2_describe_images

R Documentation

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you¶

Description¶

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

The images available to you include public images, private images that you own, and private images owned by other Amazon Web Services accounts for which you have explicit launch permissions.

Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found.

When Allowed AMIs is set to enabled, only allowed images are returned in the results, with the imageAllowed field set to true for each image. In audit-mode, the imageAllowed field is set to true for images that meet the account's Allowed AMIs criteria, and false for images that don't meet the criteria. For more information, see enable_allowed_images_settings.

We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Usage¶

ec2_describe_images(ExecutableUsers, ImageIds, Owners,
  IncludeDeprecated, IncludeDisabled, MaxResults, NextToken, DryRun,
  Filters)

Arguments¶

ExecutableUsers

Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).

If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.

ImageIds

The image IDs.

Default: Describes all images available to you.

Owners

Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs, self, amazon, aws-backup-vault, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.

IncludeDeprecated

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

IncludeDisabled

Specifies whether to include disabled AMIs.

Default: No disabled AMIs are included in the response.

MaxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

DryRun

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.

Filters

The filters.

architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
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, ⁠/dev/sdh⁠ or xvdh).
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 (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, ⁠2021-09-29T11:04:43.305Z⁠. You can use a wildcard (*), for example, ⁠2021-09-29T*⁠, which matches an entire day.
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-allowed - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs.
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 owner alias (amazon | aws-backup-vault | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. The only supported value is windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, ⁠/dev/sda1⁠).
root-device-type - The type of the root device volume (ebs | instance-store).
source-image-id - The ID of the source AMI from which the AMI was created.
source-image-region - The Region of the source AMI.
source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using create_image.
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>⁠ - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  Images = list(
    list(
      PlatformDetails = "string",
      UsageOperation = "string",
      BlockDeviceMappings = list(
        list(
          Ebs = list(
            DeleteOnTermination = TRUE|FALSE,
            Iops = 123,
            SnapshotId = "string",
            VolumeSize = 123,
            VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
            KmsKeyId = "string",
            Throughput = 123,
            OutpostArn = "string",
            Encrypted = TRUE|FALSE
          ),
          NoDevice = "string",
          DeviceName = "string",
          VirtualName = "string"
        )
      ),
      Description = "string",
      EnaSupport = TRUE|FALSE,
      Hypervisor = "ovm"|"xen",
      ImageOwnerAlias = "string",
      Name = "string",
      RootDeviceName = "string",
      RootDeviceType = "ebs"|"instance-store",
      SriovNetSupport = "string",
      StateReason = list(
        Code = "string",
        Message = "string"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      VirtualizationType = "hvm"|"paravirtual",
      BootMode = "legacy-bios"|"uefi"|"uefi-preferred",
      TpmSupport = "v2.0",
      DeprecationTime = "string",
      ImdsSupport = "v2.0",
      SourceInstanceId = "string",
      DeregistrationProtection = "string",
      LastLaunchedTime = "string",
      ImageAllowed = TRUE|FALSE,
      SourceImageId = "string",
      SourceImageRegion = "string",
      ImageId = "string",
      ImageLocation = "string",
      State = "pending"|"available"|"invalid"|"deregistered"|"transient"|"failed"|"error"|"disabled",
      OwnerId = "string",
      CreationDate = "string",
      Public = TRUE|FALSE,
      ProductCodes = list(
        list(
          ProductCodeId = "string",
          ProductCodeType = "devpay"|"marketplace"
        )
      ),
      Architecture = "i386"|"x86_64"|"arm64"|"x86_64_mac"|"arm64_mac",
      ImageType = "machine"|"kernel"|"ramdisk",
      KernelId = "string",
      RamdiskId = "string",
      Platform = "Windows"
    )
  )
)

Request syntax¶

svc$describe_images(
  ExecutableUsers = list(
    "string"
  ),
  ImageIds = list(
    "string"
  ),
  Owners = list(
    "string"
  ),
  IncludeDeprecated = TRUE|FALSE,
  IncludeDisabled = TRUE|FALSE,
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  )
)

Examples¶

## Not run: 
# This example describes the specified AMI.
svc$describe_images(
  ImageIds = list(
    "ami-5731123e"
  )
)

## End(Not run)