getAmi

AWS v7.32.0, May 29 26

Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getAmi({
    executableUsers: ["self"],
    mostRecent: true,
    nameRegex: "^myami-[0-9]{3}",
    owners: ["self"],
    filters: [
        {
            name: "name",
            values: ["myami-*"],
        },
        {
            name: "root-device-type",
            values: ["ebs"],
        },
        {
            name: "virtualization-type",
            values: ["hvm"],
        },
    ],
});

import pulumi
import pulumi_aws as aws

example = aws.ec2.get_ami(executable_users=["self"],
    most_recent=True,
    name_regex="^myami-[0-9]{3}",
    owners=["self"],
    filters=[
        {
            "name": "name",
            "values": ["myami-*"],
        },
        {
            "name": "root-device-type",
            "values": ["ebs"],
        },
        {
            "name": "virtualization-type",
            "values": ["hvm"],
        },
    ])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.LookupAmi(ctx, &ec2.LookupAmiArgs{
			ExecutableUsers: []string{
				"self",
			},
			MostRecent: pulumi.BoolRef(true),
			NameRegex:  pulumi.StringRef("^myami-[0-9]{3}"),
			Owners: []string{
				"self",
			},
			Filters: []ec2.GetAmiFilter{
				{
					Name: "name",
					Values: []string{
						"myami-*",
					},
				},
				{
					Name: "root-device-type",
					Values: []string{
						"ebs",
					},
				},
				{
					Name: "virtualization-type",
					Values: []string{
						"hvm",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Ec2.GetAmi.Invoke(new()
    {
        ExecutableUsers = new[]
        {
            "self",
        },
        MostRecent = true,
        NameRegex = "^myami-[0-9]{3}",
        Owners = new[]
        {
            "self",
        },
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "name",
                Values = new[]
                {
                    "myami-*",
                },
            },
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "root-device-type",
                Values = new[]
                {
                    "ebs",
                },
            },
            new Aws.Ec2.Inputs.GetAmiFilterInputArgs
            {
                Name = "virtualization-type",
                Values = new[]
                {
                    "hvm",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetAmiArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Ec2Functions.getAmi(GetAmiArgs.builder()
            .executableUsers("self")
            .mostRecent(true)
            .nameRegex("^myami-[0-9]{3}")
            .owners("self")
            .filters(            
                GetAmiFilterArgs.builder()
                    .name("name")
                    .values("myami-*")
                    .build(),
                GetAmiFilterArgs.builder()
                    .name("root-device-type")
                    .values("ebs")
                    .build(),
                GetAmiFilterArgs.builder()
                    .name("virtualization-type")
                    .values("hvm")
                    .build())
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:ec2:getAmi
      arguments:
        executableUsers:
          - self
        mostRecent: true
        nameRegex: ^myami-[0-9]{3}
        owners:
          - self
        filters:
          - name: name
            values:
              - myami-*
          - name: root-device-type
            values:
              - ebs
          - name: virtualization-type
            values:
              - hvm

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_getami" "example" {
  executable_users = ["self"]
  most_recent      = true
  name_regex       = "^myami-[0-9]{3}"
  owners           = ["self"]
  filters {
    name   = "name"
    values = ["myami-*"]
  }
  filters {
    name   = "root-device-type"
    values = ["ebs"]
  }
  filters {
    name   = "virtualization-type"
    values = ["hvm"]
  }
}

Using getAmi

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAmi(args: GetAmiArgs, opts?: InvokeOptions): Promise<GetAmiResult>
function getAmiOutput(args: GetAmiOutputArgs, opts?: InvokeOptions): Output<GetAmiResult>

def get_ami(allow_unsafe_filter: Optional[bool] = None,
            executable_users: Optional[Sequence[str]] = None,
            filters: Optional[Sequence[GetAmiFilter]] = None,
            include_deprecated: Optional[bool] = None,
            most_recent: Optional[bool] = None,
            name_regex: Optional[str] = None,
            owners: Optional[Sequence[str]] = None,
            region: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            uefi_data: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetAmiResult
def get_ami_output(allow_unsafe_filter: pulumi.Input[Optional[bool]] = None,
            executable_users: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
            filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetAmiFilterArgs]]]] = None,
            include_deprecated: pulumi.Input[Optional[bool]] = None,
            most_recent: pulumi.Input[Optional[bool]] = None,
            name_regex: pulumi.Input[Optional[str]] = None,
            owners: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
            region: pulumi.Input[Optional[str]] = None,
            tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
            uefi_data: pulumi.Input[Optional[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetAmiResult]

func LookupAmi(ctx *Context, args *LookupAmiArgs, opts ...InvokeOption) (*LookupAmiResult, error)
func LookupAmiOutput(ctx *Context, args *LookupAmiOutputArgs, opts ...InvokeOption) LookupAmiResultOutput

> Note: This function is named LookupAmi in the Go SDK.

public static class GetAmi 
{
    public static Task<GetAmiResult> InvokeAsync(GetAmiArgs args, InvokeOptions? opts = null)
    public static Output<GetAmiResult> Invoke(GetAmiInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAmiResult> getAmi(GetAmiArgs args, InvokeOptions options)
public static Output<GetAmiResult> getAmi(GetAmiArgs args, InvokeOptions options)

fn::invoke:
  function: aws:ec2/getAmi:getAmi
  arguments:
    # arguments dictionary

data "aws_ec2_getami" "name" {
    # arguments
}

The following arguments are supported:

AllowUnsafeFilter bool: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
ExecutableUsers List<string>: Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
Filters List<GetAmiFilter>: One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
IncludeDeprecated bool: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
MostRecent bool: If more than one result is returned, use the most recent AMI.
NameRegex string: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
Owners List<string>: List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags Dictionary<string, string>: Any tags assigned to the image.
UefiData string: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

AllowUnsafeFilter bool: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
ExecutableUsers []string: Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
Filters []GetAmiFilter: One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
IncludeDeprecated bool: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
MostRecent bool: If more than one result is returned, use the most recent AMI.
NameRegex string: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
Owners []string: List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags map[string]string: Any tags assigned to the image.
UefiData string: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

allow_unsafe_filter bool: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
executable_users list(string): Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters list(object): One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
include_deprecated bool: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
most_recent bool: If more than one result is returned, use the most recent AMI.
name_regex string: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
owners list(string): List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags map(string): Any tags assigned to the image.
uefi_data string: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

allowUnsafeFilter Boolean: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
executableUsers List<String>: Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters List<GetAmiFilter>: One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
includeDeprecated Boolean: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
mostRecent Boolean: If more than one result is returned, use the most recent AMI.
nameRegex String: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
owners List<String>: List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String,String>: Any tags assigned to the image.
uefiData String: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

allowUnsafeFilter boolean: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
executableUsers string[]: Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters GetAmiFilter[]: One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
includeDeprecated boolean: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
mostRecent boolean: If more than one result is returned, use the most recent AMI.
nameRegex string: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
owners string[]: List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags {[key: string]: string}: Any tags assigned to the image.
uefiData string: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

allow_unsafe_filter bool: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
executable_users Sequence[str]: Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters Sequence[GetAmiFilter]: One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
include_deprecated bool: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
most_recent bool: If more than one result is returned, use the most recent AMI.
name_regex str: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
owners Sequence[str]: List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Mapping[str, str]: Any tags assigned to the image.
uefi_data str: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

allowUnsafeFilter Boolean: If true, allow unsafe filter values. With unsafe filters and mostRecent set to true, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
executableUsers List<String>: Limit search to users with explicit launch permission on the image. Valid items are the numeric account ID or self.
filters List<Property Map>: One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out describe-images in the AWS CLI reference. See filter below.
includeDeprecated Boolean: If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
mostRecent Boolean: If more than one result is returned, use the most recent AMI.
nameRegex String: Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
owners List<String>: List of AMI owners to limit search. Valid values: an AWS account ID, self (the current account), or an AWS owner alias (e.g., amazon, aws-marketplace, microsoft).
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String>: Any tags assigned to the image.
uefiData String: Base64 representation of the non-volatile UEFI variable store.
NOTE: If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use mostRecent to choose the most recent one. If you want to match multiple AMIs, use the aws.ec2.getAmiIds data source instead.

getAmi Result

The following output properties are available:

Architecture string: OS architecture of the AMI (ie: i386 or x8664).
Arn string: ARN of the AMI.
BlockDeviceMappings List<GetAmiBlockDeviceMapping>: Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
BootMode string: Boot mode of the image.
CreationDate string: Date and time the image was created.
DeprecationTime string: Date and time when the image will be deprecated.
Description string: Description of the AMI that was provided during image creation.
EnaSupport bool: Whether enhanced networking with ENA is enabled.
Hypervisor string: Hypervisor type of the image.
Id string: The provider-assigned unique ID for this managed resource.
ImageId string: ID of the AMI. Should be the same as the resource id.
ImageLocation string: Location of the AMI.
ImageOwnerAlias string: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
ImageType string: Type of image.
ImdsSupport string: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
KernelId string: Kernel associated with the image, if any. Only applicable for machine images.
LastLaunchedTime string: 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. For more information, see the following AWS document.
Name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
OwnerId string: AWS account ID of the image owner.
Platform string: Value is Windows for Windows AMIs; otherwise blank.
PlatformDetails string: Platform details associated with the billing code of the AMI.
ProductCodes List<GetAmiProductCode>: Any product codes associated with the AMI. See productCodes below.
Public bool: true if the image has public launch permissions.
RamdiskId string: RAM disk associated with the image, if any. Only applicable for machine images.
Region string
RootDeviceName string: Device name of the root device.
RootDeviceType string: Type of root device (ie: ebs or instance-store).
RootSnapshotId string: Snapshot id associated with the root device, if any (only applies to ebs root devices).
SriovNetSupport string: Whether enhanced networking is enabled.
State string: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
StateReason Dictionary<string, string>: Describes a state change. Fields are UNSET if not available. See stateReason below.
Tags Dictionary<string, string>: Any tags assigned to the image.
TpmSupport string: If the image is configured for NitroTPM support, the value is v2.0.
UsageOperation string: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
VirtualizationType string: Type of virtualization of the AMI (ie: hvm or paravirtual).
AllowUnsafeFilter bool
ExecutableUsers List<string>
Filters List<GetAmiFilter>
IncludeDeprecated bool
MostRecent bool
NameRegex string
Owners List<string>
UefiData string

Architecture string: OS architecture of the AMI (ie: i386 or x8664).
Arn string: ARN of the AMI.
BlockDeviceMappings []GetAmiBlockDeviceMapping: Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
BootMode string: Boot mode of the image.
CreationDate string: Date and time the image was created.
DeprecationTime string: Date and time when the image will be deprecated.
Description string: Description of the AMI that was provided during image creation.
EnaSupport bool: Whether enhanced networking with ENA is enabled.
Hypervisor string: Hypervisor type of the image.
Id string: The provider-assigned unique ID for this managed resource.
ImageId string: ID of the AMI. Should be the same as the resource id.
ImageLocation string: Location of the AMI.
ImageOwnerAlias string: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
ImageType string: Type of image.
ImdsSupport string: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
KernelId string: Kernel associated with the image, if any. Only applicable for machine images.
LastLaunchedTime string: 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. For more information, see the following AWS document.
Name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
OwnerId string: AWS account ID of the image owner.
Platform string: Value is Windows for Windows AMIs; otherwise blank.
PlatformDetails string: Platform details associated with the billing code of the AMI.
ProductCodes []GetAmiProductCode: Any product codes associated with the AMI. See productCodes below.
Public bool: true if the image has public launch permissions.
RamdiskId string: RAM disk associated with the image, if any. Only applicable for machine images.
Region string
RootDeviceName string: Device name of the root device.
RootDeviceType string: Type of root device (ie: ebs or instance-store).
RootSnapshotId string: Snapshot id associated with the root device, if any (only applies to ebs root devices).
SriovNetSupport string: Whether enhanced networking is enabled.
State string: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
StateReason map[string]string: Describes a state change. Fields are UNSET if not available. See stateReason below.
Tags map[string]string: Any tags assigned to the image.
TpmSupport string: If the image is configured for NitroTPM support, the value is v2.0.
UsageOperation string: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
VirtualizationType string: Type of virtualization of the AMI (ie: hvm or paravirtual).
AllowUnsafeFilter bool
ExecutableUsers []string
Filters []GetAmiFilter
IncludeDeprecated bool
MostRecent bool
NameRegex string
Owners []string
UefiData string

architecture string: OS architecture of the AMI (ie: i386 or x8664).
arn string: ARN of the AMI.
block_device_mappings list(object): Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
boot_mode string: Boot mode of the image.
creation_date string: Date and time the image was created.
deprecation_time string: Date and time when the image will be deprecated.
description string: Description of the AMI that was provided during image creation.
ena_support bool: Whether enhanced networking with ENA is enabled.
hypervisor string: Hypervisor type of the image.
id string: The provider-assigned unique ID for this managed resource.
image_id string: ID of the AMI. Should be the same as the resource id.
image_location string: Location of the AMI.
image_owner_alias string: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
image_type string: Type of image.
imds_support string: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
kernel_id string: Kernel associated with the image, if any. Only applicable for machine images.
last_launched_time string: 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. For more information, see the following AWS document.
name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
owner_id string: AWS account ID of the image owner.
platform string: Value is Windows for Windows AMIs; otherwise blank.
platform_details string: Platform details associated with the billing code of the AMI.
product_codes list(object): Any product codes associated with the AMI. See productCodes below.
public bool: true if the image has public launch permissions.
ramdisk_id string: RAM disk associated with the image, if any. Only applicable for machine images.
region string
root_device_name string: Device name of the root device.
root_device_type string: Type of root device (ie: ebs or instance-store).
root_snapshot_id string: Snapshot id associated with the root device, if any (only applies to ebs root devices).
sriov_net_support string: Whether enhanced networking is enabled.
state string: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
state_reason map(string): Describes a state change. Fields are UNSET if not available. See stateReason below.
tags map(string): Any tags assigned to the image.
tpm_support string: If the image is configured for NitroTPM support, the value is v2.0.
usage_operation string: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
virtualization_type string: Type of virtualization of the AMI (ie: hvm or paravirtual).
allow_unsafe_filter bool
executable_users list(string)
filters list(object)
include_deprecated bool
most_recent bool
name_regex string
owners list(string)
uefi_data string

architecture String: OS architecture of the AMI (ie: i386 or x8664).
arn String: ARN of the AMI.
blockDeviceMappings List<GetAmiBlockDeviceMapping>: Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
bootMode String: Boot mode of the image.
creationDate String: Date and time the image was created.
deprecationTime String: Date and time when the image will be deprecated.
description String: Description of the AMI that was provided during image creation.
enaSupport Boolean: Whether enhanced networking with ENA is enabled.
hypervisor String: Hypervisor type of the image.
id String: The provider-assigned unique ID for this managed resource.
imageId String: ID of the AMI. Should be the same as the resource id.
imageLocation String: Location of the AMI.
imageOwnerAlias String: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
imageType String: Type of image.
imdsSupport String: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
kernelId String: Kernel associated with the image, if any. Only applicable for machine images.
lastLaunchedTime String: 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. For more information, see the following AWS document.
name String: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
ownerId String: AWS account ID of the image owner.
platform String: Value is Windows for Windows AMIs; otherwise blank.
platformDetails String: Platform details associated with the billing code of the AMI.
productCodes List<GetAmiProductCode>: Any product codes associated with the AMI. See productCodes below.
public_ Boolean: true if the image has public launch permissions.
ramdiskId String: RAM disk associated with the image, if any. Only applicable for machine images.
region String
rootDeviceName String: Device name of the root device.
rootDeviceType String: Type of root device (ie: ebs or instance-store).
rootSnapshotId String: Snapshot id associated with the root device, if any (only applies to ebs root devices).
sriovNetSupport String: Whether enhanced networking is enabled.
state String: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
stateReason Map<String,String>: Describes a state change. Fields are UNSET if not available. See stateReason below.
tags Map<String,String>: Any tags assigned to the image.
tpmSupport String: If the image is configured for NitroTPM support, the value is v2.0.
usageOperation String: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
virtualizationType String: Type of virtualization of the AMI (ie: hvm or paravirtual).
allowUnsafeFilter Boolean
executableUsers List<String>
filters List<GetAmiFilter>
includeDeprecated Boolean
mostRecent Boolean
nameRegex String
owners List<String>
uefiData String

architecture string: OS architecture of the AMI (ie: i386 or x8664).
arn string: ARN of the AMI.
blockDeviceMappings GetAmiBlockDeviceMapping[]: Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
bootMode string: Boot mode of the image.
creationDate string: Date and time the image was created.
deprecationTime string: Date and time when the image will be deprecated.
description string: Description of the AMI that was provided during image creation.
enaSupport boolean: Whether enhanced networking with ENA is enabled.
hypervisor string: Hypervisor type of the image.
id string: The provider-assigned unique ID for this managed resource.
imageId string: ID of the AMI. Should be the same as the resource id.
imageLocation string: Location of the AMI.
imageOwnerAlias string: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
imageType string: Type of image.
imdsSupport string: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
kernelId string: Kernel associated with the image, if any. Only applicable for machine images.
lastLaunchedTime string: 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. For more information, see the following AWS document.
name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
ownerId string: AWS account ID of the image owner.
platform string: Value is Windows for Windows AMIs; otherwise blank.
platformDetails string: Platform details associated with the billing code of the AMI.
productCodes GetAmiProductCode[]: Any product codes associated with the AMI. See productCodes below.
public boolean: true if the image has public launch permissions.
ramdiskId string: RAM disk associated with the image, if any. Only applicable for machine images.
region string
rootDeviceName string: Device name of the root device.
rootDeviceType string: Type of root device (ie: ebs or instance-store).
rootSnapshotId string: Snapshot id associated with the root device, if any (only applies to ebs root devices).
sriovNetSupport string: Whether enhanced networking is enabled.
state string: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
stateReason {[key: string]: string}: Describes a state change. Fields are UNSET if not available. See stateReason below.
tags {[key: string]: string}: Any tags assigned to the image.
tpmSupport string: If the image is configured for NitroTPM support, the value is v2.0.
usageOperation string: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
virtualizationType string: Type of virtualization of the AMI (ie: hvm or paravirtual).
allowUnsafeFilter boolean
executableUsers string[]
filters GetAmiFilter[]
includeDeprecated boolean
mostRecent boolean
nameRegex string
owners string[]
uefiData string

architecture str: OS architecture of the AMI (ie: i386 or x8664).
arn str: ARN of the AMI.
block_device_mappings Sequence[GetAmiBlockDeviceMapping]: Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
boot_mode str: Boot mode of the image.
creation_date str: Date and time the image was created.
deprecation_time str: Date and time when the image will be deprecated.
description str: Description of the AMI that was provided during image creation.
ena_support bool: Whether enhanced networking with ENA is enabled.
hypervisor str: Hypervisor type of the image.
id str: The provider-assigned unique ID for this managed resource.
image_id str: ID of the AMI. Should be the same as the resource id.
image_location str: Location of the AMI.
image_owner_alias str: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
image_type str: Type of image.
imds_support str: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
kernel_id str: Kernel associated with the image, if any. Only applicable for machine images.
last_launched_time str: 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. For more information, see the following AWS document.
name str: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
owner_id str: AWS account ID of the image owner.
platform str: Value is Windows for Windows AMIs; otherwise blank.
platform_details str: Platform details associated with the billing code of the AMI.
product_codes Sequence[GetAmiProductCode]: Any product codes associated with the AMI. See productCodes below.
public bool: true if the image has public launch permissions.
ramdisk_id str: RAM disk associated with the image, if any. Only applicable for machine images.
region str
root_device_name str: Device name of the root device.
root_device_type str: Type of root device (ie: ebs or instance-store).
root_snapshot_id str: Snapshot id associated with the root device, if any (only applies to ebs root devices).
sriov_net_support str: Whether enhanced networking is enabled.
state str: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
state_reason Mapping[str, str]: Describes a state change. Fields are UNSET if not available. See stateReason below.
tags Mapping[str, str]: Any tags assigned to the image.
tpm_support str: If the image is configured for NitroTPM support, the value is v2.0.
usage_operation str: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
virtualization_type str: Type of virtualization of the AMI (ie: hvm or paravirtual).
allow_unsafe_filter bool
executable_users Sequence[str]
filters Sequence[GetAmiFilter]
include_deprecated bool
most_recent bool
name_regex str
owners Sequence[str]
uefi_data str

architecture String: OS architecture of the AMI (ie: i386 or x8664).
arn String: ARN of the AMI.
blockDeviceMappings List<Property Map>: Set of objects with block device mappings of the AMI. See blockDeviceMappings below.
bootMode String: Boot mode of the image.
creationDate String: Date and time the image was created.
deprecationTime String: Date and time when the image will be deprecated.
description String: Description of the AMI that was provided during image creation.
enaSupport Boolean: Whether enhanced networking with ENA is enabled.
hypervisor String: Hypervisor type of the image.
id String: The provider-assigned unique ID for this managed resource.
imageId String: ID of the AMI. Should be the same as the resource id.
imageLocation String: Location of the AMI.
imageOwnerAlias String: AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
imageType String: Type of image.
imdsSupport String: Instance Metadata Service (IMDS) support mode for the image. Set to v2.0 if instances ran from this image enforce IMDSv2.
kernelId String: Kernel associated with the image, if any. Only applicable for machine images.
lastLaunchedTime String: 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. For more information, see the following AWS document.
name String: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
ownerId String: AWS account ID of the image owner.
platform String: Value is Windows for Windows AMIs; otherwise blank.
platformDetails String: Platform details associated with the billing code of the AMI.
productCodes List<Property Map>: Any product codes associated with the AMI. See productCodes below.
public Boolean: true if the image has public launch permissions.
ramdiskId String: RAM disk associated with the image, if any. Only applicable for machine images.
region String
rootDeviceName String: Device name of the root device.
rootDeviceType String: Type of root device (ie: ebs or instance-store).
rootSnapshotId String: Snapshot id associated with the root device, if any (only applies to ebs root devices).
sriovNetSupport String: Whether enhanced networking is enabled.
state String: Current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
stateReason Map<String>: Describes a state change. Fields are UNSET if not available. See stateReason below.
tags Map<String>: Any tags assigned to the image.
tpmSupport String: If the image is configured for NitroTPM support, the value is v2.0.
usageOperation String: Operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
virtualizationType String: Type of virtualization of the AMI (ie: hvm or paravirtual).
allowUnsafeFilter Boolean
executableUsers List<String>
filters List<Property Map>
includeDeprecated Boolean
mostRecent Boolean
nameRegex String
owners List<String>
uefiData String

Supporting Types

GetAmiBlockDeviceMapping

DeviceName string: Physical name of the device.
Ebs Dictionary<string, string>: Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
NoDevice string: Suppresses the specified device included in the block device mapping of the AMI.
VirtualName string: Virtual device name (for instance stores).

DeviceName string: Physical name of the device.
Ebs map[string]string: Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
NoDevice string: Suppresses the specified device included in the block device mapping of the AMI.
VirtualName string: Virtual device name (for instance stores).

device_name string: Physical name of the device.
ebs map(string): Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
no_device string: Suppresses the specified device included in the block device mapping of the AMI.
virtual_name string: Virtual device name (for instance stores).

deviceName String: Physical name of the device.
ebs Map<String,String>: Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
noDevice String: Suppresses the specified device included in the block device mapping of the AMI.
virtualName String: Virtual device name (for instance stores).

deviceName string: Physical name of the device.
ebs {[key: string]: string}: Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
noDevice string: Suppresses the specified device included in the block device mapping of the AMI.
virtualName string: Virtual device name (for instance stores).

device_name str: Physical name of the device.
ebs Mapping[str, str]: Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
no_device str: Suppresses the specified device included in the block device mapping of the AMI.
virtual_name str: Virtual device name (for instance stores).

deviceName String: Physical name of the device.
ebs Map<String>: Map containing EBS information, if the device is EBS based. Unlike most object attributes, these are accessed directly (e.g., ebs.volume_size or ebs["volumeSize"]) rather than accessed through the first element of a list (e.g., ebs[0].volume_size). See ebs below.
noDevice String: Suppresses the specified device included in the block device mapping of the AMI.
virtualName String: Virtual device name (for instance stores).

GetAmiFilter

Name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
Values List<string>: Set of values that are accepted for the given filter.

Name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
Values []string: Set of values that are accepted for the given filter.

name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
values list(string): Set of values that are accepted for the given filter.

name String: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
values List<String>: Set of values that are accepted for the given filter.

name string: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
values string[]: Set of values that are accepted for the given filter.

name str: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
values Sequence[str]: Set of values that are accepted for the given filter.

name String: Name of the filter. For a full reference, check out describe-images in the AWS CLI reference.
values List<String>: Set of values that are accepted for the given filter.

GetAmiProductCode

ProductCodeId string: The product code.
ProductCodeType string: The type of product code.

ProductCodeId string: The product code.
ProductCodeType string: The type of product code.

product_code_id string: The product code.
product_code_type string: The type of product code.

productCodeId String: The product code.
productCodeType String: The type of product code.

productCodeId string: The product code.
productCodeType string: The type of product code.

product_code_id str: The product code.
product_code_type str: The type of product code.

productCodeId String: The product code.
productCodeType String: The type of product code.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

aws.ec2.getAmi

On this page

On this page

Example Usage

Using getAmi

getAmi Result

Supporting Types

GetAmiBlockDeviceMapping

GetAmiFilter

GetAmiProductCode

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aws.ec2.getAmi

On this page

On this page

Example Usage

Using getAmi

getAmi Result

Supporting Types

GetAmiBlockDeviceMapping

GetAmiFilter

GetAmiProductCode

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.