@aws-sdk/client-ec2 3.288.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. package/dist-types/commands/AllocateAddressCommand.d.ts +33 -0
  2. package/dist-types/commands/AssignPrivateIpAddressesCommand.d.ts +26 -0
  3. package/dist-types/commands/AssociateAddressCommand.d.ts +46 -0
  4. package/dist-types/commands/AssociateDhcpOptionsCommand.d.ts +24 -0
  5. package/dist-types/commands/AssociateIamInstanceProfileCommand.d.ts +27 -0
  6. package/dist-types/commands/AssociateRouteTableCommand.d.ts +17 -0
  7. package/dist-types/commands/AttachInternetGatewayCommand.d.ts +12 -0
  8. package/dist-types/commands/AttachNetworkInterfaceCommand.d.ts +18 -0
  9. package/dist-types/commands/AttachVolumeCommand.d.ts +22 -0
  10. package/dist-types/commands/AuthorizeSecurityGroupEgressCommand.d.ts +46 -0
  11. package/dist-types/commands/AuthorizeSecurityGroupIngressCommand.d.ts +72 -0
  12. package/dist-types/commands/CancelSpotFleetRequestsCommand.d.ts +50 -0
  13. package/dist-types/commands/CancelSpotInstanceRequestsCommand.d.ts +23 -0
  14. package/dist-types/commands/ConfirmProductInstanceCommand.d.ts +17 -0
  15. package/dist-types/commands/CopyImageCommand.d.ts +19 -0
  16. package/dist-types/commands/CopySnapshotCommand.d.ts +19 -0
  17. package/dist-types/commands/CreateCustomerGatewayCommand.d.ts +24 -0
  18. package/dist-types/commands/CreateDhcpOptionsCommand.d.ts +39 -0
  19. package/dist-types/commands/CreateImageCommand.d.ts +31 -0
  20. package/dist-types/commands/CreateInternetGatewayCommand.d.ts +18 -0
  21. package/dist-types/commands/CreateKeyPairCommand.d.ts +11 -0
  22. package/dist-types/commands/CreateLaunchTemplateCommand.d.ts +47 -0
  23. package/dist-types/commands/CreateLaunchTemplateVersionCommand.d.ts +45 -0
  24. package/dist-types/commands/CreateNatGatewayCommand.d.ts +28 -0
  25. package/dist-types/commands/CreateNetworkAclCommand.d.ts +38 -0
  26. package/dist-types/commands/CreateNetworkAclEntryCommand.d.ts +20 -0
  27. package/dist-types/commands/CreateNetworkInterfaceCommand.d.ts +46 -0
  28. package/dist-types/commands/CreatePlacementGroupCommand.d.ts +12 -0
  29. package/dist-types/commands/CreateRouteCommand.d.ts +13 -0
  30. package/dist-types/commands/CreateRouteTableCommand.d.ts +29 -0
  31. package/dist-types/commands/CreateSecurityGroupCommand.d.ts +18 -0
  32. package/dist-types/commands/CreateSnapshotCommand.d.ts +24 -0
  33. package/dist-types/commands/CreateSpotDatafeedSubscriptionCommand.d.ts +22 -0
  34. package/dist-types/commands/CreateSubnetCommand.d.ts +24 -0
  35. package/dist-types/commands/CreateTagsCommand.d.ts +19 -0
  36. package/dist-types/commands/CreateVolumeCommand.d.ts +54 -0
  37. package/dist-types/commands/CreateVpcCommand.d.ts +22 -0
  38. package/dist-types/commands/DeleteCustomerGatewayCommand.d.ts +11 -0
  39. package/dist-types/commands/DeleteDhcpOptionsCommand.d.ts +11 -0
  40. package/dist-types/commands/DeleteInternetGatewayCommand.d.ts +11 -0
  41. package/dist-types/commands/DeleteKeyPairCommand.d.ts +11 -0
  42. package/dist-types/commands/DeleteLaunchTemplateCommand.d.ts +23 -0
  43. package/dist-types/commands/DeleteLaunchTemplateVersionsCommand.d.ts +26 -0
  44. package/dist-types/commands/DeleteNatGatewayCommand.d.ts +16 -0
  45. package/dist-types/commands/DeleteNetworkAclCommand.d.ts +11 -0
  46. package/dist-types/commands/DeleteNetworkAclEntryCommand.d.ts +13 -0
  47. package/dist-types/commands/DeleteNetworkInterfaceCommand.d.ts +11 -0
  48. package/dist-types/commands/DeletePlacementGroupCommand.d.ts +12 -0
  49. package/dist-types/commands/DeleteRouteCommand.d.ts +12 -0
  50. package/dist-types/commands/DeleteRouteTableCommand.d.ts +11 -0
  51. package/dist-types/commands/DeleteSecurityGroupCommand.d.ts +11 -0
  52. package/dist-types/commands/DeleteSnapshotCommand.d.ts +11 -0
  53. package/dist-types/commands/DeleteSpotDatafeedSubscriptionCommand.d.ts +9 -0
  54. package/dist-types/commands/DeleteSubnetCommand.d.ts +11 -0
  55. package/dist-types/commands/DeleteTagsCommand.d.ts +19 -0
  56. package/dist-types/commands/DeleteVolumeCommand.d.ts +11 -0
  57. package/dist-types/commands/DeleteVpcCommand.d.ts +11 -0
  58. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +96 -0
  59. package/dist-types/commands/DescribeAddressesCommand.d.ts +93 -0
  60. package/dist-types/commands/DescribeAvailabilityZonesCommand.d.ts +39 -0
  61. package/dist-types/commands/DescribeCustomerGatewaysCommand.d.ts +26 -0
  62. package/dist-types/commands/DescribeDhcpOptionsCommand.d.ts +35 -0
  63. package/dist-types/commands/DescribeIamInstanceProfileAssociationsCommand.d.ts +28 -0
  64. package/dist-types/commands/DescribeImageAttributeCommand.d.ts +22 -0
  65. package/dist-types/commands/DescribeImagesCommand.d.ts +46 -0
  66. package/dist-types/commands/DescribeInstanceAttributeCommand.d.ts +80 -0
  67. package/dist-types/commands/DescribeInstanceStatusCommand.d.ts +45 -0
  68. package/dist-types/commands/DescribeInstancesCommand.d.ts +49 -0
  69. package/dist-types/commands/DescribeInternetGatewaysCommand.d.ts +34 -0
  70. package/dist-types/commands/DescribeKeyPairsCommand.d.ts +23 -0
  71. package/dist-types/commands/DescribeLaunchTemplateVersionsCommand.d.ts +64 -0
  72. package/dist-types/commands/DescribeLaunchTemplatesCommand.d.ts +27 -0
  73. package/dist-types/commands/DescribeMovingAddressesCommand.d.ts +19 -0
  74. package/dist-types/commands/DescribeNatGatewaysCommand.d.ts +39 -0
  75. package/dist-types/commands/DescribeNetworkAclsCommand.d.ts +48 -0
  76. package/dist-types/commands/DescribeNetworkInterfaceAttributeCommand.d.ts +89 -0
  77. package/dist-types/commands/DescribeNetworkInterfacesCommand.d.ts +68 -0
  78. package/dist-types/commands/DescribeRegionsCommand.d.ts +59 -0
  79. package/dist-types/commands/DescribeRouteTablesCommand.d.ts +39 -0
  80. package/dist-types/commands/DescribeScheduledInstanceAvailabilityCommand.d.ts +49 -0
  81. package/dist-types/commands/DescribeScheduledInstancesCommand.d.ts +43 -0
  82. package/dist-types/commands/DescribeSecurityGroupReferencesCommand.d.ts +24 -0
  83. package/dist-types/commands/DescribeSecurityGroupsCommand.d.ts +31 -0
  84. package/dist-types/commands/DescribeSnapshotAttributeCommand.d.ts +18 -0
  85. package/dist-types/commands/DescribeSnapshotsCommand.d.ts +68 -0
  86. package/dist-types/commands/DescribeSpotDatafeedSubscriptionCommand.d.ts +19 -0
  87. package/dist-types/commands/DescribeSpotFleetInstancesCommand.d.ts +23 -0
  88. package/dist-types/commands/DescribeSpotFleetRequestHistoryCommand.d.ts +51 -0
  89. package/dist-types/commands/DescribeSpotFleetRequestsCommand.d.ts +58 -0
  90. package/dist-types/commands/DescribeSpotInstanceRequestsCommand.d.ts +56 -0
  91. package/dist-types/commands/DescribeSpotPriceHistoryCommand.d.ts +38 -0
  92. package/dist-types/commands/DescribeSubnetsCommand.d.ts +34 -0
  93. package/dist-types/commands/DescribeTagsCommand.d.ts +36 -0
  94. package/dist-types/commands/DescribeVolumeAttributeCommand.d.ts +20 -0
  95. package/dist-types/commands/DescribeVolumeStatusCommand.d.ts +61 -0
  96. package/dist-types/commands/DescribeVolumesCommand.d.ts +84 -0
  97. package/dist-types/commands/DescribeVpcAttributeCommand.d.ts +40 -0
  98. package/dist-types/commands/DescribeVpcsCommand.d.ts +33 -0
  99. package/dist-types/commands/DetachInternetGatewayCommand.d.ts +12 -0
  100. package/dist-types/commands/DetachNetworkInterfaceCommand.d.ts +11 -0
  101. package/dist-types/commands/DetachVolumeCommand.d.ts +20 -0
  102. package/dist-types/commands/DisableVgwRoutePropagationCommand.d.ts +12 -0
  103. package/dist-types/commands/DisassociateAddressCommand.d.ts +22 -0
  104. package/dist-types/commands/DisassociateIamInstanceProfileCommand.d.ts +24 -0
  105. package/dist-types/commands/DisassociateRouteTableCommand.d.ts +11 -0
  106. package/dist-types/commands/EnableVgwRoutePropagationCommand.d.ts +12 -0
  107. package/dist-types/commands/EnableVolumeIOCommand.d.ts +11 -0
  108. package/dist-types/commands/GetConsoleOutputCommand.d.ts +18 -0
  109. package/dist-types/commands/GetLaunchTemplateDataCommand.d.ts +63 -0
  110. package/dist-types/commands/ModifyImageAttributeCommand.d.ts +36 -0
  111. package/dist-types/commands/ModifyInstanceAttributeCommand.d.ts +28 -0
  112. package/dist-types/commands/ModifyLaunchTemplateCommand.d.ts +24 -0
  113. package/dist-types/commands/ModifyNetworkInterfaceAttributeCommand.d.ts +58 -0
  114. package/dist-types/commands/ModifySnapshotAttributeCommand.d.ts +32 -0
  115. package/dist-types/commands/ModifySpotFleetRequestCommand.d.ts +35 -0
  116. package/dist-types/commands/ModifySubnetAttributeCommand.d.ts +14 -0
  117. package/dist-types/commands/ModifyVolumeAttributeCommand.d.ts +15 -0
  118. package/dist-types/commands/ModifyVpcAttributeCommand.d.ts +28 -0
  119. package/dist-types/commands/MoveAddressToVpcCommand.d.ts +16 -0
  120. package/dist-types/commands/PurchaseScheduledInstancesCommand.d.ts +46 -0
  121. package/dist-types/commands/RebootInstancesCommand.d.ts +13 -0
  122. package/dist-types/commands/ReleaseAddressCommand.d.ts +22 -0
  123. package/dist-types/commands/ReplaceNetworkAclAssociationCommand.d.ts +17 -0
  124. package/dist-types/commands/ReplaceNetworkAclEntryCommand.d.ts +20 -0
  125. package/dist-types/commands/ReplaceRouteCommand.d.ts +13 -0
  126. package/dist-types/commands/ReplaceRouteTableAssociationCommand.d.ts +17 -0
  127. package/dist-types/commands/RequestSpotFleetCommand.d.ts +152 -0
  128. package/dist-types/commands/RequestSpotInstancesCommand.d.ts +51 -0
  129. package/dist-types/commands/ResetImageAttributeCommand.d.ts +12 -0
  130. package/dist-types/commands/ResetInstanceAttributeCommand.d.ts +12 -0
  131. package/dist-types/commands/ResetSnapshotAttributeCommand.d.ts +12 -0
  132. package/dist-types/commands/RestoreAddressToClassicCommand.d.ts +17 -0
  133. package/dist-types/commands/RunInstancesCommand.d.ts +38 -0
  134. package/dist-types/commands/RunScheduledInstancesCommand.d.ts +70 -0
  135. package/dist-types/commands/StartInstancesCommand.d.ts +30 -0
  136. package/dist-types/commands/StopInstancesCommand.d.ts +30 -0
  137. package/dist-types/commands/TerminateInstancesCommand.d.ts +30 -0
  138. package/dist-types/commands/UnassignPrivateIpAddressesCommand.d.ts +14 -0
  139. package/dist-types/commands/UpdateSecurityGroupRuleDescriptionsEgressCommand.d.ts +24 -0
  140. package/dist-types/commands/UpdateSecurityGroupRuleDescriptionsIngressCommand.d.ts +24 -0
  141. package/package.json +31 -31
@@ -30,6 +30,17 @@ export interface DeleteCustomerGatewayCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteCustomerGatewayCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To delete a customer gateway
34
+ * ```javascript
35
+ * // This example deletes the specified customer gateway.
36
+ * const input = {
37
+ * "CustomerGatewayId": "cgw-0e11f167"
38
+ * };
39
+ * const command = new DeleteCustomerGatewayCommand(input);
40
+ * await client.send(command);
41
+ * // example id: ec2-delete-customer-gateway-1
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteCustomerGatewayCommand extends $Command<DeleteCustomerGatewayCommandInput, DeleteCustomerGatewayCommandOutput, EC2ClientResolvedConfig> {
35
46
  readonly input: DeleteCustomerGatewayCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteDhcpOptionsCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteDhcpOptionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a DHCP options set
33
+ * ```javascript
34
+ * // This example deletes the specified DHCP options set.
35
+ * const input = {
36
+ * "DhcpOptionsId": "dopt-d9070ebb"
37
+ * };
38
+ * const command = new DeleteDhcpOptionsCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-dhcp-options-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteDhcpOptionsCommand extends $Command<DeleteDhcpOptionsCommandInput, DeleteDhcpOptionsCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteDhcpOptionsCommandInput;
@@ -30,6 +30,17 @@ export interface DeleteInternetGatewayCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteInternetGatewayCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To delete an Internet gateway
34
+ * ```javascript
35
+ * // This example deletes the specified Internet gateway.
36
+ * const input = {
37
+ * "InternetGatewayId": "igw-c0a643a9"
38
+ * };
39
+ * const command = new DeleteInternetGatewayCommand(input);
40
+ * await client.send(command);
41
+ * // example id: ec2-delete-internet-gateway-1
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteInternetGatewayCommand extends $Command<DeleteInternetGatewayCommandInput, DeleteInternetGatewayCommandOutput, EC2ClientResolvedConfig> {
35
46
  readonly input: DeleteInternetGatewayCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteKeyPairCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteKeyPairCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a key pair
33
+ * ```javascript
34
+ * // This example deletes the specified key pair.
35
+ * const input = {
36
+ * "KeyName": "my-key-pair"
37
+ * };
38
+ * const command = new DeleteKeyPairCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-key-pair-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteKeyPairCommand extends $Command<DeleteKeyPairCommandInput, DeleteKeyPairCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteKeyPairCommandInput;
@@ -30,6 +30,29 @@ export interface DeleteLaunchTemplateCommandOutput extends DeleteLaunchTemplateR
30
30
  * @see {@link DeleteLaunchTemplateCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To delete a launch template
34
+ * ```javascript
35
+ * // This example deletes the specified launch template.
36
+ * const input = {
37
+ * "LaunchTemplateId": "lt-0abcd290751193123"
38
+ * };
39
+ * const command = new DeleteLaunchTemplateCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "LaunchTemplate": {
44
+ * "CreateTime": "2017-11-23T16:46:25.000Z",
45
+ * "CreatedBy": "arn:aws:iam::123456789012:root",
46
+ * "DefaultVersionNumber": 2,
47
+ * "LatestVersionNumber": 2,
48
+ * "LaunchTemplateId": "lt-0abcd290751193123",
49
+ * "LaunchTemplateName": "my-template"
50
+ * }
51
+ * }
52
+ * *\/
53
+ * // example id: to-delete-a-launch-template-1529024658216
54
+ * ```
55
+ *
33
56
  */
34
57
  export declare class DeleteLaunchTemplateCommand extends $Command<DeleteLaunchTemplateCommandInput, DeleteLaunchTemplateCommandOutput, EC2ClientResolvedConfig> {
35
58
  readonly input: DeleteLaunchTemplateCommandInput;
@@ -32,6 +32,32 @@ export interface DeleteLaunchTemplateVersionsCommandOutput extends DeleteLaunchT
32
32
  * @see {@link DeleteLaunchTemplateVersionsCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To delete a launch template version
36
+ * ```javascript
37
+ * // This example deletes the specified launch template version.
38
+ * const input = {
39
+ * "LaunchTemplateId": "lt-0abcd290751193123",
40
+ * "Versions": [
41
+ * "1"
42
+ * ]
43
+ * };
44
+ * const command = new DeleteLaunchTemplateVersionsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "SuccessfullyDeletedLaunchTemplateVersions": [
49
+ * {
50
+ * "LaunchTemplateId": "lt-0abcd290751193123",
51
+ * "LaunchTemplateName": "my-template",
52
+ * "VersionNumber": 1
53
+ * }
54
+ * ],
55
+ * "UnsuccessfullyDeletedLaunchTemplateVersions": []
56
+ * }
57
+ * *\/
58
+ * // example id: to-delete-a-launch-template-version-1529024790864
59
+ * ```
60
+ *
35
61
  */
36
62
  export declare class DeleteLaunchTemplateVersionsCommand extends $Command<DeleteLaunchTemplateVersionsCommandInput, DeleteLaunchTemplateVersionsCommandOutput, EC2ClientResolvedConfig> {
37
63
  readonly input: DeleteLaunchTemplateVersionsCommandInput;
@@ -31,6 +31,22 @@ export interface DeleteNatGatewayCommandOutput extends DeleteNatGatewayResult, _
31
31
  * @see {@link DeleteNatGatewayCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To delete a NAT gateway
35
+ * ```javascript
36
+ * // This example deletes the specified NAT gateway.
37
+ * const input = {
38
+ * "NatGatewayId": "nat-04ae55e711cec5680"
39
+ * };
40
+ * const command = new DeleteNatGatewayCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "NatGatewayId": "nat-04ae55e711cec5680"
45
+ * }
46
+ * *\/
47
+ * // example id: ec2-delete-nat-gateway-1
48
+ * ```
49
+ *
34
50
  */
35
51
  export declare class DeleteNatGatewayCommand extends $Command<DeleteNatGatewayCommandInput, DeleteNatGatewayCommandOutput, EC2ClientResolvedConfig> {
36
52
  readonly input: DeleteNatGatewayCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteNetworkAclCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteNetworkAclCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a network ACL
33
+ * ```javascript
34
+ * // This example deletes the specified network ACL.
35
+ * const input = {
36
+ * "NetworkAclId": "acl-5fb85d36"
37
+ * };
38
+ * const command = new DeleteNetworkAclCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-network-acl-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteNetworkAclCommand extends $Command<DeleteNetworkAclCommandInput, DeleteNetworkAclCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteNetworkAclCommandInput;
@@ -29,6 +29,19 @@ export interface DeleteNetworkAclEntryCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteNetworkAclEntryCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a network ACL entry
33
+ * ```javascript
34
+ * // This example deletes ingress rule number 100 from the specified network ACL.
35
+ * const input = {
36
+ * "Egress": true,
37
+ * "NetworkAclId": "acl-5fb85d36",
38
+ * "RuleNumber": 100
39
+ * };
40
+ * const command = new DeleteNetworkAclEntryCommand(input);
41
+ * await client.send(command);
42
+ * // example id: ec2-delete-network-acl-entry-1
43
+ * ```
44
+ *
32
45
  */
33
46
  export declare class DeleteNetworkAclEntryCommand extends $Command<DeleteNetworkAclEntryCommandInput, DeleteNetworkAclEntryCommandOutput, EC2ClientResolvedConfig> {
34
47
  readonly input: DeleteNetworkAclEntryCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteNetworkInterfaceCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteNetworkInterfaceCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a network interface
33
+ * ```javascript
34
+ * // This example deletes the specified network interface.
35
+ * const input = {
36
+ * "NetworkInterfaceId": "eni-e5aa89a3"
37
+ * };
38
+ * const command = new DeleteNetworkInterfaceCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-network-interface-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteNetworkInterfaceCommand extends $Command<DeleteNetworkInterfaceCommandInput, DeleteNetworkInterfaceCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteNetworkInterfaceCommandInput;
@@ -31,6 +31,18 @@ export interface DeletePlacementGroupCommandOutput extends __MetadataBearer {
31
31
  * @see {@link DeletePlacementGroupCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To delete a placement group
35
+ * ```javascript
36
+ * // This example deletes the specified placement group.
37
+ * //
38
+ * const input = {
39
+ * "GroupName": "my-cluster"
40
+ * };
41
+ * const command = new DeletePlacementGroupCommand(input);
42
+ * await client.send(command);
43
+ * // example id: to-delete-a-placement-group-1472712349959
44
+ * ```
45
+ *
34
46
  */
35
47
  export declare class DeletePlacementGroupCommand extends $Command<DeletePlacementGroupCommandInput, DeletePlacementGroupCommandOutput, EC2ClientResolvedConfig> {
36
48
  readonly input: DeletePlacementGroupCommandInput;
@@ -29,6 +29,18 @@ export interface DeleteRouteCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteRouteCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a route
33
+ * ```javascript
34
+ * // This example deletes the specified route from the specified route table.
35
+ * const input = {
36
+ * "DestinationCidrBlock": "0.0.0.0/0",
37
+ * "RouteTableId": "rtb-22574640"
38
+ * };
39
+ * const command = new DeleteRouteCommand(input);
40
+ * await client.send(command);
41
+ * // example id: ec2-delete-route-1
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DeleteRouteCommand extends $Command<DeleteRouteCommandInput, DeleteRouteCommandOutput, EC2ClientResolvedConfig> {
34
46
  readonly input: DeleteRouteCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteRouteTableCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteRouteTableCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a route table
33
+ * ```javascript
34
+ * // This example deletes the specified route table.
35
+ * const input = {
36
+ * "RouteTableId": "rtb-22574640"
37
+ * };
38
+ * const command = new DeleteRouteTableCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-route-table-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteRouteTableCommand extends $Command<DeleteRouteTableCommandInput, DeleteRouteTableCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteRouteTableCommandInput;
@@ -36,6 +36,17 @@ export interface DeleteSecurityGroupCommandOutput extends __MetadataBearer {
36
36
  * @see {@link DeleteSecurityGroupCommandOutput} for command's `response` shape.
37
37
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
38
38
  *
39
+ * @example To delete a security group
40
+ * ```javascript
41
+ * // This example deletes the specified security group.
42
+ * const input = {
43
+ * "GroupId": "sg-903004f8"
44
+ * };
45
+ * const command = new DeleteSecurityGroupCommand(input);
46
+ * await client.send(command);
47
+ * // example id: to-delete-a-security-group-1529024952972
48
+ * ```
49
+ *
39
50
  */
40
51
  export declare class DeleteSecurityGroupCommand extends $Command<DeleteSecurityGroupCommandInput, DeleteSecurityGroupCommandOutput, EC2ClientResolvedConfig> {
41
52
  readonly input: DeleteSecurityGroupCommandInput;
@@ -38,6 +38,17 @@ export interface DeleteSnapshotCommandOutput extends __MetadataBearer {
38
38
  * @see {@link DeleteSnapshotCommandOutput} for command's `response` shape.
39
39
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
40
40
  *
41
+ * @example To delete a snapshot
42
+ * ```javascript
43
+ * // This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.
44
+ * const input = {
45
+ * "SnapshotId": "snap-1234567890abcdef0"
46
+ * };
47
+ * const command = new DeleteSnapshotCommand(input);
48
+ * await client.send(command);
49
+ * // example id: to-delete-a-snapshot-1472503042567
50
+ * ```
51
+ *
41
52
  */
42
53
  export declare class DeleteSnapshotCommand extends $Command<DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput, EC2ClientResolvedConfig> {
43
54
  readonly input: DeleteSnapshotCommandInput;
@@ -29,6 +29,15 @@ export interface DeleteSpotDatafeedSubscriptionCommandOutput extends __MetadataB
29
29
  * @see {@link DeleteSpotDatafeedSubscriptionCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To cancel a Spot Instance data feed subscription
33
+ * ```javascript
34
+ * // This example deletes a Spot data feed subscription for the account.
35
+ * const input = undefined;
36
+ * const command = new DeleteSpotDatafeedSubscriptionCommand(input);
37
+ * await client.send(command);
38
+ * // example id: ec2-delete-spot-datafeed-subscription-1
39
+ * ```
40
+ *
32
41
  */
33
42
  export declare class DeleteSpotDatafeedSubscriptionCommand extends $Command<DeleteSpotDatafeedSubscriptionCommandInput, DeleteSpotDatafeedSubscriptionCommandOutput, EC2ClientResolvedConfig> {
34
43
  readonly input: DeleteSpotDatafeedSubscriptionCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteSubnetCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteSubnetCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a subnet
33
+ * ```javascript
34
+ * // This example deletes the specified subnet.
35
+ * const input = {
36
+ * "SubnetId": "subnet-9d4a7b6c"
37
+ * };
38
+ * const command = new DeleteSubnetCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-subnet-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteSubnetCommand extends $Command<DeleteSubnetCommandInput, DeleteSubnetCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteSubnetCommandInput;
@@ -33,6 +33,25 @@ export interface DeleteTagsCommandOutput extends __MetadataBearer {
33
33
  * @see {@link DeleteTagsCommandOutput} for command's `response` shape.
34
34
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
35
35
  *
36
+ * @example To delete a tag from a resource
37
+ * ```javascript
38
+ * // This example deletes the tag Stack=test from the specified image.
39
+ * const input = {
40
+ * "Resources": [
41
+ * "ami-78a54011"
42
+ * ],
43
+ * "Tags": [
44
+ * {
45
+ * "Key": "Stack",
46
+ * "Value": "test"
47
+ * }
48
+ * ]
49
+ * };
50
+ * const command = new DeleteTagsCommand(input);
51
+ * await client.send(command);
52
+ * // example id: ec2-delete-tags-1
53
+ * ```
54
+ *
36
55
  */
37
56
  export declare class DeleteTagsCommand extends $Command<DeleteTagsCommandInput, DeleteTagsCommandOutput, EC2ClientResolvedConfig> {
38
57
  readonly input: DeleteTagsCommandInput;
@@ -33,6 +33,17 @@ export interface DeleteVolumeCommandOutput extends __MetadataBearer {
33
33
  * @see {@link DeleteVolumeCommandOutput} for command's `response` shape.
34
34
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
35
35
  *
36
+ * @example To delete a volume
37
+ * ```javascript
38
+ * // This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.
39
+ * const input = {
40
+ * "VolumeId": "vol-049df61146c4d7901"
41
+ * };
42
+ * const command = new DeleteVolumeCommand(input);
43
+ * await client.send(command);
44
+ * // example id: to-delete-a-volume-1472503111160
45
+ * ```
46
+ *
36
47
  */
37
48
  export declare class DeleteVolumeCommand extends $Command<DeleteVolumeCommandInput, DeleteVolumeCommandOutput, EC2ClientResolvedConfig> {
38
49
  readonly input: DeleteVolumeCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteVpcCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteVpcCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To delete a VPC
33
+ * ```javascript
34
+ * // This example deletes the specified VPC.
35
+ * const input = {
36
+ * "VpcId": "vpc-a01106c2"
37
+ * };
38
+ * const command = new DeleteVpcCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-delete-vpc-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteVpcCommand extends $Command<DeleteVpcCommandInput, DeleteVpcCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DeleteVpcCommandInput;
@@ -66,6 +66,102 @@ export interface DescribeAccountAttributesCommandOutput extends DescribeAccountA
66
66
  * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape.
67
67
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
68
68
  *
69
+ * @example To describe a single attribute for your AWS account
70
+ * ```javascript
71
+ * // This example describes the supported-platforms attribute for your AWS account.
72
+ * const input = {
73
+ * "AttributeNames": [
74
+ * "supported-platforms"
75
+ * ]
76
+ * };
77
+ * const command = new DescribeAccountAttributesCommand(input);
78
+ * const response = await client.send(command);
79
+ * /* response ==
80
+ * {
81
+ * "AccountAttributes": [
82
+ * {
83
+ * "AttributeName": "supported-platforms",
84
+ * "AttributeValues": [
85
+ * {
86
+ * "AttributeValue": "EC2"
87
+ * },
88
+ * {
89
+ * "AttributeValue": "VPC"
90
+ * }
91
+ * ]
92
+ * }
93
+ * ]
94
+ * }
95
+ * *\/
96
+ * // example id: ec2-describe-account-attributes-1
97
+ * ```
98
+ *
99
+ * @example To describe all attributes for your AWS account
100
+ * ```javascript
101
+ * // This example describes the attributes for your AWS account.
102
+ * const input = undefined;
103
+ * const command = new DescribeAccountAttributesCommand(input);
104
+ * const response = await client.send(command);
105
+ * /* response ==
106
+ * {
107
+ * "AccountAttributes": [
108
+ * {
109
+ * "AttributeName": "supported-platforms",
110
+ * "AttributeValues": [
111
+ * {
112
+ * "AttributeValue": "EC2"
113
+ * },
114
+ * {
115
+ * "AttributeValue": "VPC"
116
+ * }
117
+ * ]
118
+ * },
119
+ * {
120
+ * "AttributeName": "vpc-max-security-groups-per-interface",
121
+ * "AttributeValues": [
122
+ * {
123
+ * "AttributeValue": "5"
124
+ * }
125
+ * ]
126
+ * },
127
+ * {
128
+ * "AttributeName": "max-elastic-ips",
129
+ * "AttributeValues": [
130
+ * {
131
+ * "AttributeValue": "5"
132
+ * }
133
+ * ]
134
+ * },
135
+ * {
136
+ * "AttributeName": "max-instances",
137
+ * "AttributeValues": [
138
+ * {
139
+ * "AttributeValue": "20"
140
+ * }
141
+ * ]
142
+ * },
143
+ * {
144
+ * "AttributeName": "vpc-max-elastic-ips",
145
+ * "AttributeValues": [
146
+ * {
147
+ * "AttributeValue": "5"
148
+ * }
149
+ * ]
150
+ * },
151
+ * {
152
+ * "AttributeName": "default-vpc",
153
+ * "AttributeValues": [
154
+ * {
155
+ * "AttributeValue": "none"
156
+ * }
157
+ * ]
158
+ * }
159
+ * ]
160
+ * }
161
+ * *\/
162
+ * // example id: ec2-describe-account-attributes-2
163
+ * ```
164
+ *
69
165
  */
70
166
  export declare class DescribeAccountAttributesCommand extends $Command<DescribeAccountAttributesCommandInput, DescribeAccountAttributesCommandOutput, EC2ClientResolvedConfig> {
71
167
  readonly input: DescribeAccountAttributesCommandInput;
@@ -34,6 +34,99 @@ export interface DescribeAddressesCommandOutput extends DescribeAddressesResult,
34
34
  * @see {@link DescribeAddressesCommandOutput} for command's `response` shape.
35
35
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
36
36
  *
37
+ * @example To describe your Elastic IP addresses
38
+ * ```javascript
39
+ * // This example describes your Elastic IP addresses.
40
+ * const input = undefined;
41
+ * const command = new DescribeAddressesCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "Addresses": [
46
+ * {
47
+ * "Domain": "standard",
48
+ * "InstanceId": "i-1234567890abcdef0",
49
+ * "PublicIp": "198.51.100.0"
50
+ * },
51
+ * {
52
+ * "AllocationId": "eipalloc-12345678",
53
+ * "AssociationId": "eipassoc-12345678",
54
+ * "Domain": "vpc",
55
+ * "InstanceId": "i-1234567890abcdef0",
56
+ * "NetworkInterfaceId": "eni-12345678",
57
+ * "NetworkInterfaceOwnerId": "123456789012",
58
+ * "PrivateIpAddress": "10.0.1.241",
59
+ * "PublicIp": "203.0.113.0"
60
+ * }
61
+ * ]
62
+ * }
63
+ * *\/
64
+ * // example id: ec2-describe-addresses-1
65
+ * ```
66
+ *
67
+ * @example To describe your Elastic IP addresses for EC2-VPC
68
+ * ```javascript
69
+ * // This example describes your Elastic IP addresses for use with instances in a VPC.
70
+ * const input = {
71
+ * "Filters": [
72
+ * {
73
+ * "Name": "domain",
74
+ * "Values": [
75
+ * "vpc"
76
+ * ]
77
+ * }
78
+ * ]
79
+ * };
80
+ * const command = new DescribeAddressesCommand(input);
81
+ * const response = await client.send(command);
82
+ * /* response ==
83
+ * {
84
+ * "Addresses": [
85
+ * {
86
+ * "AllocationId": "eipalloc-12345678",
87
+ * "AssociationId": "eipassoc-12345678",
88
+ * "Domain": "vpc",
89
+ * "InstanceId": "i-1234567890abcdef0",
90
+ * "NetworkInterfaceId": "eni-12345678",
91
+ * "NetworkInterfaceOwnerId": "123456789012",
92
+ * "PrivateIpAddress": "10.0.1.241",
93
+ * "PublicIp": "203.0.113.0"
94
+ * }
95
+ * ]
96
+ * }
97
+ * *\/
98
+ * // example id: ec2-describe-addresses-2
99
+ * ```
100
+ *
101
+ * @example To describe your Elastic IP addresses for EC2-Classic
102
+ * ```javascript
103
+ * // This example describes your Elastic IP addresses for use with instances in EC2-Classic.
104
+ * const input = {
105
+ * "Filters": [
106
+ * {
107
+ * "Name": "domain",
108
+ * "Values": [
109
+ * "standard"
110
+ * ]
111
+ * }
112
+ * ]
113
+ * };
114
+ * const command = new DescribeAddressesCommand(input);
115
+ * const response = await client.send(command);
116
+ * /* response ==
117
+ * {
118
+ * "Addresses": [
119
+ * {
120
+ * "Domain": "standard",
121
+ * "InstanceId": "i-1234567890abcdef0",
122
+ * "PublicIp": "198.51.100.0"
123
+ * }
124
+ * ]
125
+ * }
126
+ * *\/
127
+ * // example id: ec2-describe-addresses-3
128
+ * ```
129
+ *
37
130
  */
38
131
  export declare class DescribeAddressesCommand extends $Command<DescribeAddressesCommandInput, DescribeAddressesCommandOutput, EC2ClientResolvedConfig> {
39
132
  readonly input: DescribeAddressesCommandInput;
@@ -34,6 +34,45 @@ export interface DescribeAvailabilityZonesCommandOutput extends DescribeAvailabi
34
34
  * @see {@link DescribeAvailabilityZonesCommandOutput} for command's `response` shape.
35
35
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
36
36
  *
37
+ * @example To describe your Availability Zones
38
+ * ```javascript
39
+ * // This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.
40
+ * const input = undefined;
41
+ * const command = new DescribeAvailabilityZonesCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "AvailabilityZones": [
46
+ * {
47
+ * "Messages": [],
48
+ * "RegionName": "us-east-1",
49
+ * "State": "available",
50
+ * "ZoneName": "us-east-1b"
51
+ * },
52
+ * {
53
+ * "Messages": [],
54
+ * "RegionName": "us-east-1",
55
+ * "State": "available",
56
+ * "ZoneName": "us-east-1c"
57
+ * },
58
+ * {
59
+ * "Messages": [],
60
+ * "RegionName": "us-east-1",
61
+ * "State": "available",
62
+ * "ZoneName": "us-east-1d"
63
+ * },
64
+ * {
65
+ * "Messages": [],
66
+ * "RegionName": "us-east-1",
67
+ * "State": "available",
68
+ * "ZoneName": "us-east-1e"
69
+ * }
70
+ * ]
71
+ * }
72
+ * *\/
73
+ * // example id: ec2-describe-availability-zones-1
74
+ * ```
75
+ *
37
76
  */
38
77
  export declare class DescribeAvailabilityZonesCommand extends $Command<DescribeAvailabilityZonesCommandInput, DescribeAvailabilityZonesCommandOutput, EC2ClientResolvedConfig> {
39
78
  readonly input: DescribeAvailabilityZonesCommandInput;