feat(client-ec2): Adds complete AMI ancestry tracing from immediate parent through each preceding generation back to the root AMI

awstools · awstools · commit fa8c029baf52 · 2025-11-12T19:40:24.000Z
diff --git a/clients/client-ec2/README.md b/clients/client-ec2/README.md
@@ -4317,6 +4317,14 @@ GetHostReservationPurchasePreview
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/GetHostReservationPurchasePreviewCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/GetHostReservationPurchasePreviewCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/GetHostReservationPurchasePreviewCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetImageAncestry
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/GetImageAncestryCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/GetImageAncestryCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/GetImageAncestryCommandOutput/)
+
 </details>
 <details>
 <summary>
diff --git a/clients/client-ec2/src/EC2.ts b/clients/client-ec2/src/EC2.ts
@@ -2516,6 +2516,11 @@ import {
   GetHostReservationPurchasePreviewCommandInput,
   GetHostReservationPurchasePreviewCommandOutput,
 } from "./commands/GetHostReservationPurchasePreviewCommand";
+import {
+  GetImageAncestryCommand,
+  GetImageAncestryCommandInput,
+  GetImageAncestryCommandOutput,
+} from "./commands/GetImageAncestryCommand";
 import {
   GetImageBlockPublicAccessStateCommand,
   GetImageBlockPublicAccessStateCommandInput,
@@ -4027,6 +4032,7 @@ const commands = {
   GetFlowLogsIntegrationTemplateCommand,
   GetGroupsForCapacityReservationCommand,
   GetHostReservationPurchasePreviewCommand,
+  GetImageAncestryCommand,
   GetImageBlockPublicAccessStateCommand,
   GetInstanceMetadataDefaultsCommand,
   GetInstanceTpmEkPubCommand,
@@ -12910,6 +12916,23 @@ export interface EC2 {
     cb: (err: any, data?: GetHostReservationPurchasePreviewCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetImageAncestryCommand}
+   */
+  getImageAncestry(
+    args: GetImageAncestryCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetImageAncestryCommandOutput>;
+  getImageAncestry(
+    args: GetImageAncestryCommandInput,
+    cb: (err: any, data?: GetImageAncestryCommandOutput) => void
+  ): void;
+  getImageAncestry(
+    args: GetImageAncestryCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetImageAncestryCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetImageBlockPublicAccessStateCommand}
    */
diff --git a/clients/client-ec2/src/EC2Client.ts b/clients/client-ec2/src/EC2Client.ts
@@ -1828,6 +1828,7 @@ import {
   GetHostReservationPurchasePreviewCommandInput,
   GetHostReservationPurchasePreviewCommandOutput,
 } from "./commands/GetHostReservationPurchasePreviewCommand";
+import { GetImageAncestryCommandInput, GetImageAncestryCommandOutput } from "./commands/GetImageAncestryCommand";
 import {
   GetImageBlockPublicAccessStateCommandInput,
   GetImageBlockPublicAccessStateCommandOutput,
@@ -3054,6 +3055,7 @@ export type ServiceInputTypes =
   | GetFlowLogsIntegrationTemplateCommandInput
   | GetGroupsForCapacityReservationCommandInput
   | GetHostReservationPurchasePreviewCommandInput
+  | GetImageAncestryCommandInput
   | GetImageBlockPublicAccessStateCommandInput
   | GetInstanceMetadataDefaultsCommandInput
   | GetInstanceTpmEkPubCommandInput
@@ -3775,6 +3777,7 @@ export type ServiceOutputTypes =
   | GetFlowLogsIntegrationTemplateCommandOutput
   | GetGroupsForCapacityReservationCommandOutput
   | GetHostReservationPurchasePreviewCommandOutput
+  | GetImageAncestryCommandOutput
   | GetImageBlockPublicAccessStateCommandOutput
   | GetInstanceMetadataDefaultsCommandOutput
   | GetInstanceTpmEkPubCommandOutput
diff --git a/clients/client-ec2/src/commands/GetImageAncestryCommand.ts b/clients/client-ec2/src/commands/GetImageAncestryCommand.ts
@@ -0,0 +1,100 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
+import { commonParams } from "../endpoint/EndpointParameters";
+import { GetImageAncestryRequest, GetImageAncestryResult } from "../models/models_7";
+import { GetImageAncestry } from "../schemas/schemas_0";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetImageAncestryCommand}.
+ */
+export interface GetImageAncestryCommandInput extends GetImageAncestryRequest {}
+/**
+ * @public
+ *
+ * The output of {@link GetImageAncestryCommand}.
+ */
+export interface GetImageAncestryCommandOutput extends GetImageAncestryResult, __MetadataBearer {}
+
+/**
+ * <p>Retrieves the ancestry chain of the specified AMI, tracing its lineage back to the root
+ *       AMI. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-ancestry.html">AMI ancestry</a> in
+ *         <i>Amazon EC2 User Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { EC2Client, GetImageAncestryCommand } from "@aws-sdk/client-ec2"; // ES Modules import
+ * // const { EC2Client, GetImageAncestryCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
+ * // import type { EC2ClientConfig } from "@aws-sdk/client-ec2";
+ * const config = {}; // type is EC2ClientConfig
+ * const client = new EC2Client(config);
+ * const input = { // GetImageAncestryRequest
+ *   ImageId: "STRING_VALUE", // required
+ *   DryRun: true || false,
+ * };
+ * const command = new GetImageAncestryCommand(input);
+ * const response = await client.send(command);
+ * // { // GetImageAncestryResult
+ * //   ImageAncestryEntries: [ // ImageAncestryEntryList
+ * //     { // ImageAncestryEntry
+ * //       CreationDate: new Date("TIMESTAMP"),
+ * //       ImageId: "STRING_VALUE",
+ * //       ImageOwnerAlias: "STRING_VALUE",
+ * //       SourceImageId: "STRING_VALUE",
+ * //       SourceImageRegion: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param GetImageAncestryCommandInput - {@link GetImageAncestryCommandInput}
+ * @returns {@link GetImageAncestryCommandOutput}
+ * @see {@link GetImageAncestryCommandInput} for command's `input` shape.
+ * @see {@link GetImageAncestryCommandOutput} for command's `response` shape.
+ * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
+ *
+ * @throws {@link EC2ServiceException}
+ * <p>Base exception class for all service exceptions from EC2 service.</p>
+ *
+ *
+ * @public
+ */
+export class GetImageAncestryCommand extends $Command
+  .classBuilder<
+    GetImageAncestryCommandInput,
+    GetImageAncestryCommandOutput,
+    EC2ClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: EC2ClientResolvedConfig, o: any) {
+    return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())];
+  })
+  .s("AmazonEC2", "GetImageAncestry", {})
+  .n("EC2Client", "GetImageAncestryCommand")
+  .sc(GetImageAncestry)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: GetImageAncestryRequest;
+      output: GetImageAncestryResult;
+    };
+    sdk: {
+      input: GetImageAncestryCommandInput;
+      output: GetImageAncestryCommandOutput;
+    };
+  };
+}
diff --git a/clients/client-ec2/src/commands/ModifyTransitGatewayPrefixListReferenceCommand.ts b/clients/client-ec2/src/commands/ModifyTransitGatewayPrefixListReferenceCommand.ts
@@ -8,7 +8,7 @@ import { commonParams } from "../endpoint/EndpointParameters";
 import {
   ModifyTransitGatewayPrefixListReferenceRequest,
   ModifyTransitGatewayPrefixListReferenceResult,
-} from "../models/models_7";
+} from "../models/models_8";
 import { ModifyTransitGatewayPrefixListReference } from "../schemas/schemas_0";
 
 /**
diff --git a/clients/client-ec2/src/commands/index.ts b/clients/client-ec2/src/commands/index.ts
@@ -513,6 +513,7 @@ export * from "./GetEbsEncryptionByDefaultCommand";
 export * from "./GetFlowLogsIntegrationTemplateCommand";
 export * from "./GetGroupsForCapacityReservationCommand";
 export * from "./GetHostReservationPurchasePreviewCommand";
+export * from "./GetImageAncestryCommand";
 export * from "./GetImageBlockPublicAccessStateCommand";
 export * from "./GetInstanceMetadataDefaultsCommand";
 export * from "./GetInstanceTpmEkPubCommand";
diff --git a/clients/client-ec2/src/models/models_7.ts b/clients/client-ec2/src/models/models_7.ts
@@ -6,7 +6,6 @@ import {
   AddPrefixListEntry,
   AddressAttribute,
   Affinity,
-  ApplianceModeSupportValue,
   AutoPlacement,
   CurrencyCodeValues,
   DnsSupportValue,
@@ -15,7 +14,6 @@ import {
   HostRecovery,
   InstanceEventWindow,
   IpamPoolAllocation,
-  Ipv6SupportValue,
   RouteServerAssociation,
   SecurityGroupReferencingSupportValue,
   SubnetAssociation,
@@ -359,6 +357,75 @@ export interface GetHostReservationPurchasePreviewResult {
   TotalUpfrontPrice?: string | undefined;
 }
 
+/**
+ * @public
+ */
+export interface GetImageAncestryRequest {
+  /**
+   * <p>The ID of the AMI whose ancestry you want to trace.</p>
+   * @public
+   */
+  ImageId: string | undefined;
+
+  /**
+   * <p>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
+   * 			<code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
+   * @public
+   */
+  DryRun?: boolean | undefined;
+}
+
+/**
+ * <p>Information about a single AMI in the ancestry chain and its source (parent) AMI.</p>
+ * @public
+ */
+export interface ImageAncestryEntry {
+  /**
+   * <p>The date and time when this AMI was created.</p>
+   * @public
+   */
+  CreationDate?: Date | undefined;
+
+  /**
+   * <p>The ID of this AMI.</p>
+   * @public
+   */
+  ImageId?: string | undefined;
+
+  /**
+   * <p>The owner alias (<code>amazon</code> | <code>aws-backup-vault</code> |
+   *         <code>aws-marketplace</code> ) of this AMI, if one is assigned. Otherwise, the value is
+   *         <code>null</code>.</p>
+   * @public
+   */
+  ImageOwnerAlias?: string | undefined;
+
+  /**
+   * <p>The ID of the parent AMI.</p>
+   * @public
+   */
+  SourceImageId?: string | undefined;
+
+  /**
+   * <p>The Amazon Web Services Region of the parent AMI.</p>
+   * @public
+   */
+  SourceImageRegion?: string | undefined;
+}
+
+/**
+ * @public
+ */
+export interface GetImageAncestryResult {
+  /**
+   * <p>A list of entries in the AMI ancestry chain, from the specified AMI to the root
+   *       AMI.</p>
+   * @public
+   */
+  ImageAncestryEntries?: ImageAncestryEntry[] | undefined;
+}
+
 /**
  * @public
  */
@@ -9700,85 +9767,3 @@ export interface ModifyTransitGatewayResult {
    */
   TransitGateway?: TransitGateway | undefined;
 }
-
-/**
- * @public
- */
-export interface ModifyTransitGatewayPrefixListReferenceRequest {
-  /**
-   * <p>The ID of the transit gateway route table.</p>
-   * @public
-   */
-  TransitGatewayRouteTableId: string | undefined;
-
-  /**
-   * <p>The ID of the prefix list.</p>
-   * @public
-   */
-  PrefixListId: string | undefined;
-
-  /**
-   * <p>The ID of the attachment to which traffic is routed.</p>
-   * @public
-   */
-  TransitGatewayAttachmentId?: string | undefined;
-
-  /**
-   * <p>Indicates whether to drop traffic that matches this route.</p>
-   * @public
-   */
-  Blackhole?: boolean | undefined;
-
-  /**
-   * <p>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 <code>DryRunOperation</code>.
-   *    Otherwise, it is <code>UnauthorizedOperation</code>.</p>
-   * @public
-   */
-  DryRun?: boolean | undefined;
-}
-
-/**
- * @public
- */
-export interface ModifyTransitGatewayPrefixListReferenceResult {
-  /**
-   * <p>Information about the prefix list reference.</p>
-   * @public
-   */
-  TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference | undefined;
-}
-
-/**
- * <p>Describes the options for a VPC attachment.</p>
- * @public
- */
-export interface ModifyTransitGatewayVpcAttachmentRequestOptions {
-  /**
-   * <p>Enable or disable DNS support. The default is <code>enable</code>.</p>
-   * @public
-   */
-  DnsSupport?: DnsSupportValue | undefined;
-
-  /**
-   * <p>Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.
-   *
-   * </p>
-   *          <p>This option is disabled by default.</p>
-   *          <p>For more information about security group referencing, see  <a href="https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security">Security group referencing</a> in the <i>Amazon Web Services Transit Gateways Guide</i>.</p>
-   * @public
-   */
-  SecurityGroupReferencingSupport?: SecurityGroupReferencingSupportValue | undefined;
-
-  /**
-   * <p>Enable or disable IPv6 support. The default is <code>enable</code>.</p>
-   * @public
-   */
-  Ipv6Support?: Ipv6SupportValue | undefined;
-
-  /**
-   * <p>Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is <code>disable</code>.</p>
-   * @public
-   */
-  ApplianceModeSupport?: ApplianceModeSupportValue | undefined;
-}
diff --git a/clients/client-ec2/src/models/models_8.ts b/clients/client-ec2/src/models/models_8.ts
diff --git a/clients/client-ec2/src/schemas/schemas_0.ts b/clients/client-ec2/src/schemas/schemas_0.ts
diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json
