@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
@@ -36,6 +36,28 @@ export interface DisassociateAddressCommandOutput extends __MetadataBearer {
36
36
  * @see {@link DisassociateAddressCommandOutput} for command's `response` shape.
37
37
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
38
38
  *
39
+ * @example To disassociate an Elastic IP address in EC2-VPC
40
+ * ```javascript
41
+ * // This example disassociates an Elastic IP address from an instance in a VPC.
42
+ * const input = {
43
+ * "AssociationId": "eipassoc-2bebb745"
44
+ * };
45
+ * const command = new DisassociateAddressCommand(input);
46
+ * await client.send(command);
47
+ * // example id: ec2-disassociate-address-1
48
+ * ```
49
+ *
50
+ * @example To disassociate an Elastic IP addresses in EC2-Classic
51
+ * ```javascript
52
+ * // This example disassociates an Elastic IP address from an instance in EC2-Classic.
53
+ * const input = {
54
+ * "PublicIp": "198.51.100.0"
55
+ * };
56
+ * const command = new DisassociateAddressCommand(input);
57
+ * await client.send(command);
58
+ * // example id: ec2-disassociate-address-2
59
+ * ```
60
+ *
39
61
  */
40
62
  export declare class DisassociateAddressCommand extends $Command<DisassociateAddressCommandInput, DisassociateAddressCommandOutput, EC2ClientResolvedConfig> {
41
63
  readonly input: DisassociateAddressCommandInput;
@@ -31,6 +31,30 @@ export interface DisassociateIamInstanceProfileCommandOutput extends Disassociat
31
31
  * @see {@link DisassociateIamInstanceProfileCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To disassociate an IAM instance profile
35
+ * ```javascript
36
+ * // This example disassociates the specified IAM instance profile from an instance.
37
+ * const input = {
38
+ * "AssociationId": "iip-assoc-05020b59952902f5f"
39
+ * };
40
+ * const command = new DisassociateIamInstanceProfileCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "IamInstanceProfileAssociation": {
45
+ * "AssociationId": "iip-assoc-05020b59952902f5f",
46
+ * "IamInstanceProfile": {
47
+ * "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role",
48
+ * "Id": "AIPAI5IVIHMFFYY2DKV5Y"
49
+ * },
50
+ * "InstanceId": "i-123456789abcde123",
51
+ * "State": "disassociating"
52
+ * }
53
+ * }
54
+ * *\/
55
+ * // example id: to-disassociate-an-iam-instance-profile-1529355364478
56
+ * ```
57
+ *
34
58
  */
35
59
  export declare class DisassociateIamInstanceProfileCommand extends $Command<DisassociateIamInstanceProfileCommandInput, DisassociateIamInstanceProfileCommandOutput, EC2ClientResolvedConfig> {
36
60
  readonly input: DisassociateIamInstanceProfileCommandInput;
@@ -33,6 +33,17 @@ export interface DisassociateRouteTableCommandOutput extends __MetadataBearer {
33
33
  * @see {@link DisassociateRouteTableCommandOutput} for command's `response` shape.
34
34
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
35
35
  *
36
+ * @example To disassociate a route table
37
+ * ```javascript
38
+ * // This example disassociates the specified route table from its associated subnet.
39
+ * const input = {
40
+ * "AssociationId": "rtbassoc-781d0d1a"
41
+ * };
42
+ * const command = new DisassociateRouteTableCommand(input);
43
+ * await client.send(command);
44
+ * // example id: ec2-disassociate-route-table-1
45
+ * ```
46
+ *
36
47
  */
37
48
  export declare class DisassociateRouteTableCommand extends $Command<DisassociateRouteTableCommandInput, DisassociateRouteTableCommandOutput, EC2ClientResolvedConfig> {
38
49
  readonly input: DisassociateRouteTableCommandInput;
@@ -30,6 +30,18 @@ export interface EnableVgwRoutePropagationCommandOutput extends __MetadataBearer
30
30
  * @see {@link EnableVgwRoutePropagationCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To enable route propagation
34
+ * ```javascript
35
+ * // This example enables the specified virtual private gateway to propagate static routes to the specified route table.
36
+ * const input = {
37
+ * "GatewayId": "vgw-9a4cacf3",
38
+ * "RouteTableId": "rtb-22574640"
39
+ * };
40
+ * const command = new EnableVgwRoutePropagationCommand(input);
41
+ * await client.send(command);
42
+ * // example id: ec2-enable-vgw-route-propagation-1
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class EnableVgwRoutePropagationCommand extends $Command<EnableVgwRoutePropagationCommandInput, EnableVgwRoutePropagationCommandOutput, EC2ClientResolvedConfig> {
35
47
  readonly input: EnableVgwRoutePropagationCommandInput;
@@ -30,6 +30,17 @@ export interface EnableVolumeIOCommandOutput extends __MetadataBearer {
30
30
  * @see {@link EnableVolumeIOCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To enable I/O for a volume
34
+ * ```javascript
35
+ * // This example enables I/O on volume ``vol-1234567890abcdef0``.
36
+ * const input = {
37
+ * "VolumeId": "vol-1234567890abcdef0"
38
+ * };
39
+ * const command = new EnableVolumeIOCommand(input);
40
+ * await client.send(command);
41
+ * // example id: to-enable-io-for-a-volume-1472508114867
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class EnableVolumeIOCommand extends $Command<EnableVolumeIOCommandInput, EnableVolumeIOCommandOutput, EC2ClientResolvedConfig> {
35
46
  readonly input: EnableVolumeIOCommandInput;
@@ -41,6 +41,24 @@ export interface GetConsoleOutputCommandOutput extends GetConsoleOutputResult, _
41
41
  * @see {@link GetConsoleOutputCommandOutput} for command's `response` shape.
42
42
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
43
43
  *
44
+ * @example To get the console output
45
+ * ```javascript
46
+ * // This example gets the console output for the specified instance.
47
+ * const input = {
48
+ * "InstanceId": "i-1234567890abcdef0"
49
+ * };
50
+ * const command = new GetConsoleOutputCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "InstanceId": "i-1234567890abcdef0",
55
+ * "Output": "...",
56
+ * "Timestamp": "2018-05-25T21:23:53.000Z"
57
+ * }
58
+ * *\/
59
+ * // example id: to-get-the-console-output-1529355683194
60
+ * ```
61
+ *
44
62
  */
45
63
  export declare class GetConsoleOutputCommand extends $Command<GetConsoleOutputCommandInput, GetConsoleOutputCommandOutput, EC2ClientResolvedConfig> {
46
64
  readonly input: GetConsoleOutputCommandInput;
@@ -36,6 +36,69 @@ export interface GetLaunchTemplateDataCommandOutput extends GetLaunchTemplateDat
36
36
  * @see {@link GetLaunchTemplateDataCommandOutput} for command's `response` shape.
37
37
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
38
38
  *
39
+ * @example To get the launch template data for an instance
40
+ * ```javascript
41
+ * // This example gets the launch template data for the specified instance.
42
+ * const input = {
43
+ * "InstanceId": "0123d646e8048babc"
44
+ * };
45
+ * const command = new GetLaunchTemplateDataCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "LaunchTemplateData": {
50
+ * "BlockDeviceMappings": [
51
+ * {
52
+ * "DeviceName": "/dev/xvda",
53
+ * "Ebs": {
54
+ * "DeleteOnTermination": true,
55
+ * "Encrypted": false,
56
+ * "Iops": 100,
57
+ * "SnapshotId": "snap-02594938353ef77d3",
58
+ * "VolumeSize": 8,
59
+ * "VolumeType": "gp2"
60
+ * }
61
+ * }
62
+ * ],
63
+ * "EbsOptimized": false,
64
+ * "ImageId": "ami-32cf7b4a",
65
+ * "InstanceType": "t2.medium",
66
+ * "KeyName": "my-key-pair",
67
+ * "Monitoring": {
68
+ * "Enabled": false
69
+ * },
70
+ * "NetworkInterfaces": [
71
+ * {
72
+ * "AssociatePublicIpAddress": false,
73
+ * "DeleteOnTermination": true,
74
+ * "Description": "",
75
+ * "DeviceIndex": 0,
76
+ * "Groups": [
77
+ * "sg-d14e1bb4"
78
+ * ],
79
+ * "Ipv6Addresses": [],
80
+ * "NetworkInterfaceId": "eni-4338b5a9",
81
+ * "PrivateIpAddress": "10.0.3.233",
82
+ * "PrivateIpAddresses": [
83
+ * {
84
+ * "Primary": true,
85
+ * "PrivateIpAddress": "10.0.3.233"
86
+ * }
87
+ * ],
88
+ * "SubnetId": "subnet-5264e837"
89
+ * }
90
+ * ],
91
+ * "Placement": {
92
+ * "AvailabilityZone": "us-east-2b",
93
+ * "GroupName": "",
94
+ * "Tenancy": "default"
95
+ * }
96
+ * }
97
+ * }
98
+ * *\/
99
+ * // example id: to-get-the-launch-template-data-for-an-instance--1529356515702
100
+ * ```
101
+ *
39
102
  */
40
103
  export declare class GetLaunchTemplateDataCommand extends $Command<GetLaunchTemplateDataCommandInput, GetLaunchTemplateDataCommandOutput, EC2ClientResolvedConfig> {
41
104
  readonly input: GetLaunchTemplateDataCommandInput;
@@ -34,6 +34,42 @@ export interface ModifyImageAttributeCommandOutput extends __MetadataBearer {
34
34
  * @see {@link ModifyImageAttributeCommandOutput} for command's `response` shape.
35
35
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
36
36
  *
37
+ * @example To make an AMI public
38
+ * ```javascript
39
+ * // This example makes the specified AMI public.
40
+ * const input = {
41
+ * "ImageId": "ami-5731123e",
42
+ * "LaunchPermission": {
43
+ * "Add": [
44
+ * {
45
+ * "Group": "all"
46
+ * }
47
+ * ]
48
+ * }
49
+ * };
50
+ * const command = new ModifyImageAttributeCommand(input);
51
+ * await client.send(command);
52
+ * // example id: to-make-an-ami-public-1529357395278
53
+ * ```
54
+ *
55
+ * @example To grant launch permissions
56
+ * ```javascript
57
+ * // This example grants launch permissions for the specified AMI to the specified AWS account.
58
+ * const input = {
59
+ * "ImageId": "ami-5731123e",
60
+ * "LaunchPermission": {
61
+ * "Add": [
62
+ * {
63
+ * "UserId": "123456789012"
64
+ * }
65
+ * ]
66
+ * }
67
+ * };
68
+ * const command = new ModifyImageAttributeCommand(input);
69
+ * await client.send(command);
70
+ * // example id: to-grant-launch-permissions-1529357727906
71
+ * ```
72
+ *
37
73
  */
38
74
  export declare class ModifyImageAttributeCommand extends $Command<ModifyImageAttributeCommandInput, ModifyImageAttributeCommandOutput, EC2ClientResolvedConfig> {
39
75
  readonly input: ModifyImageAttributeCommandInput;
@@ -39,6 +39,34 @@ export interface ModifyInstanceAttributeCommandOutput extends __MetadataBearer {
39
39
  * @see {@link ModifyInstanceAttributeCommandOutput} for command's `response` shape.
40
40
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
41
41
  *
42
+ * @example To modify the instance type
43
+ * ```javascript
44
+ * // This example modifies the instance type of the specified stopped instance.
45
+ * const input = {
46
+ * "InstanceId": "i-1234567890abcdef0",
47
+ * "InstanceType": {
48
+ * "Value": "m5.large"
49
+ * }
50
+ * };
51
+ * const command = new ModifyInstanceAttributeCommand(input);
52
+ * await client.send(command);
53
+ * // example id: to-modify-the-instance-type-1529357844378
54
+ * ```
55
+ *
56
+ * @example To enable enhanced networking
57
+ * ```javascript
58
+ * // This example enables enhanced networking for the specified stopped instance.
59
+ * const input = {
60
+ * "EnaSupport": {
61
+ * "Value": true
62
+ * },
63
+ * "InstanceId": "i-1234567890abcdef0"
64
+ * };
65
+ * const command = new ModifyInstanceAttributeCommand(input);
66
+ * await client.send(command);
67
+ * // example id: to-enable-enhanced-networking-1529358279870
68
+ * ```
69
+ *
42
70
  */
43
71
  export declare class ModifyInstanceAttributeCommand extends $Command<ModifyInstanceAttributeCommandInput, ModifyInstanceAttributeCommandOutput, EC2ClientResolvedConfig> {
44
72
  readonly input: ModifyInstanceAttributeCommandInput;
@@ -31,6 +31,30 @@ export interface ModifyLaunchTemplateCommandOutput extends ModifyLaunchTemplateR
31
31
  * @see {@link ModifyLaunchTemplateCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To change the default version of a launch template
35
+ * ```javascript
36
+ * // This example specifies version 2 as the default version of the specified launch template.
37
+ * const input = {
38
+ * "DefaultVersion": "2",
39
+ * "LaunchTemplateId": "lt-0abcd290751193123"
40
+ * };
41
+ * const command = new ModifyLaunchTemplateCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "LaunchTemplate": {
46
+ * "CreateTime": "2017-12-01T13:35:46.000Z",
47
+ * "CreatedBy": "arn:aws:iam::123456789012:root",
48
+ * "DefaultVersionNumber": 2,
49
+ * "LatestVersionNumber": 2,
50
+ * "LaunchTemplateId": "lt-0abcd290751193123",
51
+ * "LaunchTemplateName": "WebServers"
52
+ * }
53
+ * }
54
+ * *\/
55
+ * // example id: to-change-the-default-version-of-a-launch-template-1529358440364
56
+ * ```
57
+ *
34
58
  */
35
59
  export declare class ModifyLaunchTemplateCommand extends $Command<ModifyLaunchTemplateCommandInput, ModifyLaunchTemplateCommandOutput, EC2ClientResolvedConfig> {
36
60
  readonly input: ModifyLaunchTemplateCommandInput;
@@ -31,6 +31,64 @@ export interface ModifyNetworkInterfaceAttributeCommandOutput extends __Metadata
31
31
  * @see {@link ModifyNetworkInterfaceAttributeCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To modify the attachment attribute of a network interface
35
+ * ```javascript
36
+ * // This example modifies the attachment attribute of the specified network interface.
37
+ * const input = {
38
+ * "Attachment": {
39
+ * "AttachmentId": "eni-attach-43348162",
40
+ * "DeleteOnTermination": false
41
+ * },
42
+ * "NetworkInterfaceId": "eni-686ea200"
43
+ * };
44
+ * const command = new ModifyNetworkInterfaceAttributeCommand(input);
45
+ * await client.send(command);
46
+ * // example id: ec2-modify-network-interface-attribute-1
47
+ * ```
48
+ *
49
+ * @example To modify the description attribute of a network interface
50
+ * ```javascript
51
+ * // This example modifies the description attribute of the specified network interface.
52
+ * const input = {
53
+ * "Description": {
54
+ * "Value": "My description"
55
+ * },
56
+ * "NetworkInterfaceId": "eni-686ea200"
57
+ * };
58
+ * const command = new ModifyNetworkInterfaceAttributeCommand(input);
59
+ * await client.send(command);
60
+ * // example id: ec2-modify-network-interface-attribute-2
61
+ * ```
62
+ *
63
+ * @example To modify the groupSet attribute of a network interface
64
+ * ```javascript
65
+ * // This example command modifies the groupSet attribute of the specified network interface.
66
+ * const input = {
67
+ * "Groups": [
68
+ * "sg-903004f8",
69
+ * "sg-1a2b3c4d"
70
+ * ],
71
+ * "NetworkInterfaceId": "eni-686ea200"
72
+ * };
73
+ * const command = new ModifyNetworkInterfaceAttributeCommand(input);
74
+ * await client.send(command);
75
+ * // example id: ec2-modify-network-interface-attribute-3
76
+ * ```
77
+ *
78
+ * @example To modify the sourceDestCheck attribute of a network interface
79
+ * ```javascript
80
+ * // This example command modifies the sourceDestCheck attribute of the specified network interface.
81
+ * const input = {
82
+ * "NetworkInterfaceId": "eni-686ea200",
83
+ * "SourceDestCheck": {
84
+ * "Value": false
85
+ * }
86
+ * };
87
+ * const command = new ModifyNetworkInterfaceAttributeCommand(input);
88
+ * await client.send(command);
89
+ * // example id: ec2-modify-network-interface-attribute-4
90
+ * ```
91
+ *
34
92
  */
35
93
  export declare class ModifyNetworkInterfaceAttributeCommand extends $Command<ModifyNetworkInterfaceAttributeCommandInput, ModifyNetworkInterfaceAttributeCommandOutput, EC2ClientResolvedConfig> {
36
94
  readonly input: ModifyNetworkInterfaceAttributeCommandInput;
@@ -36,6 +36,38 @@ export interface ModifySnapshotAttributeCommandOutput extends __MetadataBearer {
36
36
  * @see {@link ModifySnapshotAttributeCommandOutput} for command's `response` shape.
37
37
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
38
38
  *
39
+ * @example To modify a snapshot attribute
40
+ * ```javascript
41
+ * // This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.
42
+ * const input = {
43
+ * "Attribute": "createVolumePermission",
44
+ * "OperationType": "remove",
45
+ * "SnapshotId": "snap-1234567890abcdef0",
46
+ * "UserIds": [
47
+ * "123456789012"
48
+ * ]
49
+ * };
50
+ * const command = new ModifySnapshotAttributeCommand(input);
51
+ * await client.send(command);
52
+ * // example id: to-modify-a-snapshot-attribute-1472508385907
53
+ * ```
54
+ *
55
+ * @example To make a snapshot public
56
+ * ```javascript
57
+ * // This example makes the snapshot ``snap-1234567890abcdef0`` public.
58
+ * const input = {
59
+ * "Attribute": "createVolumePermission",
60
+ * "GroupNames": [
61
+ * "all"
62
+ * ],
63
+ * "OperationType": "add",
64
+ * "SnapshotId": "snap-1234567890abcdef0"
65
+ * };
66
+ * const command = new ModifySnapshotAttributeCommand(input);
67
+ * await client.send(command);
68
+ * // example id: to-make-a-snapshot-public-1472508470529
69
+ * ```
70
+ *
39
71
  */
40
72
  export declare class ModifySnapshotAttributeCommand extends $Command<ModifySnapshotAttributeCommandInput, ModifySnapshotAttributeCommandOutput, EC2ClientResolvedConfig> {
41
73
  readonly input: ModifySnapshotAttributeCommandInput;
@@ -53,6 +53,41 @@ export interface ModifySpotFleetRequestCommandOutput extends ModifySpotFleetRequ
53
53
  * @see {@link ModifySpotFleetRequestCommandOutput} for command's `response` shape.
54
54
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
55
55
  *
56
+ * @example To increase the target capacity of a Spot fleet request
57
+ * ```javascript
58
+ * // This example increases the target capacity of the specified Spot fleet request.
59
+ * const input = {
60
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE",
61
+ * "TargetCapacity": 20
62
+ * };
63
+ * const command = new ModifySpotFleetRequestCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "Return": true
68
+ * }
69
+ * *\/
70
+ * // example id: ec2-modify-spot-fleet-request-1
71
+ * ```
72
+ *
73
+ * @example To decrease the target capacity of a Spot fleet request
74
+ * ```javascript
75
+ * // This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.
76
+ * const input = {
77
+ * "ExcessCapacityTerminationPolicy": "NoTermination ",
78
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE",
79
+ * "TargetCapacity": 10
80
+ * };
81
+ * const command = new ModifySpotFleetRequestCommand(input);
82
+ * const response = await client.send(command);
83
+ * /* response ==
84
+ * {
85
+ * "Return": true
86
+ * }
87
+ * *\/
88
+ * // example id: ec2-modify-spot-fleet-request-2
89
+ * ```
90
+ *
56
91
  */
57
92
  export declare class ModifySpotFleetRequestCommand extends $Command<ModifySpotFleetRequestCommandInput, ModifySpotFleetRequestCommandOutput, EC2ClientResolvedConfig> {
58
93
  readonly input: ModifySpotFleetRequestCommandInput;
@@ -56,6 +56,20 @@ export interface ModifySubnetAttributeCommandOutput extends __MetadataBearer {
56
56
  * @see {@link ModifySubnetAttributeCommandOutput} for command's `response` shape.
57
57
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
58
58
  *
59
+ * @example To change a subnet's public IP addressing behavior
60
+ * ```javascript
61
+ * // This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.
62
+ * const input = {
63
+ * "MapPublicIpOnLaunch": {
64
+ * "Value": true
65
+ * },
66
+ * "SubnetId": "subnet-1a2b3c4d"
67
+ * };
68
+ * const command = new ModifySubnetAttributeCommand(input);
69
+ * await client.send(command);
70
+ * // example id: ec2-modify-subnet-attribute-1
71
+ * ```
72
+ *
59
73
  */
60
74
  export declare class ModifySubnetAttributeCommand extends $Command<ModifySubnetAttributeCommandInput, ModifySubnetAttributeCommandOutput, EC2ClientResolvedConfig> {
61
75
  readonly input: ModifySubnetAttributeCommandInput;
@@ -35,6 +35,21 @@ export interface ModifyVolumeAttributeCommandOutput extends __MetadataBearer {
35
35
  * @see {@link ModifyVolumeAttributeCommandOutput} for command's `response` shape.
36
36
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
37
37
  *
38
+ * @example To modify a volume attribute
39
+ * ```javascript
40
+ * // This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.
41
+ * const input = {
42
+ * "AutoEnableIO": {
43
+ * "Value": true
44
+ * },
45
+ * "DryRun": true,
46
+ * "VolumeId": "vol-1234567890abcdef0"
47
+ * };
48
+ * const command = new ModifyVolumeAttributeCommand(input);
49
+ * await client.send(command);
50
+ * // example id: to-modify-a-volume-attribute-1472508596749
51
+ * ```
52
+ *
38
53
  */
39
54
  export declare class ModifyVolumeAttributeCommand extends $Command<ModifyVolumeAttributeCommandInput, ModifyVolumeAttributeCommandOutput, EC2ClientResolvedConfig> {
40
55
  readonly input: ModifyVolumeAttributeCommandInput;
@@ -29,6 +29,34 @@ export interface ModifyVpcAttributeCommandOutput extends __MetadataBearer {
29
29
  * @see {@link ModifyVpcAttributeCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To modify the enableDnsSupport attribute
33
+ * ```javascript
34
+ * // This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.
35
+ * const input = {
36
+ * "EnableDnsSupport": {
37
+ * "Value": false
38
+ * },
39
+ * "VpcId": "vpc-a01106c2"
40
+ * };
41
+ * const command = new ModifyVpcAttributeCommand(input);
42
+ * await client.send(command);
43
+ * // example id: ec2-modify-vpc-attribute-1
44
+ * ```
45
+ *
46
+ * @example To modify the enableDnsHostnames attribute
47
+ * ```javascript
48
+ * // This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
49
+ * const input = {
50
+ * "EnableDnsHostnames": {
51
+ * "Value": false
52
+ * },
53
+ * "VpcId": "vpc-a01106c2"
54
+ * };
55
+ * const command = new ModifyVpcAttributeCommand(input);
56
+ * await client.send(command);
57
+ * // example id: ec2-modify-vpc-attribute-2
58
+ * ```
59
+ *
32
60
  */
33
61
  export declare class ModifyVpcAttributeCommand extends $Command<ModifyVpcAttributeCommandInput, ModifyVpcAttributeCommandOutput, EC2ClientResolvedConfig> {
34
62
  readonly input: ModifyVpcAttributeCommandInput;
@@ -37,6 +37,22 @@ export interface MoveAddressToVpcCommandOutput extends MoveAddressToVpcResult, _
37
37
  * @see {@link MoveAddressToVpcCommandOutput} for command's `response` shape.
38
38
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
39
39
  *
40
+ * @example To move an address to EC2-VPC
41
+ * ```javascript
42
+ * // This example moves the specified Elastic IP address to the EC2-VPC platform.
43
+ * const input = {
44
+ * "PublicIp": "54.123.4.56"
45
+ * };
46
+ * const command = new MoveAddressToVpcCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "Status": "MoveInProgress"
51
+ * }
52
+ * *\/
53
+ * // example id: ec2-move-address-to-vpc-1
54
+ * ```
55
+ *
40
56
  */
41
57
  export declare class MoveAddressToVpcCommand extends $Command<MoveAddressToVpcCommandInput, MoveAddressToVpcCommandOutput, EC2ClientResolvedConfig> {
42
58
  readonly input: MoveAddressToVpcCommandInput;
@@ -37,6 +37,52 @@ export interface PurchaseScheduledInstancesCommandOutput extends PurchaseSchedul
37
37
  * @see {@link PurchaseScheduledInstancesCommandOutput} for command's `response` shape.
38
38
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
39
39
  *
40
+ * @example To purchase a Scheduled Instance
41
+ * ```javascript
42
+ * // This example purchases a Scheduled Instance.
43
+ * const input = {
44
+ * "PurchaseRequests": [
45
+ * {
46
+ * "InstanceCount": 1,
47
+ * "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi..."
48
+ * }
49
+ * ]
50
+ * };
51
+ * const command = new PurchaseScheduledInstancesCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ScheduledInstanceSet": [
56
+ * {
57
+ * "AvailabilityZone": "us-west-2b",
58
+ * "CreateDate": "2016-01-25T21:43:38.612Z",
59
+ * "HourlyPrice": "0.095",
60
+ * "InstanceCount": 1,
61
+ * "InstanceType": "c4.large",
62
+ * "NetworkPlatform": "EC2-VPC",
63
+ * "NextSlotStartTime": "2016-01-31T09:00:00Z",
64
+ * "Platform": "Linux/UNIX",
65
+ * "Recurrence": {
66
+ * "Frequency": "Weekly",
67
+ * "Interval": 1,
68
+ * "OccurrenceDaySet": [
69
+ * 1
70
+ * ],
71
+ * "OccurrenceRelativeToEnd": false,
72
+ * "OccurrenceUnit": ""
73
+ * },
74
+ * "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012",
75
+ * "SlotDurationInHours": 32,
76
+ * "TermEndDate": "2017-01-31T09:00:00Z",
77
+ * "TermStartDate": "2016-01-31T09:00:00Z",
78
+ * "TotalScheduledInstanceHours": 1696
79
+ * }
80
+ * ]
81
+ * }
82
+ * *\/
83
+ * // example id: ec2-purchase-scheduled-instances-1
84
+ * ```
85
+ *
40
86
  */
41
87
  export declare class PurchaseScheduledInstancesCommand extends $Command<PurchaseScheduledInstancesCommandInput, PurchaseScheduledInstancesCommandOutput, EC2ClientResolvedConfig> {
42
88
  readonly input: PurchaseScheduledInstancesCommandInput;
@@ -36,6 +36,19 @@ export interface RebootInstancesCommandOutput extends __MetadataBearer {
36
36
  * @see {@link RebootInstancesCommandOutput} for command's `response` shape.
37
37
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
38
38
  *
39
+ * @example To reboot an EC2 instance
40
+ * ```javascript
41
+ * // This example reboots the specified EC2 instance.
42
+ * const input = {
43
+ * "InstanceIds": [
44
+ * "i-1234567890abcdef5"
45
+ * ]
46
+ * };
47
+ * const command = new RebootInstancesCommand(input);
48
+ * await client.send(command);
49
+ * // example id: to-reboot-an-ec2-instance-1529358566382
50
+ * ```
51
+ *
39
52
  */
40
53
  export declare class RebootInstancesCommand extends $Command<RebootInstancesCommandInput, RebootInstancesCommandOutput, EC2ClientResolvedConfig> {
41
54
  readonly input: RebootInstancesCommandInput;