EC2 / Client / describe_images

describe_images

EC2.Client.describe_images(**kwargs)

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 EnableAllowedImagesSettings.

Warning

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

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_images(
    ExecutableUsers=[
        'string',
    ],
    ImageIds=[
        'string',
    ],
    Owners=[
        'string',
    ],
    IncludeDeprecated=True|False,
    IncludeDisabled=True|False,
    MaxResults=123,
    NextToken='string',
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• ExecutableUsers (list) –

  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.

  • (string) –

• ImageIds (list) –

  The image IDs.

  Default: Describes all images available to you.

  • (string) –

• Owners (list) –

  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.

  • (string) –

• IncludeDeprecated (boolean) –

  Specifies whether to include deprecated AMIs.

  Default: No deprecated AMIs are included in the response.

  Note

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

• IncludeDisabled (boolean) –

  Specifies whether to include disabled AMIs.

  Default: No disabled AMIs are included in the response.

• MaxResults (integer) – 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 (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

• DryRun (boolean) – 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 (list) –

  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 CreateImage.

  • 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).

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Images': [
        {
            'PlatformDetails': 'string',
            'UsageOperation': 'string',
            'BlockDeviceMappings': [
                {
                    'Ebs': {
                        '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': {
                'Code': 'string',
                'Message': 'string'
            },
            'Tags': [
                {
                    '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': [
                {
                    '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'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

  • Images (list) –

    Information about the images.

    • (dict) –

      Describes an image.

      • PlatformDetails (string) –

        The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

      • UsageOperation (string) –

        The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

      • BlockDeviceMappings (list) –

        Any block device mapping entries.

        • (dict) –

          Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

          • Ebs (dict) –

            Parameters used to automatically set up EBS volumes when the instance is launched.

            • DeleteOnTermination (boolean) –

              Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.

            • Iops (integer) –

              The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

              The following are the supported values for each volume type:

              • gp3: 3,000 - 16,000 IOPS

              • io1: 100 - 64,000 IOPS

              • io2: 100 - 256,000 IOPS

              For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

              This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.

            • SnapshotId (string) –

              The ID of the snapshot.

            • VolumeSize (integer) –

              The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

              The following are the supported sizes for each volume type:

              • gp2 and gp3: 1 - 16,384 GiB

              • io1: 4 - 16,384 GiB

              • io2: 4 - 65,536 GiB

              • st1 and sc1: 125 - 16,384 GiB

              • standard: 1 - 1024 GiB

            • VolumeType (string) –

              The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

            • KmsKeyId (string) –

              Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

              This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

            • Throughput (integer) –

              The throughput that the volume supports, in MiB/s.

              This parameter is valid only for gp3 volumes.

              Valid Range: Minimum value of 125. Maximum value of 1000.

            • OutpostArn (string) –

              The ARN of the Outpost on which the snapshot is stored.

              This parameter is not supported when using CreateImage.

            • Encrypted (boolean) –

              Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

              In no case can you remove encryption from an encrypted volume.

              Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

              This parameter is not returned by DescribeImageAttribute.

              For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.

              • If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).

              • If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.

              • If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.

              • If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

          • NoDevice (string) –

            To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.

          • DeviceName (string) –

            The device name (for example, /dev/sdh or xvdh).

          • VirtualName (string) –

            The virtual device name ( ephemeral``N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ``ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

            NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

            Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

      • Description (string) –

        The description of the AMI that was provided during image creation.

      • EnaSupport (boolean) –

        Specifies whether enhanced networking with ENA is enabled.

      • Hypervisor (string) –

        The hypervisor type of the image. Only xen is supported. ovm is not supported.

      • ImageOwnerAlias (string) –

        The owner alias ( amazon | aws-backup-vault | aws-marketplace).

      • Name (string) –

        The name of the AMI that was provided during image creation.

      • RootDeviceName (string) –

        The device name of the root device volume (for example, /dev/sda1).

      • RootDeviceType (string) –

        The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

      • SriovNetSupport (string) –

        Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

      • StateReason (dict) –

        The reason for the state change.

        • Code (string) –

          The reason code for the state change.

        • Message (string) –

          The message for the state change.

          • Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.

          • Server.InternalError: An internal error caused the instance to terminate during launch.

          • Server.ScheduledStop: The instance was stopped due to a scheduled retirement.

          • Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

          • Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

          • Client.InstanceInitiatedShutdown: The instance was shut down from the operating system of the instance.

          • Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.

          • Client.InternalError: A client error caused the instance to terminate during launch.

          • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

          • Client.UserInitiatedHibernate: Hibernation was initiated on the instance.

          • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

          • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

      • Tags (list) –

        Any tags assigned to the image.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

      • VirtualizationType (string) –

        The type of virtualization of the AMI.

      • BootMode (string) –

        The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

      • TpmSupport (string) –

        If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

      • DeprecationTime (string) –

        The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DD*T*HH:MM:*SS*Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

      • ImdsSupport (string) –

        If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

      • SourceInstanceId (string) –

        The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

      • DeregistrationProtection (string) –

        Indicates whether deregistration protection is enabled for the AMI.

      • LastLaunchedTime (string) –

        The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

        Note

        lastLaunchedTime data is available starting April 2017.

      • ImageAllowed (boolean) –

        If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false and Allowed AMIs is set to enabled, the AMI can’t be discovered or used in the account. If false and Allowed AMIs is set to audit-mode, the AMI can be discovered and used in the account.

        For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

      • SourceImageId (string) –

        The ID of the source AMI from which the AMI was created.

        The ID only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see Identify the source AMI used to create a new AMI in the Amazon EC2 User Guide.

      • SourceImageRegion (string) –

        The Region of the source AMI.

        The Region only appears if the AMI was created using CreateImage, CopyImage, or CreateRestoreImageTask. The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see Identify the source AMI used to create a new AMI in the Amazon EC2 User Guide.

      • ImageId (string) –

        The ID of the AMI.

      • ImageLocation (string) –

        The location of the AMI.

      • State (string) –

        The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the image.

      • CreationDate (string) –

        The date and time the image was created.

      • Public (boolean) –

        Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

      • ProductCodes (list) –

        Any product codes associated with the AMI.

        • (dict) –

          Describes a product code.

          • ProductCodeId (string) –

            The product code.

          • ProductCodeType (string) –

            The type of product code.

      • Architecture (string) –

        The architecture of the image.

      • ImageType (string) –

        The type of image.

      • KernelId (string) –

        The kernel associated with the image, if any. Only applicable for machine images.

      • RamdiskId (string) –

        The RAM disk associated with the image, if any. Only applicable for machine images.

      • Platform (string) –

        This value is set to windows for Windows AMIs; otherwise, it is blank.

Examples

This example describes the specified AMI.

response = client.describe_images(
    ImageIds=[
        'ami-5731123e',
    ],
)

print(response)

Expected Output:

{
    'Images': [
        {
            'Architecture': 'x86_64',
            'BlockDeviceMappings': [
                {
                    'DeviceName': '/dev/sda1',
                    'Ebs': {
                        'DeleteOnTermination': True,
                        'SnapshotId': 'snap-1234567890abcdef0',
                        'VolumeSize': 8,
                        'VolumeType': 'standard',
                    },
                },
            ],
            'Description': 'An AMI for my server',
            'Hypervisor': 'xen',
            'ImageId': 'ami-5731123e',
            'ImageLocation': '123456789012/My server',
            'ImageType': 'machine',
            'KernelId': 'aki-88aa75e1',
            'Name': 'My server',
            'OwnerId': '123456789012',
            'Public': False,
            'RootDeviceName': '/dev/sda1',
            'RootDeviceType': 'ebs',
            'State': 'available',
            'VirtualizationType': 'paravirtual',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}