From b6f2e1d506d7cb6cf015ed5b3280187c71bc01ce Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 7 Mar 2024 19:22:29 +0000 Subject: [PATCH] feat(client-ec2): This release adds an optional parameter to RegisterImage and CopyImage APIs to support tagging AMIs at the time of creation. --- .../src/commands/BundleInstanceCommand.ts | 6 +- .../CancelImageLaunchPermissionCommand.ts | 7 +- .../src/commands/CopyImageCommand.ts | 40 ++-- .../src/commands/CreateImageCommand.ts | 11 +- .../commands/CreateRestoreImageTaskCommand.ts | 6 +- .../commands/CreateStoreImageTaskCommand.ts | 2 +- .../src/commands/DeregisterImageCommand.ts | 22 +- .../commands/DescribeBundleTasksCommand.ts | 9 +- .../commands/DescribeImageAttributeCommand.ts | 7 +- .../src/commands/DescribeImagesCommand.ts | 12 +- .../DescribeStoreImageTasksCommand.ts | 2 +- .../src/commands/DisableFastLaunchCommand.ts | 10 +- .../DisableImageBlockPublicAccessCommand.ts | 4 +- .../src/commands/EnableFastLaunchCommand.ts | 15 +- .../commands/EnableImageDeprecationCommand.ts | 3 +- .../commands/ListImagesInRecycleBinCommand.ts | 4 +- .../commands/ModifyImageAttributeCommand.ts | 12 +- .../src/commands/RegisterImageCommand.ts | 37 +-- .../RestoreImageFromRecycleBinCommand.ts | 3 +- clients/client-ec2/src/models/models_0.ts | 65 ++++-- clients/client-ec2/src/models/models_1.ts | 24 +- clients/client-ec2/src/models/models_2.ts | 9 +- clients/client-ec2/src/models/models_3.ts | 162 ++++++------- clients/client-ec2/src/models/models_4.ts | 3 +- clients/client-ec2/src/models/models_5.ts | 73 +++--- clients/client-ec2/src/models/models_6.ts | 109 +++++---- clients/client-ec2/src/models/models_7.ts | 3 +- clients/client-ec2/src/protocols/Aws_ec2.ts | 20 ++ codegen/sdk-codegen/aws-models/ec2.json | 214 ++++++++++-------- 29 files changed, 521 insertions(+), 373 deletions(-) diff --git a/clients/client-ec2/src/commands/BundleInstanceCommand.ts b/clients/client-ec2/src/commands/BundleInstanceCommand.ts index c66505a51661..7a84de267d72 100644 --- a/clients/client-ec2/src/commands/BundleInstanceCommand.ts +++ b/clients/client-ec2/src/commands/BundleInstanceCommand.ts @@ -34,9 +34,11 @@ export interface BundleInstanceCommandOutput extends BundleInstanceResult, __Met /** * @public *

Bundles an Amazon instance store-backed Windows instance.

- *

During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.

+ *

During bundling, only the root device volume (C:\) is bundled. Data on other instance + * store volumes is not preserved.

* - *

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

+ *

This action is not applicable for Linux/Unix instances or Windows instances that are + * backed by Amazon EBS.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/CancelImageLaunchPermissionCommand.ts b/clients/client-ec2/src/commands/CancelImageLaunchPermissionCommand.ts index cb7f65a753ea..2530bb81edb9 100644 --- a/clients/client-ec2/src/commands/CancelImageLaunchPermissionCommand.ts +++ b/clients/client-ec2/src/commands/CancelImageLaunchPermissionCommand.ts @@ -28,10 +28,9 @@ export interface CancelImageLaunchPermissionCommandOutput extends CancelImageLau /** * @public - *

Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more - * information, see - * Cancel having an AMI shared with your Amazon Web Services account in the - * Amazon EC2 User Guide.

+ *

Removes your Amazon Web Services account from the launch permissions for the specified AMI. + * For more information, see Cancel having an AMI shared with + * your Amazon Web Services account in the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CopyImageCommand.ts b/clients/client-ec2/src/commands/CopyImageCommand.ts index 2d60df332e23..004fbd981974 100644 --- a/clients/client-ec2/src/commands/CopyImageCommand.ts +++ b/clients/client-ec2/src/commands/CopyImageCommand.ts @@ -29,22 +29,19 @@ export interface CopyImageCommandOutput extends CopyImageResult, __MetadataBeare /** * @public *

Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a - * Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost - * to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

- *

To copy an AMI from one Region to another, specify the source Region using the - * SourceRegion parameter, and specify the - * destination Region using its endpoint. Copies of encrypted backing snapshots for - * the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, - * unless you set Encrypted during the copy operation. You cannot - * create an unencrypted copy of an encrypted backing snapshot.

- *

To copy an AMI from a Region to an Outpost, specify the source Region using the - * SourceRegion parameter, and specify the - * ARN of the destination Outpost using DestinationOutpostArn. - * Backing snapshots copied to an Outpost are encrypted by default using the default - * encryption key for the Region, or a different key that you specify in the request using - * KmsKeyId. Outposts do not support unencrypted - * snapshots. For more information, - * Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.

+ * Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to + * another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

+ *

To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its + * endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of + * unencrypted backing snapshots remain unencrypted, unless you set Encrypted during + * the copy operation. You cannot create an unencrypted copy of an encrypted backing + * snapshot.

+ *

To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination + * Outpost using DestinationOutpostArn. Backing snapshots copied + * to an Outpost are encrypted by default using the default encryption key for the Region, or a + * different key that you specify in the request using KmsKeyId. + * Outposts do not support unencrypted snapshots. For more information, Amazon EBS local + * snapshots on Outposts in the Amazon EC2 User Guide.

*

For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the * Amazon EC2 User Guide.

* @example @@ -64,6 +61,17 @@ export interface CopyImageCommandOutput extends CopyImageResult, __MetadataBeare * DestinationOutpostArn: "STRING_VALUE", * DryRun: true || false, * CopyImageTags: true || false, + * TagSpecifications: [ // TagSpecificationList + * { // TagSpecification + * ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint", + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * ], * }; * const command = new CopyImageCommand(input); * const response = await client.send(command); diff --git a/clients/client-ec2/src/commands/CreateImageCommand.ts b/clients/client-ec2/src/commands/CreateImageCommand.ts index 51b54a4e9081..ab8914b4b67e 100644 --- a/clients/client-ec2/src/commands/CreateImageCommand.ts +++ b/clients/client-ec2/src/commands/CreateImageCommand.ts @@ -28,11 +28,12 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB /** * @public - *

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance - * that is either running or stopped.

- *

If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the - * new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, - * the instance automatically launches with those additional volumes.

+ *

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or + * stopped.

+ *

If you customized your instance with instance store volumes or Amazon EBS volumes in addition + * to the root device volume, the new AMI contains block device mapping information for those + * volumes. When you launch an instance from this new AMI, the instance automatically launches + * with those additional volumes.

*

For more information, see Create an Amazon EBS-backed Linux * AMI in the Amazon Elastic Compute Cloud User Guide.

* @example diff --git a/clients/client-ec2/src/commands/CreateRestoreImageTaskCommand.ts b/clients/client-ec2/src/commands/CreateRestoreImageTaskCommand.ts index 4a6da51e47af..46f44143fcbe 100644 --- a/clients/client-ec2/src/commands/CreateRestoreImageTaskCommand.ts +++ b/clients/client-ec2/src/commands/CreateRestoreImageTaskCommand.ts @@ -28,12 +28,12 @@ export interface CreateRestoreImageTaskCommandOutput extends CreateRestoreImageT /** * @public - *

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using - * CreateStoreImageTask.

+ *

Starts a task that restores an AMI from an Amazon S3 object that was previously created by + * using CreateStoreImageTask.

*

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the * Amazon EC2 User Guide.

*

For more information, see Store and restore an AMI using - * Amazon S3 in the Amazon EC2 User Guide.

+ * Amazon S3 in the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/CreateStoreImageTaskCommand.ts b/clients/client-ec2/src/commands/CreateStoreImageTaskCommand.ts index 5a80adb747b8..00e9969283a9 100644 --- a/clients/client-ec2/src/commands/CreateStoreImageTaskCommand.ts +++ b/clients/client-ec2/src/commands/CreateStoreImageTaskCommand.ts @@ -32,7 +32,7 @@ export interface CreateStoreImageTaskCommandOutput extends CreateStoreImageTaskR *

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the * Amazon EC2 User Guide.

*

For more information, see Store and restore an AMI using - * Amazon S3 in the Amazon EC2 User Guide.

+ * Amazon S3 in the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DeregisterImageCommand.ts b/clients/client-ec2/src/commands/DeregisterImageCommand.ts index 7922894be8ad..bb1b39b07528 100644 --- a/clients/client-ec2/src/commands/DeregisterImageCommand.ts +++ b/clients/client-ec2/src/commands/DeregisterImageCommand.ts @@ -28,18 +28,18 @@ export interface DeregisterImageCommandOutput extends __MetadataBearer {} /** * @public - *

Deregisters the specified AMI. After you deregister an AMI, it can't be used to - * launch new instances.

- *

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained - * in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in + *

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new + * instances.

+ *

If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in + * the Recycle Bin for the specified retention period. For more information, see Recycle Bin in * the Amazon EC2 User Guide.

- *

When you deregister an AMI, it doesn't affect any instances that you've already - * launched from the AMI. You'll continue to incur usage costs for those instances until - * you terminate them.

- *

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was - * created for the root volume of the instance during the AMI creation process. When you - * deregister an instance store-backed AMI, it doesn't affect the files that you uploaded - * to Amazon S3 when you created the AMI.

+ *

When you deregister an AMI, it doesn't affect any instances that you've already launched + * from the AMI. You'll continue to incur usage costs for those instances until you terminate + * them.

+ *

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created + * for the root volume of the instance during the AMI creation process. When you deregister an + * instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you + * created the AMI.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeBundleTasksCommand.ts b/clients/client-ec2/src/commands/DescribeBundleTasksCommand.ts index a8f454ca8235..98eb32e141b4 100644 --- a/clients/client-ec2/src/commands/DescribeBundleTasksCommand.ts +++ b/clients/client-ec2/src/commands/DescribeBundleTasksCommand.ts @@ -34,7 +34,14 @@ export interface DescribeBundleTasksCommandOutput extends DescribeBundleTasksRes * @public *

Describes the specified bundle tasks or all of your bundle tasks.

* - *

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

+ *

Completed bundle tasks are listed for only a limited time. If your bundle task is no + * longer in the list, you can still register an AMI from it. Just use + * RegisterImage with the Amazon S3 bucket name and image manifest name you provided + * to the bundle task.

+ * + * + *

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.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts b/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts index dd827cdc346c..762232c77376 100644 --- a/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts +++ b/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts @@ -28,7 +28,12 @@ export interface DescribeImageAttributeCommandOutput extends ImageAttribute, __M /** * @public - *

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

+ *

Describes the specified attribute of the specified AMI. You can specify only one attribute + * at a time.

+ * + *

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.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeImagesCommand.ts b/clients/client-ec2/src/commands/DescribeImagesCommand.ts index 1b4a872d59f9..f78c7b55b5ab 100644 --- a/clients/client-ec2/src/commands/DescribeImagesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeImagesCommand.ts @@ -28,13 +28,19 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResult, __Met /** * @public - *

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.

+ *

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.

+ * + *

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.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DescribeStoreImageTasksCommand.ts b/clients/client-ec2/src/commands/DescribeStoreImageTasksCommand.ts index 8b65a025fb1f..98e3bb2e9c86 100644 --- a/clients/client-ec2/src/commands/DescribeStoreImageTasksCommand.ts +++ b/clients/client-ec2/src/commands/DescribeStoreImageTasksCommand.ts @@ -39,7 +39,7 @@ export interface DescribeStoreImageTasksCommandOutput extends DescribeStoreImage *

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using Amazon S3 in the * Amazon EC2 User Guide.

*

For more information, see Store and restore an AMI using - * Amazon S3 in the Amazon EC2 User Guide.

+ * Amazon S3 in the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts b/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts index ec7e373e048c..dec89334ba5e 100644 --- a/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts +++ b/clients/client-ec2/src/commands/DisableFastLaunchCommand.ts @@ -28,11 +28,13 @@ export interface DisableFastLaunchCommandOutput extends DisableFastLaunchResult, /** * @public - *

Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. - * After you disable Windows fast launch, the AMI uses the standard launch process for each - * new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.

+ *

Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned + * snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for + * each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable + * Windows fast launch again.

* - *

You can only change these settings for Windows AMIs that you own or that have been shared with you.

+ *

You can only change these settings for Windows AMIs that you own or that have been + * shared with you.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/DisableImageBlockPublicAccessCommand.ts b/clients/client-ec2/src/commands/DisableImageBlockPublicAccessCommand.ts index b0bc1d178eae..57c19b043966 100644 --- a/clients/client-ec2/src/commands/DisableImageBlockPublicAccessCommand.ts +++ b/clients/client-ec2/src/commands/DisableImageBlockPublicAccessCommand.ts @@ -38,8 +38,8 @@ export interface DisableImageBlockPublicAccessCommandOutput * GetImageBlockPublicAccessState, the response will be * block-new-sharing. When the API has completed the configuration, the response * will be unblocked.

- *

For more information, see Block public access to your AMIs in - * the Amazon EC2 User Guide.

+ *

For more information, see Block + * public access to your AMIs in the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts b/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts index 8f31c5750572..ab21f57ab025 100644 --- a/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts +++ b/clients/client-ec2/src/commands/EnableFastLaunchCommand.ts @@ -28,14 +28,15 @@ export interface EnableFastLaunchCommandOutput extends EnableFastLaunchResult, _ /** * @public - *

When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, - * using snapshots to launch instances up to 65% faster. To create the optimized Windows - * image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. - * Then it creates a set of reserved snapshots that are used for subsequent launches. The - * reserved snapshots are automatically replenished as they are used, depending on your - * settings for launch frequency.

+ *

When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using + * snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 + * launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a + * set of reserved snapshots that are used for subsequent launches. The reserved snapshots are + * automatically replenished as they are used, depending on your settings for launch + * frequency.

* - *

You can only change these settings for Windows AMIs that you own or that have been shared with you.

+ *

You can only change these settings for Windows AMIs that you own or that have been + * shared with you.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/EnableImageDeprecationCommand.ts b/clients/client-ec2/src/commands/EnableImageDeprecationCommand.ts index f1c6b23bd553..63fad5b9f838 100644 --- a/clients/client-ec2/src/commands/EnableImageDeprecationCommand.ts +++ b/clients/client-ec2/src/commands/EnableImageDeprecationCommand.ts @@ -29,7 +29,8 @@ export interface EnableImageDeprecationCommandOutput extends EnableImageDeprecat /** * @public *

Enables deprecation of the specified AMI at the specified date and time.

- *

For more information, see Deprecate an AMI in the Amazon EC2 User Guide.

+ *

For more information, see Deprecate an AMI in the + * Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts b/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts index 7c1aba876272..b9b087bf3f8d 100644 --- a/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts +++ b/clients/client-ec2/src/commands/ListImagesInRecycleBinCommand.ts @@ -28,8 +28,8 @@ export interface ListImagesInRecycleBinCommandOutput extends ListImagesInRecycle /** * @public - *

Lists one or more AMIs that are currently in the Recycle Bin. For more information, - * see Recycle + *

Lists one or more AMIs that are currently in the Recycle Bin. For more information, see + * Recycle * Bin in the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/src/commands/ModifyImageAttributeCommand.ts b/clients/client-ec2/src/commands/ModifyImageAttributeCommand.ts index 597c4c4d8f12..9eefd77d7b7c 100644 --- a/clients/client-ec2/src/commands/ModifyImageAttributeCommand.ts +++ b/clients/client-ec2/src/commands/ModifyImageAttributeCommand.ts @@ -28,12 +28,14 @@ export interface ModifyImageAttributeCommandOutput extends __MetadataBearer {} /** * @public - *

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

- *

To specify the attribute, you can use the Attribute parameter, or one of the following parameters: - * Description, ImdsSupport, or LaunchPermission.

+ *

Modifies the specified attribute of the specified AMI. You can specify only one attribute + * at a time.

+ *

To specify the attribute, you can use the Attribute parameter, or one of the + * following parameters: Description, ImdsSupport, or + * LaunchPermission.

*

Images with an Amazon Web Services Marketplace product code cannot be made public.

- *

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance - * and create an AMI from the instance.

+ *

To enable the SriovNetSupport enhanced networking attribute of an image, enable + * SriovNetSupport on an instance and create an AMI from the instance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/RegisterImageCommand.ts b/clients/client-ec2/src/commands/RegisterImageCommand.ts index 55ba7192bff2..8e7f650ff7fb 100644 --- a/clients/client-ec2/src/commands/RegisterImageCommand.ts +++ b/clients/client-ec2/src/commands/RegisterImageCommand.ts @@ -28,8 +28,8 @@ export interface RegisterImageCommandOutput extends RegisterImageResult, __Metad /** * @public - *

Registers an AMI. When you're creating an AMI, this is the final step you must complete - * before you can launch an instance from the AMI. For more information about creating AMIs, see + *

Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI + * is the final step in the creation process. For more information about creating AMIs, see * Create your * own AMI in the Amazon Elastic Compute Cloud User Guide.

* @@ -38,23 +38,23 @@ export interface RegisterImageCommandOutput extends RegisterImageResult, __Metad * always use CreateImage unless you have a specific reason to use * RegisterImage.

* - *

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. - * If you make changes to an image, deregister the previous image and register the new image.

+ *

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI + * backed by an instance store volume invalidates its registration. If you make changes to an + * image, deregister the previous image and register the new image.

*

* Register a snapshot of a root device volume *

- *

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from - * a snapshot of a root device volume. You specify the snapshot using a block device mapping. - * You can't set the encryption state of the volume using the block device mapping. If the - * snapshot is encrypted, or encryption by default is enabled, the root volume of an instance - * launched from the AMI is encrypted.

- *

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs - * in the Amazon Elastic Compute Cloud User Guide.

+ *

You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot + * of a root device volume. You specify the snapshot using a block device mapping. You can't set + * the encryption state of the volume using the block device mapping. If the snapshot is + * encrypted, or encryption by default is enabled, the root volume of an instance launched from + * the AMI is encrypted.

+ *

For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed + * AMIs in the Amazon Elastic Compute Cloud User Guide.

*

* Amazon Web Services Marketplace product codes *

- *

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new - * AMI.

+ *

If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.

*

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE * Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to * verify the subscription status for package updates. To create a new AMI for operating systems @@ -120,6 +120,17 @@ export interface RegisterImageCommandOutput extends RegisterImageResult, __Metad * TpmSupport: "v2.0", * UefiData: "STRING_VALUE", * ImdsSupport: "v2.0", + * TagSpecifications: [ // TagSpecificationList + * { // TagSpecification + * ResourceType: "capacity-reservation" || "client-vpn-endpoint" || "customer-gateway" || "carrier-gateway" || "coip-pool" || "dedicated-host" || "dhcp-options" || "egress-only-internet-gateway" || "elastic-ip" || "elastic-gpu" || "export-image-task" || "export-instance-task" || "fleet" || "fpga-image" || "host-reservation" || "image" || "import-image-task" || "import-snapshot-task" || "instance" || "instance-event-window" || "internet-gateway" || "ipam" || "ipam-pool" || "ipam-scope" || "ipv4pool-ec2" || "ipv6pool-ec2" || "key-pair" || "launch-template" || "local-gateway" || "local-gateway-route-table" || "local-gateway-virtual-interface" || "local-gateway-virtual-interface-group" || "local-gateway-route-table-vpc-association" || "local-gateway-route-table-virtual-interface-group-association" || "natgateway" || "network-acl" || "network-interface" || "network-insights-analysis" || "network-insights-path" || "network-insights-access-scope" || "network-insights-access-scope-analysis" || "placement-group" || "prefix-list" || "replace-root-volume-task" || "reserved-instances" || "route-table" || "security-group" || "security-group-rule" || "snapshot" || "spot-fleet-request" || "spot-instances-request" || "subnet" || "subnet-cidr-reservation" || "traffic-mirror-filter" || "traffic-mirror-session" || "traffic-mirror-target" || "transit-gateway" || "transit-gateway-attachment" || "transit-gateway-connect-peer" || "transit-gateway-multicast-domain" || "transit-gateway-policy-table" || "transit-gateway-route-table" || "transit-gateway-route-table-announcement" || "volume" || "vpc" || "vpc-endpoint" || "vpc-endpoint-connection" || "vpc-endpoint-service" || "vpc-endpoint-service-permission" || "vpc-peering-connection" || "vpn-connection" || "vpn-gateway" || "vpc-flow-log" || "capacity-reservation-fleet" || "traffic-mirror-filter-rule" || "vpc-endpoint-connection-device-type" || "verified-access-instance" || "verified-access-group" || "verified-access-endpoint" || "verified-access-policy" || "verified-access-trust-provider" || "vpn-connection-device-type" || "vpc-block-public-access-exclusion" || "ipam-resource-discovery" || "ipam-resource-discovery-association" || "instance-connect-endpoint", + * Tags: [ // TagList + * { // Tag + * Key: "STRING_VALUE", + * Value: "STRING_VALUE", + * }, + * ], + * }, + * ], * }; * const command = new RegisterImageCommand(input); * const response = await client.send(command); diff --git a/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts b/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts index e6177f7348b5..91df98d1bb6a 100644 --- a/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts +++ b/clients/client-ec2/src/commands/RestoreImageFromRecycleBinCommand.ts @@ -28,7 +28,8 @@ export interface RestoreImageFromRecycleBinCommandOutput extends RestoreImageFro /** * @public - *

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.

+ *

Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in + * the Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/models/models_0.ts b/clients/client-ec2/src/models/models_0.ts index 964ab0a3ce2d..38e81c0794b7 100644 --- a/clients/client-ec2/src/models/models_0.ts +++ b/clients/client-ec2/src/models/models_0.ts @@ -6865,21 +6865,23 @@ export interface AuthorizeSecurityGroupIngressResult { /** * @public - *

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.

+ *

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed + * AMI.

*/ export interface S3Storage { /** * @public *

The access key ID of the owner of the bucket. Before you specify a value for your access - * key ID, review and follow the guidance in Best - * Practices for Amazon Web Services accounts in the Account ManagementReference - * Guide.

+ * key ID, review and follow the guidance in Best Practices for Amazon Web Services + * accounts in the Account ManagementReference Guide.

*/ AWSAccessKeyId?: string; /** * @public - *

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

+ *

The bucket in which to store the AMI. You can specify a bucket that you already own or a + * new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone + * else, Amazon EC2 returns an error.

*/ Bucket?: string; @@ -6891,7 +6893,8 @@ export interface S3Storage { /** * @public - *

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

+ *

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your + * behalf.

*/ UploadPolicy?: Uint8Array; @@ -6922,15 +6925,15 @@ export interface BundleInstanceRequest { /** * @public *

The ID of the instance to bundle.

- *

Type: String

*

Default: None

- *

Required: Yes

*/ InstanceId: string | undefined; /** * @public - *

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

+ *

The bucket in which to store the AMI. You can specify a bucket that you already own or a + * new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone + * else, Amazon EC2 returns an error.

*/ Storage: Storage | undefined; @@ -7840,9 +7843,9 @@ export interface CopyFpgaImageResult { export interface CopyImageRequest { /** * @public - *

Unique, case-sensitive identifier you provide to ensure - * idempotency of the request. For more information, see Ensuring idempotency - * in the Amazon EC2 API Reference.

+ *

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For + * more information, see Ensuring idempotency + * in the Amazon EC2 API Reference.

*/ ClientToken?: string; @@ -7864,9 +7867,9 @@ export interface CopyImageRequest { /** * @public - *

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating - * encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. - * If you specify a KMS key, you must also set the encrypted state to true.

+ *

The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. + * If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you + * specify a KMS key, you must also set the encrypted state to true.

*

You can specify a KMS key using any of the following:

* - *

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, - * the action can appear to complete, but eventually fails.

+ *

Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier + * that is not valid, the action can appear to complete, but eventually fails.

*

The specified KMS key must exist in the destination Region.

*

Amazon EBS does not support asymmetric KMS keys.

*/ @@ -7909,11 +7912,10 @@ export interface CopyImageRequest { /** * @public - *

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only - * specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. - * The AMI must be in the Region of the destination Outpost. You cannot copy an - * AMI from an Outpost to a Region, from one Outpost to another, or within the same - * Outpost.

+ *

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this + * parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the + * Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from + * one Outpost to another, or within the same Outpost.

*

For more information, see Copy AMIs from an Amazon Web Services * Region to an Outpost in the Amazon EC2 User Guide.

*/ @@ -7943,6 +7945,25 @@ export interface CopyImageRequest { *

Default: Your user-defined AMI tags are not copied.

*/ CopyImageTags?: boolean; + + /** + * @public + *

The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or + * both.

+ * + *

If you specify other values for ResourceType, the request fails.

+ *

To tag an AMI or snapshot after it has been created, see CreateTags.

+ */ + TagSpecifications?: TagSpecification[]; } /** diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts index 44dfdafa04a7..6c883663be6d 100644 --- a/clients/client-ec2/src/models/models_1.ts +++ b/clients/client-ec2/src/models/models_1.ts @@ -4447,27 +4447,29 @@ export interface CreateImageRequest { /** * @public *

A name for the new image.

- *

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

+ *

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces + * ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or + * underscores(_)

*/ Name: string | undefined; /** * @public - *

Indicates whether or not the instance should be automatically rebooted before creating - * the image. Specify one of the following values:

+ *

Indicates whether or not the instance should be automatically rebooted before creating the + * image. Specify one of the following values:

* *

Default: false @@ -4485,8 +4487,8 @@ export interface CreateImageRequest { * image.

* *
  • - *

    To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that - * are attached to the instance, the value for ResourceType must be + *

    To tag the snapshots that are created of the root volume and of other Amazon EBS volumes + * that are attached to the instance, the value for ResourceType must be * snapshot. The same tag is applied to all of the snapshots that are * created.

    *
    • diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index 8f9e86442a1d..ca1deceb4b16 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -952,12 +952,13 @@ export interface CreateRestoreImageTaskRequest { * snapshots, or both.

    * */ diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index ce954a3d743c..ac5fe45ba766 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -2722,7 +2722,8 @@ export interface DescribeBundleTasksRequest { * *
  • *

    - * progress - The level of task completion, as a percentage (for example, 20%).

    + * progress - The level of task completion, as a percentage (for example, + * 20%).

    *
    • *
  • *

    @@ -2734,12 +2735,14 @@ export interface DescribeBundleTasksRequest { *

    • *
  • *

    - * start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

    + * start-time - The time the task started (for example, + * 2013-09-15T17:15:20.000Z).

    *
    • *
  • *

    - * state - The state of the task (pending | waiting-for-shutdown | bundling | - * storing | cancelling | complete | failed).

    + * state - The state of the task (pending | + * waiting-for-shutdown | bundling | storing | + * cancelling | complete | failed).

    *
    • *
  • *

    @@ -5493,14 +5496,14 @@ export type FastLaunchResourceType = (typeof FastLaunchResourceType)[keyof typeo /** * @public - *

    Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch - * enabled Windows AMI.

    + *

    Configuration settings for creating and managing pre-provisioned snapshots for a Windows + * fast launch enabled Windows AMI.

    */ export interface FastLaunchSnapshotConfigurationResponse { /** * @public - *

    The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch - * enabled AMI.

    + *

    The number of pre-provisioned snapshots requested to keep on hand for a Windows fast + * launch enabled AMI.

    */ TargetResourceCount?: number; } @@ -5525,8 +5528,9 @@ export type FastLaunchStateCode = (typeof FastLaunchStateCode)[keyof typeof Fast /** * @public - *

    Describe details about a Windows image with Windows fast launch enabled that meets the requested - * criteria. Criteria are defined by the DescribeFastLaunchImages action filters.

    + *

    Describe details about a Windows image with Windows fast launch enabled that meets the + * requested criteria. Criteria are defined by the DescribeFastLaunchImages action + * filters.

    */ export interface DescribeFastLaunchImagesSuccessItem { /** @@ -5538,28 +5542,28 @@ export interface DescribeFastLaunchImagesSuccessItem { /** * @public *

    The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values - * include: snapshot.

    + * include: snapshot.

    */ ResourceType?: FastLaunchResourceType; /** * @public - *

    A group of parameters that are used for pre-provisioning the associated - * Windows AMI using snapshots.

    + *

    A group of parameters that are used for pre-provisioning the associated Windows AMI using + * snapshots.

    */ SnapshotConfiguration?: FastLaunchSnapshotConfigurationResponse; /** * @public - *

    The launch template that the Windows fast launch enabled AMI uses when it launches - * Windows instances from pre-provisioned snapshots.

    + *

    The launch template that the Windows fast launch enabled AMI uses when it launches Windows + * instances from pre-provisioned snapshots.

    */ LaunchTemplate?: FastLaunchLaunchTemplateSpecificationResponse; /** * @public *

    The maximum number of instances that Amazon EC2 can launch at the same time to create - * pre-provisioned snapshots for Windows fast launch.

    + * pre-provisioned snapshots for Windows fast launch.

    */ MaxParallelLaunches?: number; @@ -5594,8 +5598,8 @@ export interface DescribeFastLaunchImagesSuccessItem { export interface DescribeFastLaunchImagesResult { /** * @public - *

    A collection of details about the fast-launch enabled Windows images that meet - * the requested criteria.

    + *

    A collection of details about the fast-launch enabled Windows images that meet the + * requested criteria.

    */ FastLaunchImages?: DescribeFastLaunchImagesSuccessItem[]; @@ -8318,9 +8322,9 @@ export interface DescribeImageAttributeRequest { * @public *

    The AMI attribute.

    *

    - * Note: The blockDeviceMapping attribute is deprecated. - * Using this attribute returns the Client.AuthFailure error. To get information about - * the block device mappings for an AMI, use the DescribeImages action.

    + * Note: The blockDeviceMapping attribute is + * deprecated. Using this attribute returns the Client.AuthFailure error. To get + * information about the block device mappings for an AMI, use the DescribeImages action.

    */ Attribute: ImageAttributeName | undefined; @@ -8419,7 +8423,8 @@ export interface ImageAttribute { /** * @public - *

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

    + *

    Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is + * enabled.

    */ SriovNetSupport?: AttributeValue; @@ -8439,9 +8444,9 @@ export interface ImageAttribute { * @public *

    Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, * use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the - * python-uefivars tool on + * python-uefivars tool on * GitHub. For more information, see UEFI Secure Boot in the - * Amazon EC2 User Guide.

    + * Amazon EC2 User Guide.

    */ UefiData?: AttributeValue; @@ -8463,8 +8468,7 @@ export interface ImageAttribute { * 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.

    + * information, see Configure the AMI in the Amazon EC2 User Guide.

    */ ImdsSupport?: AttributeValue; } @@ -8475,14 +8479,13 @@ export interface ImageAttribute { export interface DescribeImagesRequest { /** * @public - *

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

    + *

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

    *