@aws-sdk/client-ec2 3.287.0 → 3.289.0

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

@@ -31,6 +31,32 @@ export interface DescribeCustomerGatewaysCommandOutput extends DescribeCustomerG
  * @see {@link DescribeCustomerGatewaysCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe a customer gateway
+ * ```javascript
+ * // This example describes the specified customer gateway.
+ * const input = {
+ *   "CustomerGatewayIds": [
+ *     "cgw-0e11f167"
+ *   ]
+ * };
+ * const command = new DescribeCustomerGatewaysCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomerGateways": [
+ *     {
+ *       "BgpAsn": "65534",
+ *       "CustomerGatewayId": "cgw-0e11f167",
+ *       "IpAddress": "12.1.2.3",
+ *       "State": "available",
+ *       "Type": "ipsec.1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: ec2-describe-customer-gateways-1
+ * ```
+ *
  */
 export declare class DescribeCustomerGatewaysCommand extends $Command<DescribeCustomerGatewaysCommandInput, DescribeCustomerGatewaysCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeCustomerGatewaysCommandInput;

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

@@ -31,6 +31,41 @@ export interface DescribeDhcpOptionsCommandOutput extends DescribeDhcpOptionsRes
  * @see {@link DescribeDhcpOptionsCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe a DHCP options set
+ * ```javascript
+ * // This example describes the specified DHCP options set.
+ * const input = {
+ *   "DhcpOptionsIds": [
+ *     "dopt-d9070ebb"
+ *   ]
+ * };
+ * const command = new DescribeDhcpOptionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DhcpOptions": [
+ *     {
+ *       "DhcpConfigurations": [
+ *         {
+ *           "Key": "domain-name-servers",
+ *           "Values": [
+ *             {
+ *               "Value": "10.2.5.2"
+ *             },
+ *             {
+ *               "Value": "10.2.5.1"
+ *             }
+ *           ]
+ *         }
+ *       ],
+ *       "DhcpOptionsId": "dopt-d9070ebb"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: ec2-describe-dhcp-options-1
+ * ```
+ *
  */
 export declare class DescribeDhcpOptionsCommand extends $Command<DescribeDhcpOptionsCommandInput, DescribeDhcpOptionsCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeDhcpOptionsCommandInput;

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

@@ -29,6 +29,34 @@ export interface DescribeIamInstanceProfileAssociationsCommandOutput extends Des
  * @see {@link DescribeIamInstanceProfileAssociationsCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe an IAM instance profile association
+ * ```javascript
+ * // This example describes the specified IAM instance profile association.
+ * const input = {
+ *   "AssociationIds": [
+ *     "iip-assoc-0db249b1f25fa24b8"
+ *   ]
+ * };
+ * const command = new DescribeIamInstanceProfileAssociationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "IamInstanceProfileAssociations": [
+ *     {
+ *       "AssociationId": "iip-assoc-0db249b1f25fa24b8",
+ *       "IamInstanceProfile": {
+ *         "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role",
+ *         "Id": "AIPAJVQN4F5WVLGCJDRGM"
+ *       },
+ *       "InstanceId": "i-09eb09efa73ec1dee",
+ *       "State": "associated"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-an-iam-instance-profile-association-1529025123918
+ * ```
+ *
  */
 export declare class DescribeIamInstanceProfileAssociationsCommand extends $Command<DescribeIamInstanceProfileAssociationsCommandInput, DescribeIamInstanceProfileAssociationsCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeIamInstanceProfileAssociationsCommandInput;

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

@@ -29,6 +29,28 @@ export interface DescribeImageAttributeCommandOutput extends ImageAttribute, __M
  * @see {@link DescribeImageAttributeCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe the launch permissions for an AMI
+ * ```javascript
+ * // This example describes the launch permissions for the specified AMI.
+ * const input = {
+ *   "Attribute": "launchPermission",
+ *   "ImageId": "ami-5731123e"
+ * };
+ * const command = new DescribeImageAttributeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ImageId": "ami-5731123e",
+ *   "LaunchPermissions": [
+ *     {
+ *       "UserId": "123456789012"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-launch-permissions-for-an-ami-1529025296264
+ * ```
+ *
  */
 export declare class DescribeImageAttributeCommand extends $Command<DescribeImageAttributeCommandInput, DescribeImageAttributeCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeImageAttributeCommandInput;

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

@@ -35,6 +35,52 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResult, __Met
  * @see {@link DescribeImagesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe an AMI
+ * ```javascript
+ * // This example describes the specified AMI.
+ * const input = {
+ *   "ImageIds": [
+ *     "ami-5731123e"
+ *   ]
+ * };
+ * const command = new DescribeImagesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Images": [
+ *     {
+ *       "Architecture": "x86_64",
+ *       "BlockDeviceMappings": [
+ *         {
+ *           "DeviceName": "/dev/sda1",
+ *           "Ebs": {
+ *             "DeleteOnTermination": true,
+ *             "SnapshotId": "snap-1234567890abcdef0",
+ *             "VolumeSize": 8,
+ *             "VolumeType": "standard"
+ *           }
+ *         }
+ *       ],
+ *       "Description": "An AMI for my server",
+ *       "Hypervisor": "xen",
+ *       "ImageId": "ami-5731123e",
+ *       "ImageLocation": "123456789012/My server",
+ *       "ImageType": "machine",
+ *       "KernelId": "aki-88aa75e1",
+ *       "Name": "My server",
+ *       "OwnerId": "123456789012",
+ *       "Public": false,
+ *       "RootDeviceName": "/dev/sda1",
+ *       "RootDeviceType": "ebs",
+ *       "State": "available",
+ *       "VirtualizationType": "paravirtual"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-an-ami-1529025482866
+ * ```
+ *
  */
 export declare class DescribeImagesCommand extends $Command<DescribeImagesCommandInput, DescribeImagesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeImagesCommandInput;

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

@@ -36,6 +36,86 @@ export interface DescribeInstanceAttributeCommandOutput extends InstanceAttribut
  * @see {@link DescribeInstanceAttributeCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe the instance type
+ * ```javascript
+ * // This example describes the instance type of the specified instance.
+ * //
+ * const input = {
+ *   "Attribute": "instanceType",
+ *   "InstanceId": "i-1234567890abcdef0"
+ * };
+ * const command = new DescribeInstanceAttributeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InstanceId": "i-1234567890abcdef0",
+ *   "InstanceType": {
+ *     "Value": "t1.micro"
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-the-instance-type-1472712432132
+ * ```
+ *
+ * @example To describe the disableApiTermination attribute
+ * ```javascript
+ * // This example describes the ``disableApiTermination`` attribute of the specified instance.
+ * //
+ * const input = {
+ *   "Attribute": "disableApiTermination",
+ *   "InstanceId": "i-1234567890abcdef0"
+ * };
+ * const command = new DescribeInstanceAttributeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DisableApiTermination": {
+ *     "Value": "false"
+ *   },
+ *   "InstanceId": "i-1234567890abcdef0"
+ * }
+ * *\/
+ * // example id: to-describe-the-disableapitermination-attribute-1472712533466
+ * ```
+ *
+ * @example To describe the block device mapping for an instance
+ * ```javascript
+ * // This example describes the ``blockDeviceMapping`` attribute of the specified instance.
+ * //
+ * const input = {
+ *   "Attribute": "blockDeviceMapping",
+ *   "InstanceId": "i-1234567890abcdef0"
+ * };
+ * const command = new DescribeInstanceAttributeCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "BlockDeviceMappings": [
+ *     {
+ *       "DeviceName": "/dev/sda1",
+ *       "Ebs": {
+ *         "AttachTime": "2013-05-17T22:42:34.000Z",
+ *         "DeleteOnTermination": true,
+ *         "Status": "attached",
+ *         "VolumeId": "vol-049df61146c4d7901"
+ *       }
+ *     },
+ *     {
+ *       "DeviceName": "/dev/sdf",
+ *       "Ebs": {
+ *         "AttachTime": "2013-09-10T23:07:00.000Z",
+ *         "DeleteOnTermination": false,
+ *         "Status": "attached",
+ *         "VolumeId": "vol-049df61146c4d7901"
+ *       }
+ *     }
+ *   ],
+ *   "InstanceId": "i-1234567890abcdef0"
+ * }
+ * *\/
+ * // example id: to-describe-the-block-device-mapping-for-an-instance-1472712645423
+ * ```
+ *
  */
 export declare class DescribeInstanceAttributeCommand extends $Command<DescribeInstanceAttributeCommandInput, DescribeInstanceAttributeCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeInstanceAttributeCommandInput;

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

@@ -57,6 +57,51 @@ export interface DescribeInstanceStatusCommandOutput extends DescribeInstanceSta
  * @see {@link DescribeInstanceStatusCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe the status of an instance
+ * ```javascript
+ * // This example describes the current status of the specified instance.
+ * const input = {
+ *   "InstanceIds": [
+ *     "i-1234567890abcdef0"
+ *   ]
+ * };
+ * const command = new DescribeInstanceStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InstanceStatuses": [
+ *     {
+ *       "AvailabilityZone": "us-east-1d",
+ *       "InstanceId": "i-1234567890abcdef0",
+ *       "InstanceState": {
+ *         "Code": 16,
+ *         "Name": "running"
+ *       },
+ *       "InstanceStatus": {
+ *         "Details": [
+ *           {
+ *             "Name": "reachability",
+ *             "Status": "passed"
+ *           }
+ *         ],
+ *         "Status": "ok"
+ *       },
+ *       "SystemStatus": {
+ *         "Details": [
+ *           {
+ *             "Name": "reachability",
+ *             "Status": "passed"
+ *           }
+ *         ],
+ *         "Status": "ok"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-status-of-an-instance-1529025696830
+ * ```
+ *
  */
 export declare class DescribeInstanceStatusCommand extends $Command<DescribeInstanceStatusCommandInput, DescribeInstanceStatusCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeInstanceStatusCommandInput;

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

@@ -45,6 +45,55 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesResult,
  * @see {@link DescribeInstancesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe an Amazon EC2 instance
+ * ```javascript
+ * // This example describes the specified instance.
+ * const input = {
+ *   "InstanceIds": [
+ *     "i-1234567890abcdef0"
+ *   ]
+ * };
+ * const command = new DescribeInstancesCommand(input);
+ * await client.send(command);
+ * // example id: to-describe-an-amazon-ec2-instance-1529025982172
+ * ```
+ *
+ * @example To describe the instances with a specific instance type
+ * ```javascript
+ * // This example describes the instances with the t2.micro instance type.
+ * const input = {
+ *   "Filters": [
+ *     {
+ *       "Name": "instance-type",
+ *       "Values": [
+ *         "t2.micro"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeInstancesCommand(input);
+ * await client.send(command);
+ * // example id: to-describe-the-instances-with-the-instance-type-t2micro-1529026147602
+ * ```
+ *
+ * @example To describe the instances with a specific tag
+ * ```javascript
+ * // This example describes the instances with the Purpose=test tag.
+ * const input = {
+ *   "Filters": [
+ *     {
+ *       "Name": "tag:Purpose",
+ *       "Values": [
+ *         "test"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeInstancesCommand(input);
+ * await client.send(command);
+ * // example id: to-describe-the-instances-with-a-specific-tag-1529026251928
+ * ```
+ *
  */
 export declare class DescribeInstancesCommand extends $Command<DescribeInstancesCommandInput, DescribeInstancesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeInstancesCommandInput;

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

@@ -29,6 +29,40 @@ export interface DescribeInternetGatewaysCommandOutput extends DescribeInternetG
  * @see {@link DescribeInternetGatewaysCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe the Internet gateway for a VPC
+ * ```javascript
+ * // This example describes the Internet gateway for the specified VPC.
+ * const input = {
+ *   "Filters": [
+ *     {
+ *       "Name": "attachment.vpc-id",
+ *       "Values": [
+ *         "vpc-a01106c2"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeInternetGatewaysCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "InternetGateways": [
+ *     {
+ *       "Attachments": [
+ *         {
+ *           "State": "available",
+ *           "VpcId": "vpc-a01106c2"
+ *         }
+ *       ],
+ *       "InternetGatewayId": "igw-c0a643a9",
+ *       "Tags": []
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: ec2-describe-internet-gateways-1
+ * ```
+ *
  */
 export declare class DescribeInternetGatewaysCommand extends $Command<DescribeInternetGatewaysCommandInput, DescribeInternetGatewaysCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeInternetGatewaysCommandInput;

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

@@ -31,6 +31,29 @@ export interface DescribeKeyPairsCommandOutput extends DescribeKeyPairsResult, _
  * @see {@link DescribeKeyPairsCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To display a key pair
+ * ```javascript
+ * // This example displays the fingerprint for the specified key.
+ * const input = {
+ *   "KeyNames": [
+ *     "my-key-pair"
+ *   ]
+ * };
+ * const command = new DescribeKeyPairsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "KeyPairs": [
+ *     {
+ *       "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f",
+ *       "KeyName": "my-key-pair"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: ec2-describe-key-pairs-1
+ * ```
+ *
  */
 export declare class DescribeKeyPairsCommand extends $Command<DescribeKeyPairsCommandInput, DescribeKeyPairsCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeKeyPairsCommandInput;

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

@@ -32,6 +32,70 @@ export interface DescribeLaunchTemplateVersionsCommandOutput extends DescribeLau
  * @see {@link DescribeLaunchTemplateVersionsCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe the versions for a launch template
+ * ```javascript
+ * // This example describes the versions for the specified launch template.
+ * const input = {
+ *   "LaunchTemplateId": "068f72b72934aff71"
+ * };
+ * const command = new DescribeLaunchTemplateVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LaunchTemplateVersions": [
+ *     {
+ *       "CreateTime": "2017-11-20T13:12:32.000Z",
+ *       "CreatedBy": "arn:aws:iam::123456789102:root",
+ *       "DefaultVersion": false,
+ *       "LaunchTemplateData": {
+ *         "ImageId": "ami-6057e21a",
+ *         "InstanceType": "t2.medium",
+ *         "KeyName": "kp-us-east",
+ *         "NetworkInterfaces": [
+ *           {
+ *             "DeviceIndex": 0,
+ *             "Groups": [
+ *               "sg-7c227019"
+ *             ],
+ *             "SubnetId": "subnet-1a2b3c4d"
+ *           }
+ *         ]
+ *       },
+ *       "LaunchTemplateId": "lt-068f72b72934aff71",
+ *       "LaunchTemplateName": "Webservers",
+ *       "VersionNumber": 2
+ *     },
+ *     {
+ *       "CreateTime": "2017-11-20T12:52:33.000Z",
+ *       "CreatedBy": "arn:aws:iam::123456789102:root",
+ *       "DefaultVersion": true,
+ *       "LaunchTemplateData": {
+ *         "ImageId": "ami-aabbcc11",
+ *         "InstanceType": "t2.medium",
+ *         "KeyName": "kp-us-east",
+ *         "NetworkInterfaces": [
+ *           {
+ *             "AssociatePublicIpAddress": true,
+ *             "DeleteOnTermination": false,
+ *             "DeviceIndex": 0,
+ *             "Groups": [
+ *               "sg-7c227019"
+ *             ],
+ *             "SubnetId": "subnet-7b16de0c"
+ *           }
+ *         ],
+ *         "UserData": ""
+ *       },
+ *       "LaunchTemplateId": "lt-068f72b72934aff71",
+ *       "LaunchTemplateName": "Webservers",
+ *       "VersionNumber": 1
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-versions-for-a-launch-template-1529344425048
+ * ```
+ *
  */
 export declare class DescribeLaunchTemplateVersionsCommand extends $Command<DescribeLaunchTemplateVersionsCommandInput, DescribeLaunchTemplateVersionsCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeLaunchTemplateVersionsCommandInput;

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

@@ -29,6 +29,33 @@ export interface DescribeLaunchTemplatesCommandOutput extends DescribeLaunchTemp
  * @see {@link DescribeLaunchTemplatesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe a launch template
+ * ```javascript
+ * // This example describes the specified launch template.
+ * const input = {
+ *   "LaunchTemplateIds": [
+ *     "lt-01238c059e3466abc"
+ *   ]
+ * };
+ * const command = new DescribeLaunchTemplatesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "LaunchTemplates": [
+ *     {
+ *       "CreateTime": "2018-01-16T04:32:57.000Z",
+ *       "CreatedBy": "arn:aws:iam::123456789012:root",
+ *       "DefaultVersionNumber": 1,
+ *       "LatestVersionNumber": 1,
+ *       "LaunchTemplateId": "lt-01238c059e3466abc",
+ *       "LaunchTemplateName": "my-template"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-launch-template-1529344182862
+ * ```
+ *
  */
 export declare class DescribeLaunchTemplatesCommand extends $Command<DescribeLaunchTemplatesCommandInput, DescribeLaunchTemplatesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeLaunchTemplatesCommandInput;

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

@@ -29,6 +29,25 @@ export interface DescribeMovingAddressesCommandOutput extends DescribeMovingAddr
  * @see {@link DescribeMovingAddressesCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe your moving addresses
+ * ```javascript
+ * // This example describes all of your moving Elastic IP addresses.
+ * const input = undefined;
+ * const command = new DescribeMovingAddressesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "MovingAddressStatuses": [
+ *     {
+ *       "MoveStatus": "MovingToVpc",
+ *       "PublicIp": "198.51.100.0"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: ec2-describe-moving-addresses-1
+ * ```
+ *
  */
 export declare class DescribeMovingAddressesCommand extends $Command<DescribeMovingAddressesCommandInput, DescribeMovingAddressesCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeMovingAddressesCommandInput;

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

@@ -29,6 +29,45 @@ export interface DescribeNatGatewaysCommandOutput extends DescribeNatGatewaysRes
  * @see {@link DescribeNatGatewaysCommandOutput} for command's `response` shape.
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
  *
+ * @example To describe a NAT gateway
+ * ```javascript
+ * // This example describes the NAT gateway for the specified VPC.
+ * const input = {
+ *   "Filter": [
+ *     {
+ *       "Name": "vpc-id",
+ *       "Values": [
+ *         "vpc-1a2b3c4d"
+ *       ]
+ *     }
+ *   ]
+ * };
+ * const command = new DescribeNatGatewaysCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NatGateways": [
+ *     {
+ *       "CreateTime": "2015-12-01T12:26:55.983Z",
+ *       "NatGatewayAddresses": [
+ *         {
+ *           "AllocationId": "eipalloc-89c620ec",
+ *           "NetworkInterfaceId": "eni-9dec76cd",
+ *           "PrivateIp": "10.0.0.149",
+ *           "PublicIp": "198.11.222.333"
+ *         }
+ *       ],
+ *       "NatGatewayId": "nat-05dba92075d71c408",
+ *       "State": "available",
+ *       "SubnetId": "subnet-847e4dc2",
+ *       "VpcId": "vpc-1a2b3c4d"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: ec2-describe-nat-gateways-1
+ * ```
+ *
  */
 export declare class DescribeNatGatewaysCommand extends $Command<DescribeNatGatewaysCommandInput, DescribeNatGatewaysCommandOutput, EC2ClientResolvedConfig> {
     readonly input: DescribeNatGatewaysCommandInput;