Skip to content

Commit b6f2e1d

Browse files
author
awstools
committed
feat(client-ec2): This release adds an optional parameter to RegisterImage and CopyImage APIs to support tagging AMIs at the time of creation.
1 parent c7a2f3f commit b6f2e1d

29 files changed

+521
-373
lines changed

‎clients/client-ec2/src/commands/BundleInstanceCommand.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ export interface BundleInstanceCommandOutput extends BundleInstanceResult, __Met
3434
/**
3535
* @public
3636
* <p>Bundles an Amazon instance store-backed Windows instance.</p>
37-
* <p>During bundling, only the root device volume (C:\) is bundled. Data on other instance store volumes is not preserved.</p>
37+
* <p>During bundling, only the root device volume (C:\) is bundled. Data on other instance
38+
* store volumes is not preserved.</p>
3839
* <note>
39-
* <p>This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.</p>
40+
* <p>This action is not applicable for Linux/Unix instances or Windows instances that are
41+
* backed by Amazon EBS.</p>
4042
* </note>
4143
* @example
4244
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ec2/src/commands/CancelImageLaunchPermissionCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,9 @@ export interface CancelImageLaunchPermissionCommandOutput extends CancelImageLau
2828

2929
/**
3030
* @public
31-
* <p>Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more
32-
* information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html">
33-
* Cancel having an AMI shared with your Amazon Web Services account</a> in the
34-
* <i>Amazon EC2 User Guide</i>.</p>
31+
* <p>Removes your Amazon Web Services account from the launch permissions for the specified AMI.
32+
* For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html"> Cancel having an AMI shared with
33+
* your Amazon Web Services account</a> in the <i>Amazon EC2 User Guide</i>.</p>
3534
* @example
3635
* Use a bare-bones client and the command you need to make an API call.
3736
* ```javascript

‎clients/client-ec2/src/commands/CopyImageCommand.ts

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,19 @@ export interface CopyImageCommandOutput extends CopyImageResult, __MetadataBeare
2929
/**
3030
* @public
3131
* <p>Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a
32-
* Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost
33-
* to another, or within the same Outpost. To copy an AMI to another partition, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
34-
* <p>To copy an AMI from one Region to another, specify the source Region using the
35-
* <b>SourceRegion</b> parameter, and specify the
36-
* destination Region using its endpoint. Copies of encrypted backing snapshots for
37-
* the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted,
38-
* unless you set <code>Encrypted</code> during the copy operation. You cannot
39-
* create an unencrypted copy of an encrypted backing snapshot.</p>
40-
* <p>To copy an AMI from a Region to an Outpost, specify the source Region using the
41-
* <b>SourceRegion</b> parameter, and specify the
42-
* ARN of the destination Outpost using <b>DestinationOutpostArn</b>.
43-
* Backing snapshots copied to an Outpost are encrypted by default using the default
44-
* encryption key for the Region, or a different key that you specify in the request using
45-
* <b>KmsKeyId</b>. Outposts do not support unencrypted
46-
* snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami">
47-
* Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EC2 User Guide</i>.</p>
32+
* Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to
33+
* another, or within the same Outpost. To copy an AMI to another partition, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
34+
* <p>To copy an AMI from one Region to another, specify the source Region using the <b>SourceRegion</b> parameter, and specify the destination Region using its
35+
* endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of
36+
* unencrypted backing snapshots remain unencrypted, unless you set <code>Encrypted</code> during
37+
* the copy operation. You cannot create an unencrypted copy of an encrypted backing
38+
* snapshot.</p>
39+
* <p>To copy an AMI from a Region to an Outpost, specify the source Region using the <b>SourceRegion</b> parameter, and specify the ARN of the destination
40+
* Outpost using <b>DestinationOutpostArn</b>. Backing snapshots copied
41+
* to an Outpost are encrypted by default using the default encryption key for the Region, or a
42+
* different key that you specify in the request using <b>KmsKeyId</b>.
43+
* Outposts do not support unencrypted snapshots. For more information, <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshots-outposts.html#ami"> Amazon EBS local
44+
* snapshots on Outposts</a> in the <i>Amazon EC2 User Guide</i>.</p>
4845
* <p>For more information about the prerequisites and limits when copying an AMI, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html">Copy an AMI</a> in the
4946
* <i>Amazon EC2 User Guide</i>.</p>
5047
* @example
@@ -64,6 +61,17 @@ export interface CopyImageCommandOutput extends CopyImageResult, __MetadataBeare
6461
* DestinationOutpostArn: "STRING_VALUE",
6562
* DryRun: true || false,
6663
* CopyImageTags: true || false,
64+
* TagSpecifications: [ // TagSpecificationList
65+
* { // TagSpecification
66+
* 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",
67+
* Tags: [ // TagList
68+
* { // Tag
69+
* Key: "STRING_VALUE",
70+
* Value: "STRING_VALUE",
71+
* },
72+
* ],
73+
* },
74+
* ],
6775
* };
6876
* const command = new CopyImageCommand(input);
6977
* const response = await client.send(command);

‎clients/client-ec2/src/commands/CreateImageCommand.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB
2828

2929
/**
3030
* @public
31-
* <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance
32-
* that is either running or stopped.</p>
33-
* <p>If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the
34-
* new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI,
35-
* the instance automatically launches with those additional volumes.</p>
31+
* <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or
32+
* stopped.</p>
33+
* <p>If you customized your instance with instance store volumes or Amazon EBS volumes in addition
34+
* to the root device volume, the new AMI contains block device mapping information for those
35+
* volumes. When you launch an instance from this new AMI, the instance automatically launches
36+
* with those additional volumes.</p>
3637
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html">Create an Amazon EBS-backed Linux
3738
* AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
3839
* @example

‎clients/client-ec2/src/commands/CreateRestoreImageTaskCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ export interface CreateRestoreImageTaskCommandOutput extends CreateRestoreImageT
2828

2929
/**
3030
* @public
31-
* <p>Starts a task that restores an AMI from an Amazon S3 object that was previously created by using
32-
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
31+
* <p>Starts a task that restores an AMI from an Amazon S3 object that was previously created by
32+
* using <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html">CreateStoreImageTask</a>.</p>
3333
* <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the
3434
* <i>Amazon EC2 User Guide</i>.</p>
3535
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using
36-
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
36+
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.
3939
* ```javascript

‎clients/client-ec2/src/commands/CreateStoreImageTaskCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateStoreImageTaskCommandOutput extends CreateStoreImageTaskR
3232
* <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the
3333
* <i>Amazon EC2 User Guide</i>.</p>
3434
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using
35-
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
35+
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

‎clients/client-ec2/src/commands/DeregisterImageCommand.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ export interface DeregisterImageCommandOutput extends __MetadataBearer {}
2828

2929
/**
3030
* @public
31-
* <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to
32-
* launch new instances.</p>
33-
* <p>If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained
34-
* in the Recycle Bin for the specified retention period. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recycle Bin</a> in
31+
* <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new
32+
* instances.</p>
33+
* <p>If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in
34+
* the Recycle Bin for the specified retention period. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html">Recycle Bin</a> in
3535
* the <i>Amazon EC2 User Guide</i>.</p>
36-
* <p>When you deregister an AMI, it doesn't affect any instances that you've already
37-
* launched from the AMI. You'll continue to incur usage costs for those instances until
38-
* you terminate them.</p>
39-
* <p>When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was
40-
* created for the root volume of the instance during the AMI creation process. When you
41-
* deregister an instance store-backed AMI, it doesn't affect the files that you uploaded
42-
* to Amazon S3 when you created the AMI.</p>
36+
* <p>When you deregister an AMI, it doesn't affect any instances that you've already launched
37+
* from the AMI. You'll continue to incur usage costs for those instances until you terminate
38+
* them.</p>
39+
* <p>When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created
40+
* for the root volume of the instance during the AMI creation process. When you deregister an
41+
* instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you
42+
* created the AMI.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript

‎clients/client-ec2/src/commands/DescribeBundleTasksCommand.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,14 @@ export interface DescribeBundleTasksCommandOutput extends DescribeBundleTasksRes
3434
* @public
3535
* <p>Describes the specified bundle tasks or all of your bundle tasks.</p>
3636
* <note>
37-
* <p>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 <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task.</p>
37+
* <p>Completed bundle tasks are listed for only a limited time. If your bundle task is no
38+
* longer in the list, you can still register an AMI from it. Just use
39+
* <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided
40+
* to the bundle task.</p>
41+
* </note>
42+
* <note>
43+
* <p>The order of the elements in the response, including those within nested structures,
44+
* might vary. Applications should not assume the elements appear in a particular order.</p>
3845
* </note>
3946
* @example
4047
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ export interface DescribeImageAttributeCommandOutput extends ImageAttribute, __M
2828

2929
/**
3030
* @public
31-
* <p>Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.</p>
31+
* <p>Describes the specified attribute of the specified AMI. You can specify only one attribute
32+
* at a time.</p>
33+
* <note>
34+
* <p>The order of the elements in the response, including those within nested structures,
35+
* might vary. Applications should not assume the elements appear in a particular order.</p>
36+
* </note>
3237
* @example
3338
* Use a bare-bones client and the command you need to make an API call.
3439
* ```javascript

‎clients/client-ec2/src/commands/DescribeImagesCommand.ts

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,19 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResult, __Met
2828

2929
/**
3030
* @public
31-
* <p>Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.</p>
32-
* <p>The images available to you include public images, private images that you own, and private images owned by other
33-
* Amazon Web Services accounts for which you have explicit launch permissions.</p>
31+
* <p>Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the
32+
* images available to you.</p>
33+
* <p>The images available to you include public images, private images that you own, and
34+
* private images owned by other Amazon Web Services accounts for which you have explicit launch
35+
* permissions.</p>
3436
* <p>Recently deregistered images appear in the returned results for a short interval and then
3537
* return empty results. After all instances that reference a deregistered AMI are terminated,
3638
* specifying the ID of the image will eventually return an error indicating that the AMI ID
3739
* cannot be found.</p>
40+
* <note>
41+
* <p>The order of the elements in the response, including those within nested structures,
42+
* might vary. Applications should not assume the elements appear in a particular order.</p>
43+
* </note>
3844
* @example
3945
* Use a bare-bones client and the command you need to make an API call.
4046
* ```javascript

‎clients/client-ec2/src/commands/DescribeStoreImageTasksCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface DescribeStoreImageTasksCommandOutput extends DescribeStoreImage
3939
* <p>To use this API, you must have the required permissions. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html#ami-s3-permissions">Permissions for storing and restoring AMIs using Amazon S3</a> in the
4040
* <i>Amazon EC2 User Guide</i>.</p>
4141
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html">Store and restore an AMI using
42-
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
42+
* Amazon S3</a> in the <i>Amazon EC2 User Guide</i>.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript

‎clients/client-ec2/src/commands/DisableFastLaunchCommand.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,13 @@ export interface DisableFastLaunchCommandOutput extends DisableFastLaunchResult,
2828

2929
/**
3030
* @public
31-
* <p>Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots.
32-
* After you disable Windows fast launch, the AMI uses the standard launch process for each
33-
* new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again.</p>
31+
* <p>Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned
32+
* snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for
33+
* each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable
34+
* Windows fast launch again.</p>
3435
* <note>
35-
* <p>You can only change these settings for Windows AMIs that you own or that have been shared with you.</p>
36+
* <p>You can only change these settings for Windows AMIs that you own or that have been
37+
* shared with you.</p>
3638
* </note>
3739
* @example
3840
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ec2/src/commands/DisableImageBlockPublicAccessCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ export interface DisableImageBlockPublicAccessCommandOutput
3838
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html">GetImageBlockPublicAccessState</a>, the response will be
3939
* <code>block-new-sharing</code>. When the API has completed the configuration, the response
4040
* will be <code>unblocked</code>.</p>
41-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis">Block public access to your AMIs</a> in
42-
* the <i>Amazon EC2 User Guide</i>.</p>
41+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis">Block
42+
* public access to your AMIs</a> in the <i>Amazon EC2 User Guide</i>.</p>
4343
* @example
4444
* Use a bare-bones client and the command you need to make an API call.
4545
* ```javascript

0 commit comments

Comments
 (0)