@aws-sdk/client-ec2 3.288.0 → 3.290.0

package/dist-types/commands/StopInstancesCommand.d.ts

@@ -59,6 +59,37 @@ export interface StopInstancesCommandOutput extends StopInstancesResult, __Metad
  * @see {@link StopInstancesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
+ * @example To stop a running EC2 instance
+ * ```javascript
+ * // This example stops the specified EC2 instance.
+ * const input = {
+ *   "InstanceIds": [
+ *     "i-1234567890abcdef0"
+ *   ]
+ * };
+ * const command = new StopInstancesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "StoppingInstances": [
+ *     {
+ *       "CurrentState": {
+ *         "Code": 64,
+ *         "Name": "stopping"
+ *       },
+ *       "InstanceId": "i-1234567890abcdef0",
+ *       "PreviousState": {
+ *         "Code": 16,
+ *         "Name": "running"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-stop-a-running-ec2-instance-1529358905540
+ * ```
+ *
  */
 export declare class StopInstancesCommand extends $Command<StopInstancesCommandInput, StopInstancesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: StopInstancesCommandInput;

package/dist-types/commands/TerminateClientVpnConnectionsCommand.d.ts

@@ -29,6 +29,7 @@ export interface TerminateClientVpnConnectionsCommandOutput extends TerminateCli
  * @see {@link TerminateClientVpnConnectionsCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
  */
 export declare class TerminateClientVpnConnectionsCommand extends $Command<TerminateClientVpnConnectionsCommandInput, TerminateClientVpnConnectionsCommandOutput, EC2ClientResolvedConfig> {
     readonly input: TerminateClientVpnConnectionsCommandInput;

package/dist-types/commands/TerminateInstancesCommand.d.ts

@@ -89,6 +89,37 @@ export interface TerminateInstancesCommandOutput extends TerminateInstancesResul
  * @see {@link TerminateInstancesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
+ * @example To terminate an EC2 instance
+ * ```javascript
+ * // This example terminates the specified EC2 instance.
+ * const input = {
+ *   "InstanceIds": [
+ *     "i-1234567890abcdef0"
+ *   ]
+ * };
+ * const command = new TerminateInstancesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TerminatingInstances": [
+ *     {
+ *       "CurrentState": {
+ *         "Code": 32,
+ *         "Name": "shutting-down"
+ *       },
+ *       "InstanceId": "i-1234567890abcdef0",
+ *       "PreviousState": {
+ *         "Code": 16,
+ *         "Name": "running"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-terminate-an-ec2-instance-1529359350660
+ * ```
+ *
  */
 export declare class TerminateInstancesCommand extends $Command<TerminateInstancesCommandInput, TerminateInstancesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: TerminateInstancesCommandInput;

package/dist-types/commands/UnassignIpv6AddressesCommand.d.ts

@@ -29,6 +29,7 @@ export interface UnassignIpv6AddressesCommandOutput extends UnassignIpv6Addresse
  * @see {@link UnassignIpv6AddressesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
  */
 export declare class UnassignIpv6AddressesCommand extends $Command<UnassignIpv6AddressesCommandInput, UnassignIpv6AddressesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: UnassignIpv6AddressesCommandInput;

package/dist-types/commands/UnassignPrivateIpAddressesCommand.d.ts

@@ -30,6 +30,21 @@ export interface UnassignPrivateIpAddressesCommandOutput extends __MetadataBeare
  * @see {@link UnassignPrivateIpAddressesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
+ * @example To unassign a secondary private IP address from a network interface
+ * ```javascript
+ * // This example unassigns the specified private IP address from the specified network interface.
+ * const input = {
+ *   "NetworkInterfaceId": "eni-e5aa89a3",
+ *   "PrivateIpAddresses": [
+ *     "10.0.0.82"
+ *   ]
+ * };
+ * const command = new UnassignPrivateIpAddressesCommand(input);
+ * await client.send(command);
+ * // example id: ec2-unassign-private-ip-addresses-1
+ * ```
+ *
  */
 export declare class UnassignPrivateIpAddressesCommand extends $Command<UnassignPrivateIpAddressesCommandInput, UnassignPrivateIpAddressesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: UnassignPrivateIpAddressesCommandInput;

package/dist-types/commands/UnassignPrivateNatGatewayAddressCommand.d.ts

@@ -37,6 +37,7 @@ export interface UnassignPrivateNatGatewayAddressCommandOutput extends UnassignP
  * @see {@link UnassignPrivateNatGatewayAddressCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
  */
 export declare class UnassignPrivateNatGatewayAddressCommand extends $Command<UnassignPrivateNatGatewayAddressCommandInput, UnassignPrivateNatGatewayAddressCommandOutput, EC2ClientResolvedConfig> {
     readonly input: UnassignPrivateNatGatewayAddressCommandInput;

package/dist-types/commands/UnmonitorInstancesCommand.d.ts

@@ -31,6 +31,7 @@ export interface UnmonitorInstancesCommandOutput extends UnmonitorInstancesResul
  * @see {@link UnmonitorInstancesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
  */
 export declare class UnmonitorInstancesCommand extends $Command<UnmonitorInstancesCommandInput, UnmonitorInstancesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: UnmonitorInstancesCommandInput;

package/dist-types/commands/UpdateSecurityGroupRuleDescriptionsEgressCommand.d.ts

@@ -32,6 +32,31 @@ export interface UpdateSecurityGroupRuleDescriptionsEgressCommandOutput extends
  * @see {@link UpdateSecurityGroupRuleDescriptionsEgressCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
+ * @example To update an outbound security group rule description
+ * ```javascript
+ * // This example updates the description for the specified security group rule.
+ * const input = {
+ *   "GroupId": "sg-123abc12",
+ *   "IpPermissions": [
+ *     {
+ *       "FromPort": 80,
+ *       "IpProtocol": "tcp",
+ *       "IpRanges": [
+ *         {
+ *           "CidrIp": "203.0.113.0/24",
+ *           "Description": "Outbound HTTP access to server 2"
+ *         }
+ *       ],
+ *       "ToPort": 80
+ *     }
+ *   ]
+ * };
+ * const command = new UpdateSecurityGroupRuleDescriptionsEgressCommand(input);
+ * await client.send(command);
+ * // example id: to-update-an-outbound-security-group-rule-description-1529360481544
+ * ```
+ *
  */
 export declare class UpdateSecurityGroupRuleDescriptionsEgressCommand extends $Command<UpdateSecurityGroupRuleDescriptionsEgressCommandInput, UpdateSecurityGroupRuleDescriptionsEgressCommandOutput, EC2ClientResolvedConfig> {
     readonly input: UpdateSecurityGroupRuleDescriptionsEgressCommandInput;

package/dist-types/commands/UpdateSecurityGroupRuleDescriptionsIngressCommand.d.ts

@@ -32,6 +32,31 @@ export interface UpdateSecurityGroupRuleDescriptionsIngressCommandOutput extends
  * @see {@link UpdateSecurityGroupRuleDescriptionsIngressCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
+ * @example To update an inbound security group rule description
+ * ```javascript
+ * // This example updates the description for the specified security group rule.
+ * const input = {
+ *   "GroupId": "sg-123abc12",
+ *   "IpPermissions": [
+ *     {
+ *       "FromPort": 22,
+ *       "IpProtocol": "tcp",
+ *       "IpRanges": [
+ *         {
+ *           "CidrIp": "203.0.113.0/16",
+ *           "Description": "SSH access from the LA office"
+ *         }
+ *       ],
+ *       "ToPort": 22
+ *     }
+ *   ]
+ * };
+ * const command = new UpdateSecurityGroupRuleDescriptionsIngressCommand(input);
+ * await client.send(command);
+ * // example id: to-update-an-inbound-security-group-rule-description-1529360820372
+ * ```
+ *
  */
 export declare class UpdateSecurityGroupRuleDescriptionsIngressCommand extends $Command<UpdateSecurityGroupRuleDescriptionsIngressCommandInput, UpdateSecurityGroupRuleDescriptionsIngressCommandOutput, EC2ClientResolvedConfig> {
     readonly input: UpdateSecurityGroupRuleDescriptionsIngressCommandInput;

package/dist-types/commands/WithdrawByoipCidrCommand.d.ts

@@ -33,6 +33,7 @@ export interface WithdrawByoipCidrCommandOutput extends WithdrawByoipCidrResult,
  * @see {@link WithdrawByoipCidrCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ *
  */
 export declare class WithdrawByoipCidrCommand extends $Command<WithdrawByoipCidrCommandInput, WithdrawByoipCidrCommandOutput, EC2ClientResolvedConfig> {
     readonly input: WithdrawByoipCidrCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ec2",
   "description": "AWS SDK for JavaScript Ec2 Client for Node.js, Browser and React Native",
-  "version": "3.288.0",
+  "version": "3.290.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,40 +20,40 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.288.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.288.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.288.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-sdk-ec2": "3.282.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.290.0",
+    "@aws-sdk/config-resolver": "3.290.0",
+    "@aws-sdk/credential-provider-node": "3.290.0",
+    "@aws-sdk/fetch-http-handler": "3.290.0",
+    "@aws-sdk/hash-node": "3.290.0",
+    "@aws-sdk/invalid-dependency": "3.290.0",
+    "@aws-sdk/middleware-content-length": "3.290.0",
+    "@aws-sdk/middleware-endpoint": "3.290.0",
+    "@aws-sdk/middleware-host-header": "3.290.0",
+    "@aws-sdk/middleware-logger": "3.290.0",
+    "@aws-sdk/middleware-recursion-detection": "3.290.0",
+    "@aws-sdk/middleware-retry": "3.290.0",
+    "@aws-sdk/middleware-sdk-ec2": "3.290.0",
+    "@aws-sdk/middleware-serde": "3.290.0",
+    "@aws-sdk/middleware-signing": "3.290.0",
+    "@aws-sdk/middleware-stack": "3.290.0",
+    "@aws-sdk/middleware-user-agent": "3.290.0",
+    "@aws-sdk/node-config-provider": "3.290.0",
+    "@aws-sdk/node-http-handler": "3.290.0",
+    "@aws-sdk/protocol-http": "3.290.0",
+    "@aws-sdk/smithy-client": "3.290.0",
+    "@aws-sdk/types": "3.290.0",
+    "@aws-sdk/url-parser": "3.290.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.290.0",
+    "@aws-sdk/util-defaults-mode-node": "3.290.0",
+    "@aws-sdk/util-endpoints": "3.290.0",
+    "@aws-sdk/util-retry": "3.290.0",
+    "@aws-sdk/util-user-agent-browser": "3.290.0",
+    "@aws-sdk/util-user-agent-node": "3.290.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.290.0",
     "fast-xml-parser": "4.1.2",
     "tslib": "^2.3.1",
     "uuid": "^8.3.2"