@aws-sdk/client-ec2 3.287.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
@@ -35,6 +35,57 @@ export interface DescribeSpotFleetRequestHistoryCommandOutput extends DescribeSp
35
35
  * @see {@link DescribeSpotFleetRequestHistoryCommandOutput} for command's `response` shape.
36
36
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
37
37
  *
38
+ * @example To describe Spot fleet history
39
+ * ```javascript
40
+ * // This example returns the history for the specified Spot fleet starting at the specified time.
41
+ * const input = {
42
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE",
43
+ * "StartTime": "2015-05-26T00:00:00Z"
44
+ * };
45
+ * const command = new DescribeSpotFleetRequestHistoryCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "HistoryRecords": [
50
+ * {
51
+ * "EventInformation": {
52
+ * "EventSubType": "submitted"
53
+ * },
54
+ * "EventType": "fleetRequestChange",
55
+ * "Timestamp": "2015-05-26T23:17:20.697Z"
56
+ * },
57
+ * {
58
+ * "EventInformation": {
59
+ * "EventSubType": "active"
60
+ * },
61
+ * "EventType": "fleetRequestChange",
62
+ * "Timestamp": "2015-05-26T23:17:20.873Z"
63
+ * },
64
+ * {
65
+ * "EventInformation": {
66
+ * "EventSubType": "launched",
67
+ * "InstanceId": "i-1234567890abcdef0"
68
+ * },
69
+ * "EventType": "instanceChange",
70
+ * "Timestamp": "2015-05-26T23:21:21.712Z"
71
+ * },
72
+ * {
73
+ * "EventInformation": {
74
+ * "EventSubType": "launched",
75
+ * "InstanceId": "i-1234567890abcdef1"
76
+ * },
77
+ * "EventType": "instanceChange",
78
+ * "Timestamp": "2015-05-26T23:21:21.816Z"
79
+ * }
80
+ * ],
81
+ * "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=",
82
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE",
83
+ * "StartTime": "2015-05-26T00:00:00Z"
84
+ * }
85
+ * *\/
86
+ * // example id: ec2-describe-spot-fleet-request-history-1
87
+ * ```
88
+ *
38
89
  */
39
90
  export declare class DescribeSpotFleetRequestHistoryCommand extends $Command<DescribeSpotFleetRequestHistoryCommandInput, DescribeSpotFleetRequestHistoryCommandOutput, EC2ClientResolvedConfig> {
40
91
  readonly input: DescribeSpotFleetRequestHistoryCommandInput;
@@ -31,6 +31,64 @@ export interface DescribeSpotFleetRequestsCommandOutput extends DescribeSpotFlee
31
31
  * @see {@link DescribeSpotFleetRequestsCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To describe a Spot fleet request
35
+ * ```javascript
36
+ * // This example describes the specified Spot fleet request.
37
+ * const input = {
38
+ * "SpotFleetRequestIds": [
39
+ * "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
40
+ * ]
41
+ * };
42
+ * const command = new DescribeSpotFleetRequestsCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "SpotFleetRequestConfigs": [
47
+ * {
48
+ * "SpotFleetRequestConfig": {
49
+ * "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role",
50
+ * "LaunchSpecifications": [
51
+ * {
52
+ * "EbsOptimized": false,
53
+ * "ImageId": "ami-1a2b3c4d",
54
+ * "InstanceType": "cc2.8xlarge",
55
+ * "NetworkInterfaces": [
56
+ * {
57
+ * "AssociatePublicIpAddress": true,
58
+ * "DeleteOnTermination": false,
59
+ * "DeviceIndex": 0,
60
+ * "SecondaryPrivateIpAddressCount": 0,
61
+ * "SubnetId": "subnet-a61dafcf"
62
+ * }
63
+ * ]
64
+ * },
65
+ * {
66
+ * "EbsOptimized": false,
67
+ * "ImageId": "ami-1a2b3c4d",
68
+ * "InstanceType": "r3.8xlarge",
69
+ * "NetworkInterfaces": [
70
+ * {
71
+ * "AssociatePublicIpAddress": true,
72
+ * "DeleteOnTermination": false,
73
+ * "DeviceIndex": 0,
74
+ * "SecondaryPrivateIpAddressCount": 0,
75
+ * "SubnetId": "subnet-a61dafcf"
76
+ * }
77
+ * ]
78
+ * }
79
+ * ],
80
+ * "SpotPrice": "0.05",
81
+ * "TargetCapacity": 20
82
+ * },
83
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE",
84
+ * "SpotFleetRequestState": "active"
85
+ * }
86
+ * ]
87
+ * }
88
+ * *\/
89
+ * // example id: ec2-describe-spot-fleet-requests-1
90
+ * ```
91
+ *
34
92
  */
35
93
  export declare class DescribeSpotFleetRequestsCommand extends $Command<DescribeSpotFleetRequestsCommandInput, DescribeSpotFleetRequestsCommandOutput, EC2ClientResolvedConfig> {
36
94
  readonly input: DescribeSpotFleetRequestsCommandInput;
@@ -44,6 +44,62 @@ export interface DescribeSpotInstanceRequestsCommandOutput extends DescribeSpotI
44
44
  * @see {@link DescribeSpotInstanceRequestsCommandOutput} for command's `response` shape.
45
45
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
46
46
  *
47
+ * @example To describe a Spot Instance request
48
+ * ```javascript
49
+ * // This example describes the specified Spot Instance request.
50
+ * const input = {
51
+ * "SpotInstanceRequestIds": [
52
+ * "sir-08b93456"
53
+ * ]
54
+ * };
55
+ * const command = new DescribeSpotInstanceRequestsCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "SpotInstanceRequests": [
60
+ * {
61
+ * "CreateTime": "2014-04-30T18:14:55.000Z",
62
+ * "InstanceId": "i-1234567890abcdef0",
63
+ * "LaunchSpecification": {
64
+ * "BlockDeviceMappings": [
65
+ * {
66
+ * "DeviceName": "/dev/sda1",
67
+ * "Ebs": {
68
+ * "DeleteOnTermination": true,
69
+ * "VolumeSize": 8,
70
+ * "VolumeType": "standard"
71
+ * }
72
+ * }
73
+ * ],
74
+ * "EbsOptimized": false,
75
+ * "ImageId": "ami-7aba833f",
76
+ * "InstanceType": "m1.small",
77
+ * "KeyName": "my-key-pair",
78
+ * "SecurityGroups": [
79
+ * {
80
+ * "GroupId": "sg-e38f24a7",
81
+ * "GroupName": "my-security-group"
82
+ * }
83
+ * ]
84
+ * },
85
+ * "LaunchedAvailabilityZone": "us-west-1b",
86
+ * "ProductDescription": "Linux/UNIX",
87
+ * "SpotInstanceRequestId": "sir-08b93456",
88
+ * "SpotPrice": "0.010000",
89
+ * "State": "active",
90
+ * "Status": {
91
+ * "Code": "fulfilled",
92
+ * "Message": "Your Spot request is fulfilled.",
93
+ * "UpdateTime": "2014-04-30T18:16:21.000Z"
94
+ * },
95
+ * "Type": "one-time"
96
+ * }
97
+ * ]
98
+ * }
99
+ * *\/
100
+ * // example id: ec2-describe-spot-instance-requests-1
101
+ * ```
102
+ *
47
103
  */
48
104
  export declare class DescribeSpotInstanceRequestsCommand extends $Command<DescribeSpotInstanceRequestsCommandInput, DescribeSpotInstanceRequestsCommandOutput, EC2ClientResolvedConfig> {
49
105
  readonly input: DescribeSpotInstanceRequestsCommandInput;
@@ -33,6 +33,44 @@ export interface DescribeSpotPriceHistoryCommandOutput extends DescribeSpotPrice
33
33
  * @see {@link DescribeSpotPriceHistoryCommandOutput} for command's `response` shape.
34
34
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
35
35
  *
36
+ * @example To describe Spot price history for Linux/UNIX (Amazon VPC)
37
+ * ```javascript
38
+ * // This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.
39
+ * const input = {
40
+ * "EndTime": "2014-01-06T08:09:10",
41
+ * "InstanceTypes": [
42
+ * "m1.xlarge"
43
+ * ],
44
+ * "ProductDescriptions": [
45
+ * "Linux/UNIX (Amazon VPC)"
46
+ * ],
47
+ * "StartTime": "2014-01-06T07:08:09"
48
+ * };
49
+ * const command = new DescribeSpotPriceHistoryCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "SpotPriceHistory": [
54
+ * {
55
+ * "AvailabilityZone": "us-west-1a",
56
+ * "InstanceType": "m1.xlarge",
57
+ * "ProductDescription": "Linux/UNIX (Amazon VPC)",
58
+ * "SpotPrice": "0.080000",
59
+ * "Timestamp": "2014-01-06T04:32:53.000Z"
60
+ * },
61
+ * {
62
+ * "AvailabilityZone": "us-west-1c",
63
+ * "InstanceType": "m1.xlarge",
64
+ * "ProductDescription": "Linux/UNIX (Amazon VPC)",
65
+ * "SpotPrice": "0.080000",
66
+ * "Timestamp": "2014-01-05T11:28:26.000Z"
67
+ * }
68
+ * ]
69
+ * }
70
+ * *\/
71
+ * // example id: ec2-describe-spot-price-history-1
72
+ * ```
73
+ *
36
74
  */
37
75
  export declare class DescribeSpotPriceHistoryCommand extends $Command<DescribeSpotPriceHistoryCommandInput, DescribeSpotPriceHistoryCommandOutput, EC2ClientResolvedConfig> {
38
76
  readonly input: DescribeSpotPriceHistoryCommandInput;
@@ -31,6 +31,40 @@ export interface DescribeSubnetsCommandOutput extends DescribeSubnetsResult, __M
31
31
  * @see {@link DescribeSubnetsCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To describe the subnets for a VPC
35
+ * ```javascript
36
+ * // This example describes the subnets for the specified VPC.
37
+ * const input = {
38
+ * "Filters": [
39
+ * {
40
+ * "Name": "vpc-id",
41
+ * "Values": [
42
+ * "vpc-a01106c2"
43
+ * ]
44
+ * }
45
+ * ]
46
+ * };
47
+ * const command = new DescribeSubnetsCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "Subnets": [
52
+ * {
53
+ * "AvailabilityZone": "us-east-1c",
54
+ * "AvailableIpAddressCount": 251,
55
+ * "CidrBlock": "10.0.1.0/24",
56
+ * "DefaultForAz": false,
57
+ * "MapPublicIpOnLaunch": false,
58
+ * "State": "available",
59
+ * "SubnetId": "subnet-9d4a7b6c",
60
+ * "VpcId": "vpc-a01106c2"
61
+ * }
62
+ * ]
63
+ * }
64
+ * *\/
65
+ * // example id: ec2-describe-subnets-1
66
+ * ```
67
+ *
34
68
  */
35
69
  export declare class DescribeSubnetsCommand extends $Command<DescribeSubnetsCommandInput, DescribeSubnetsCommandOutput, EC2ClientResolvedConfig> {
36
70
  readonly input: DescribeSubnetsCommandInput;
@@ -31,6 +31,42 @@ export interface DescribeTagsCommandOutput extends DescribeTagsResult, __Metadat
31
31
  * @see {@link DescribeTagsCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To describe the tags for a single resource
35
+ * ```javascript
36
+ * // This example describes the tags for the specified instance.
37
+ * const input = {
38
+ * "Filters": [
39
+ * {
40
+ * "Name": "resource-id",
41
+ * "Values": [
42
+ * "i-1234567890abcdef8"
43
+ * ]
44
+ * }
45
+ * ]
46
+ * };
47
+ * const command = new DescribeTagsCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "Tags": [
52
+ * {
53
+ * "Key": "Stack",
54
+ * "ResourceId": "i-1234567890abcdef8",
55
+ * "ResourceType": "instance",
56
+ * "Value": "test"
57
+ * },
58
+ * {
59
+ * "Key": "Name",
60
+ * "ResourceId": "i-1234567890abcdef8",
61
+ * "ResourceType": "instance",
62
+ * "Value": "Beta Server"
63
+ * }
64
+ * ]
65
+ * }
66
+ * *\/
67
+ * // example id: ec2-describe-tags-1
68
+ * ```
69
+ *
34
70
  */
35
71
  export declare class DescribeTagsCommand extends $Command<DescribeTagsCommandInput, DescribeTagsCommandOutput, EC2ClientResolvedConfig> {
36
72
  readonly input: DescribeTagsCommandInput;
@@ -31,6 +31,26 @@ export interface DescribeVolumeAttributeCommandOutput extends DescribeVolumeAttr
31
31
  * @see {@link DescribeVolumeAttributeCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To describe a volume attribute
35
+ * ```javascript
36
+ * // This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.
37
+ * const input = {
38
+ * "Attribute": "autoEnableIO",
39
+ * "VolumeId": "vol-049df61146c4d7901"
40
+ * };
41
+ * const command = new DescribeVolumeAttributeCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "AutoEnableIO": {
46
+ * "Value": false
47
+ * },
48
+ * "VolumeId": "vol-049df61146c4d7901"
49
+ * }
50
+ * *\/
51
+ * // example id: to-describe-a-volume-attribute-1472505773492
52
+ * ```
53
+ *
34
54
  */
35
55
  export declare class DescribeVolumeAttributeCommand extends $Command<DescribeVolumeAttributeCommandInput, DescribeVolumeAttributeCommandOutput, EC2ClientResolvedConfig> {
36
56
  readonly input: DescribeVolumeAttributeCommandInput;
@@ -63,6 +63,67 @@ export interface DescribeVolumeStatusCommandOutput extends DescribeVolumeStatusR
63
63
  * @see {@link DescribeVolumeStatusCommandOutput} for command's `response` shape.
64
64
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
65
65
  *
66
+ * @example To describe the status of a single volume
67
+ * ```javascript
68
+ * // This example describes the status for the volume ``vol-1234567890abcdef0``.
69
+ * const input = {
70
+ * "VolumeIds": [
71
+ * "vol-1234567890abcdef0"
72
+ * ]
73
+ * };
74
+ * const command = new DescribeVolumeStatusCommand(input);
75
+ * const response = await client.send(command);
76
+ * /* response ==
77
+ * {
78
+ * "VolumeStatuses": [
79
+ * {
80
+ * "Actions": [],
81
+ * "AvailabilityZone": "us-east-1a",
82
+ * "Events": [],
83
+ * "VolumeId": "vol-1234567890abcdef0",
84
+ * "VolumeStatus": {
85
+ * "Details": [
86
+ * {
87
+ * "Name": "io-enabled",
88
+ * "Status": "passed"
89
+ * },
90
+ * {
91
+ * "Name": "io-performance",
92
+ * "Status": "not-applicable"
93
+ * }
94
+ * ],
95
+ * "Status": "ok"
96
+ * }
97
+ * }
98
+ * ]
99
+ * }
100
+ * *\/
101
+ * // example id: to-describe-the-status-of-a-single-volume-1472507016193
102
+ * ```
103
+ *
104
+ * @example To describe the status of impaired volumes
105
+ * ```javascript
106
+ * // This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.
107
+ * const input = {
108
+ * "Filters": [
109
+ * {
110
+ * "Name": "volume-status.status",
111
+ * "Values": [
112
+ * "impaired"
113
+ * ]
114
+ * }
115
+ * ]
116
+ * };
117
+ * const command = new DescribeVolumeStatusCommand(input);
118
+ * const response = await client.send(command);
119
+ * /* response ==
120
+ * {
121
+ * "VolumeStatuses": []
122
+ * }
123
+ * *\/
124
+ * // example id: to-describe-the-status-of-impaired-volumes-1472507239821
125
+ * ```
126
+ *
66
127
  */
67
128
  export declare class DescribeVolumeStatusCommand extends $Command<DescribeVolumeStatusCommandInput, DescribeVolumeStatusCommandOutput, EC2ClientResolvedConfig> {
68
129
  readonly input: DescribeVolumeStatusCommandInput;
@@ -32,6 +32,90 @@ export interface DescribeVolumesCommandOutput extends DescribeVolumesResult, __M
32
32
  * @see {@link DescribeVolumesCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To describe all volumes
36
+ * ```javascript
37
+ * // This example describes all of your volumes in the default region.
38
+ * const input = {};
39
+ * const command = new DescribeVolumesCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "NextToken": "",
44
+ * "Volumes": [
45
+ * {
46
+ * "Attachments": [
47
+ * {
48
+ * "AttachTime": "2013-12-18T22:35:00.000Z",
49
+ * "DeleteOnTermination": true,
50
+ * "Device": "/dev/sda1",
51
+ * "InstanceId": "i-1234567890abcdef0",
52
+ * "State": "attached",
53
+ * "VolumeId": "vol-049df61146c4d7901"
54
+ * }
55
+ * ],
56
+ * "AvailabilityZone": "us-east-1a",
57
+ * "CreateTime": "2013-12-18T22:35:00.084Z",
58
+ * "Size": 8,
59
+ * "SnapshotId": "snap-1234567890abcdef0",
60
+ * "State": "in-use",
61
+ * "VolumeId": "vol-049df61146c4d7901",
62
+ * "VolumeType": "standard"
63
+ * }
64
+ * ]
65
+ * }
66
+ * *\/
67
+ * // example id: to-describe-all-volumes-1472506358883
68
+ * ```
69
+ *
70
+ * @example To describe volumes that are attached to a specific instance
71
+ * ```javascript
72
+ * // This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.
73
+ * const input = {
74
+ * "Filters": [
75
+ * {
76
+ * "Name": "attachment.instance-id",
77
+ * "Values": [
78
+ * "i-1234567890abcdef0"
79
+ * ]
80
+ * },
81
+ * {
82
+ * "Name": "attachment.delete-on-termination",
83
+ * "Values": [
84
+ * "true"
85
+ * ]
86
+ * }
87
+ * ]
88
+ * };
89
+ * const command = new DescribeVolumesCommand(input);
90
+ * const response = await client.send(command);
91
+ * /* response ==
92
+ * {
93
+ * "Volumes": [
94
+ * {
95
+ * "Attachments": [
96
+ * {
97
+ * "AttachTime": "2013-12-18T22:35:00.000Z",
98
+ * "DeleteOnTermination": true,
99
+ * "Device": "/dev/sda1",
100
+ * "InstanceId": "i-1234567890abcdef0",
101
+ * "State": "attached",
102
+ * "VolumeId": "vol-049df61146c4d7901"
103
+ * }
104
+ * ],
105
+ * "AvailabilityZone": "us-east-1a",
106
+ * "CreateTime": "2013-12-18T22:35:00.084Z",
107
+ * "Size": 8,
108
+ * "SnapshotId": "snap-1234567890abcdef0",
109
+ * "State": "in-use",
110
+ * "VolumeId": "vol-049df61146c4d7901",
111
+ * "VolumeType": "standard"
112
+ * }
113
+ * ]
114
+ * }
115
+ * *\/
116
+ * // example id: to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578
117
+ * ```
118
+ *
35
119
  */
36
120
  export declare class DescribeVolumesCommand extends $Command<DescribeVolumesCommandInput, DescribeVolumesCommandOutput, EC2ClientResolvedConfig> {
37
121
  readonly input: DescribeVolumesCommandInput;
@@ -29,6 +29,46 @@ export interface DescribeVpcAttributeCommandOutput extends DescribeVpcAttributeR
29
29
  * @see {@link DescribeVpcAttributeCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe the enableDnsSupport attribute
33
+ * ```javascript
34
+ * // This example describes 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 your instances to their corresponding IP addresses; otherwise, it does not.
35
+ * const input = {
36
+ * "Attribute": "enableDnsSupport",
37
+ * "VpcId": "vpc-a01106c2"
38
+ * };
39
+ * const command = new DescribeVpcAttributeCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "EnableDnsSupport": {
44
+ * "Value": true
45
+ * },
46
+ * "VpcId": "vpc-a01106c2"
47
+ * }
48
+ * *\/
49
+ * // example id: ec2-describe-vpc-attribute-1
50
+ * ```
51
+ *
52
+ * @example To describe the enableDnsHostnames attribute
53
+ * ```javascript
54
+ * // This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
55
+ * const input = {
56
+ * "Attribute": "enableDnsHostnames",
57
+ * "VpcId": "vpc-a01106c2"
58
+ * };
59
+ * const command = new DescribeVpcAttributeCommand(input);
60
+ * const response = await client.send(command);
61
+ * /* response ==
62
+ * {
63
+ * "EnableDnsHostnames": {
64
+ * "Value": true
65
+ * },
66
+ * "VpcId": "vpc-a01106c2"
67
+ * }
68
+ * *\/
69
+ * // example id: ec2-describe-vpc-attribute-2
70
+ * ```
71
+ *
32
72
  */
33
73
  export declare class DescribeVpcAttributeCommand extends $Command<DescribeVpcAttributeCommandInput, DescribeVpcAttributeCommandOutput, EC2ClientResolvedConfig> {
34
74
  readonly input: DescribeVpcAttributeCommandInput;
@@ -29,6 +29,39 @@ export interface DescribeVpcsCommandOutput extends DescribeVpcsResult, __Metadat
29
29
  * @see {@link DescribeVpcsCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe a VPC
33
+ * ```javascript
34
+ * // This example describes the specified VPC.
35
+ * const input = {
36
+ * "VpcIds": [
37
+ * "vpc-a01106c2"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeVpcsCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "Vpcs": [
45
+ * {
46
+ * "CidrBlock": "10.0.0.0/16",
47
+ * "DhcpOptionsId": "dopt-7a8b9c2d",
48
+ * "InstanceTenancy": "default",
49
+ * "IsDefault": false,
50
+ * "State": "available",
51
+ * "Tags": [
52
+ * {
53
+ * "Key": "Name",
54
+ * "Value": "MyVPC"
55
+ * }
56
+ * ],
57
+ * "VpcId": "vpc-a01106c2"
58
+ * }
59
+ * ]
60
+ * }
61
+ * *\/
62
+ * // example id: ec2-describe-vpcs-1
63
+ * ```
64
+ *
32
65
  */
33
66
  export declare class DescribeVpcsCommand extends $Command<DescribeVpcsCommandInput, DescribeVpcsCommandOutput, EC2ClientResolvedConfig> {
34
67
  readonly input: DescribeVpcsCommandInput;
@@ -31,6 +31,18 @@ export interface DetachInternetGatewayCommandOutput extends __MetadataBearer {
31
31
  * @see {@link DetachInternetGatewayCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To detach an Internet gateway from a VPC
35
+ * ```javascript
36
+ * // This example detaches the specified Internet gateway from the specified VPC.
37
+ * const input = {
38
+ * "InternetGatewayId": "igw-c0a643a9",
39
+ * "VpcId": "vpc-a01106c2"
40
+ * };
41
+ * const command = new DetachInternetGatewayCommand(input);
42
+ * await client.send(command);
43
+ * // example id: ec2-detach-internet-gateway-1
44
+ * ```
45
+ *
34
46
  */
35
47
  export declare class DetachInternetGatewayCommand extends $Command<DetachInternetGatewayCommandInput, DetachInternetGatewayCommandOutput, EC2ClientResolvedConfig> {
36
48
  readonly input: DetachInternetGatewayCommandInput;
@@ -29,6 +29,17 @@ export interface DetachNetworkInterfaceCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DetachNetworkInterfaceCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To detach a network interface from an instance
33
+ * ```javascript
34
+ * // This example detaches the specified network interface from its attached instance.
35
+ * const input = {
36
+ * "AttachmentId": "eni-attach-66c4350a"
37
+ * };
38
+ * const command = new DetachNetworkInterfaceCommand(input);
39
+ * await client.send(command);
40
+ * // example id: ec2-detach-network-interface-1
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DetachNetworkInterfaceCommand extends $Command<DetachNetworkInterfaceCommandInput, DetachNetworkInterfaceCommandOutput, EC2ClientResolvedConfig> {
34
45
  readonly input: DetachNetworkInterfaceCommandInput;
@@ -40,6 +40,26 @@ export interface DetachVolumeCommandOutput extends VolumeAttachment, __MetadataB
40
40
  * @see {@link DetachVolumeCommandOutput} for command's `response` shape.
41
41
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
42
42
  *
43
+ * @example To detach a volume from an instance
44
+ * ```javascript
45
+ * // This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.
46
+ * const input = {
47
+ * "VolumeId": "vol-1234567890abcdef0"
48
+ * };
49
+ * const command = new DetachVolumeCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "AttachTime": "2014-02-27T19:23:06.000Z",
54
+ * "Device": "/dev/sdb",
55
+ * "InstanceId": "i-1234567890abcdef0",
56
+ * "State": "detaching",
57
+ * "VolumeId": "vol-049df61146c4d7901"
58
+ * }
59
+ * *\/
60
+ * // example id: to-detach-a-volume-from-an-instance-1472507977694
61
+ * ```
62
+ *
43
63
  */
44
64
  export declare class DetachVolumeCommand extends $Command<DetachVolumeCommandInput, DetachVolumeCommandOutput, EC2ClientResolvedConfig> {
45
65
  readonly input: DetachVolumeCommandInput;
@@ -30,6 +30,18 @@ export interface DisableVgwRoutePropagationCommandOutput extends __MetadataBeare
30
30
  * @see {@link DisableVgwRoutePropagationCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To disable route propagation
34
+ * ```javascript
35
+ * // This example disables the specified virtual private gateway from propagating static routes to the specified route table.
36
+ * const input = {
37
+ * "GatewayId": "vgw-9a4cacf3",
38
+ * "RouteTableId": "rtb-22574640"
39
+ * };
40
+ * const command = new DisableVgwRoutePropagationCommand(input);
41
+ * await client.send(command);
42
+ * // example id: ec2-disable-vgw-route-propagation-1
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class DisableVgwRoutePropagationCommand extends $Command<DisableVgwRoutePropagationCommandInput, DisableVgwRoutePropagationCommandOutput, EC2ClientResolvedConfig> {
35
47
  readonly input: DisableVgwRoutePropagationCommandInput;