@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
@@ -31,6 +31,54 @@ export interface DescribeNetworkAclsCommandOutput extends DescribeNetworkAclsRes
31
31
  * @see {@link DescribeNetworkAclsCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To describe a network ACL
35
+ * ```javascript
36
+ * // This example describes the specified network ACL.
37
+ * const input = {
38
+ * "NetworkAclIds": [
39
+ * "acl-5fb85d36"
40
+ * ]
41
+ * };
42
+ * const command = new DescribeNetworkAclsCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "NetworkAcls": [
47
+ * {
48
+ * "Associations": [
49
+ * {
50
+ * "NetworkAclAssociationId": "aclassoc-66ea5f0b",
51
+ * "NetworkAclId": "acl-9aeb5ef7",
52
+ * "SubnetId": "subnet-65ea5f08"
53
+ * }
54
+ * ],
55
+ * "Entries": [
56
+ * {
57
+ * "CidrBlock": "0.0.0.0/0",
58
+ * "Egress": true,
59
+ * "Protocol": "-1",
60
+ * "RuleAction": "deny",
61
+ * "RuleNumber": 32767
62
+ * },
63
+ * {
64
+ * "CidrBlock": "0.0.0.0/0",
65
+ * "Egress": false,
66
+ * "Protocol": "-1",
67
+ * "RuleAction": "deny",
68
+ * "RuleNumber": 32767
69
+ * }
70
+ * ],
71
+ * "IsDefault": false,
72
+ * "NetworkAclId": "acl-5fb85d36",
73
+ * "Tags": [],
74
+ * "VpcId": "vpc-a01106c2"
75
+ * }
76
+ * ]
77
+ * }
78
+ * *\/
79
+ * // example id: ec2-
80
+ * ```
81
+ *
34
82
  */
35
83
  export declare class DescribeNetworkAclsCommand extends $Command<DescribeNetworkAclsCommandInput, DescribeNetworkAclsCommandOutput, EC2ClientResolvedConfig> {
36
84
  readonly input: DescribeNetworkAclsCommandInput;
@@ -29,6 +29,95 @@ export interface DescribeNetworkInterfaceAttributeCommandOutput extends Describe
29
29
  * @see {@link DescribeNetworkInterfaceAttributeCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe the attachment attribute of a network interface
33
+ * ```javascript
34
+ * // This example describes the attachment attribute of the specified network interface.
35
+ * const input = {
36
+ * "Attribute": "attachment",
37
+ * "NetworkInterfaceId": "eni-686ea200"
38
+ * };
39
+ * const command = new DescribeNetworkInterfaceAttributeCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Attachment": {
44
+ * "AttachTime": "2015-05-21T20:02:20.000Z",
45
+ * "AttachmentId": "eni-attach-43348162",
46
+ * "DeleteOnTermination": true,
47
+ * "DeviceIndex": 0,
48
+ * "InstanceId": "i-1234567890abcdef0",
49
+ * "InstanceOwnerId": "123456789012",
50
+ * "Status": "attached"
51
+ * },
52
+ * "NetworkInterfaceId": "eni-686ea200"
53
+ * }
54
+ * *\/
55
+ * // example id: ec2-describe-network-interface-attribute-1
56
+ * ```
57
+ *
58
+ * @example To describe the description attribute of a network interface
59
+ * ```javascript
60
+ * // This example describes the description attribute of the specified network interface.
61
+ * const input = {
62
+ * "Attribute": "description",
63
+ * "NetworkInterfaceId": "eni-686ea200"
64
+ * };
65
+ * const command = new DescribeNetworkInterfaceAttributeCommand(input);
66
+ * const response = await client.send(command);
67
+ * /* response ==
68
+ * {
69
+ * "Description": {
70
+ * "Value": "My description"
71
+ * },
72
+ * "NetworkInterfaceId": "eni-686ea200"
73
+ * }
74
+ * *\/
75
+ * // example id: ec2-describe-network-interface-attribute-2
76
+ * ```
77
+ *
78
+ * @example To describe the groupSet attribute of a network interface
79
+ * ```javascript
80
+ * // This example describes the groupSet attribute of the specified network interface.
81
+ * const input = {
82
+ * "Attribute": "groupSet",
83
+ * "NetworkInterfaceId": "eni-686ea200"
84
+ * };
85
+ * const command = new DescribeNetworkInterfaceAttributeCommand(input);
86
+ * const response = await client.send(command);
87
+ * /* response ==
88
+ * {
89
+ * "Groups": [
90
+ * {
91
+ * "GroupId": "sg-903004f8",
92
+ * "GroupName": "my-security-group"
93
+ * }
94
+ * ],
95
+ * "NetworkInterfaceId": "eni-686ea200"
96
+ * }
97
+ * *\/
98
+ * // example id: ec2-describe-network-interface-attribute-3
99
+ * ```
100
+ *
101
+ * @example To describe the sourceDestCheck attribute of a network interface
102
+ * ```javascript
103
+ * // This example describes the sourceDestCheck attribute of the specified network interface.
104
+ * const input = {
105
+ * "Attribute": "sourceDestCheck",
106
+ * "NetworkInterfaceId": "eni-686ea200"
107
+ * };
108
+ * const command = new DescribeNetworkInterfaceAttributeCommand(input);
109
+ * const response = await client.send(command);
110
+ * /* response ==
111
+ * {
112
+ * "NetworkInterfaceId": "eni-686ea200",
113
+ * "SourceDestCheck": {
114
+ * "Value": true
115
+ * }
116
+ * }
117
+ * *\/
118
+ * // example id: ec2-describe-network-interface-attribute-4
119
+ * ```
120
+ *
32
121
  */
33
122
  export declare class DescribeNetworkInterfaceAttributeCommand extends $Command<DescribeNetworkInterfaceAttributeCommandInput, DescribeNetworkInterfaceAttributeCommandOutput, EC2ClientResolvedConfig> {
34
123
  readonly input: DescribeNetworkInterfaceAttributeCommandInput;
@@ -29,6 +29,74 @@ export interface DescribeNetworkInterfacesCommandOutput extends DescribeNetworkI
29
29
  * @see {@link DescribeNetworkInterfacesCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe a network interface
33
+ * ```javascript
34
+ * //
35
+ * const input = {
36
+ * "NetworkInterfaceIds": [
37
+ * "eni-e5aa89a3"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeNetworkInterfacesCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "NetworkInterfaces": [
45
+ * {
46
+ * "Association": {
47
+ * "AssociationId": "eipassoc-0fbb766a",
48
+ * "IpOwnerId": "123456789012",
49
+ * "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com",
50
+ * "PublicIp": "203.0.113.12"
51
+ * },
52
+ * "Attachment": {
53
+ * "AttachTime": "2013-11-30T23:36:42.000Z",
54
+ * "AttachmentId": "eni-attach-66c4350a",
55
+ * "DeleteOnTermination": false,
56
+ * "DeviceIndex": 1,
57
+ * "InstanceId": "i-1234567890abcdef0",
58
+ * "InstanceOwnerId": "123456789012",
59
+ * "Status": "attached"
60
+ * },
61
+ * "AvailabilityZone": "us-east-1d",
62
+ * "Description": "my network interface",
63
+ * "Groups": [
64
+ * {
65
+ * "GroupId": "sg-8637d3e3",
66
+ * "GroupName": "default"
67
+ * }
68
+ * ],
69
+ * "MacAddress": "02:2f:8f:b0:cf:75",
70
+ * "NetworkInterfaceId": "eni-e5aa89a3",
71
+ * "OwnerId": "123456789012",
72
+ * "PrivateDnsName": "ip-10-0-1-17.ec2.internal",
73
+ * "PrivateIpAddress": "10.0.1.17",
74
+ * "PrivateIpAddresses": [
75
+ * {
76
+ * "Association": {
77
+ * "AssociationId": "eipassoc-0fbb766a",
78
+ * "IpOwnerId": "123456789012",
79
+ * "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com",
80
+ * "PublicIp": "203.0.113.12"
81
+ * },
82
+ * "Primary": true,
83
+ * "PrivateDnsName": "ip-10-0-1-17.ec2.internal",
84
+ * "PrivateIpAddress": "10.0.1.17"
85
+ * }
86
+ * ],
87
+ * "RequesterManaged": false,
88
+ * "SourceDestCheck": true,
89
+ * "Status": "in-use",
90
+ * "SubnetId": "subnet-b61f49f0",
91
+ * "TagSet": [],
92
+ * "VpcId": "vpc-a01106c2"
93
+ * }
94
+ * ]
95
+ * }
96
+ * *\/
97
+ * // example id: ec2-describe-network-interfaces-1
98
+ * ```
99
+ *
32
100
  */
33
101
  export declare class DescribeNetworkInterfacesCommand extends $Command<DescribeNetworkInterfacesCommandInput, DescribeNetworkInterfacesCommandOutput, EC2ClientResolvedConfig> {
34
102
  readonly input: DescribeNetworkInterfacesCommandInput;
@@ -32,6 +32,65 @@ export interface DescribeRegionsCommandOutput extends DescribeRegionsResult, __M
32
32
  * @see {@link DescribeRegionsCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To describe your regions
36
+ * ```javascript
37
+ * // This example describes all the regions that are available to you.
38
+ * const input = undefined;
39
+ * const command = new DescribeRegionsCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "Regions": [
44
+ * {
45
+ * "Endpoint": "ec2.ap-south-1.amazonaws.com",
46
+ * "RegionName": "ap-south-1"
47
+ * },
48
+ * {
49
+ * "Endpoint": "ec2.eu-west-1.amazonaws.com",
50
+ * "RegionName": "eu-west-1"
51
+ * },
52
+ * {
53
+ * "Endpoint": "ec2.ap-southeast-1.amazonaws.com",
54
+ * "RegionName": "ap-southeast-1"
55
+ * },
56
+ * {
57
+ * "Endpoint": "ec2.ap-southeast-2.amazonaws.com",
58
+ * "RegionName": "ap-southeast-2"
59
+ * },
60
+ * {
61
+ * "Endpoint": "ec2.eu-central-1.amazonaws.com",
62
+ * "RegionName": "eu-central-1"
63
+ * },
64
+ * {
65
+ * "Endpoint": "ec2.ap-northeast-2.amazonaws.com",
66
+ * "RegionName": "ap-northeast-2"
67
+ * },
68
+ * {
69
+ * "Endpoint": "ec2.ap-northeast-1.amazonaws.com",
70
+ * "RegionName": "ap-northeast-1"
71
+ * },
72
+ * {
73
+ * "Endpoint": "ec2.us-east-1.amazonaws.com",
74
+ * "RegionName": "us-east-1"
75
+ * },
76
+ * {
77
+ * "Endpoint": "ec2.sa-east-1.amazonaws.com",
78
+ * "RegionName": "sa-east-1"
79
+ * },
80
+ * {
81
+ * "Endpoint": "ec2.us-west-1.amazonaws.com",
82
+ * "RegionName": "us-west-1"
83
+ * },
84
+ * {
85
+ * "Endpoint": "ec2.us-west-2.amazonaws.com",
86
+ * "RegionName": "us-west-2"
87
+ * }
88
+ * ]
89
+ * }
90
+ * *\/
91
+ * // example id: ec2-describe-regions-1
92
+ * ```
93
+ *
35
94
  */
36
95
  export declare class DescribeRegionsCommand extends $Command<DescribeRegionsCommandInput, DescribeRegionsCommandOutput, EC2ClientResolvedConfig> {
37
96
  readonly input: DescribeRegionsCommandInput;
@@ -32,6 +32,45 @@ export interface DescribeRouteTablesCommandOutput extends DescribeRouteTablesRes
32
32
  * @see {@link DescribeRouteTablesCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To describe a route table
36
+ * ```javascript
37
+ * // This example describes the specified route table.
38
+ * const input = {
39
+ * "RouteTableIds": [
40
+ * "rtb-1f382e7d"
41
+ * ]
42
+ * };
43
+ * const command = new DescribeRouteTablesCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "RouteTables": [
48
+ * {
49
+ * "Associations": [
50
+ * {
51
+ * "Main": true,
52
+ * "RouteTableAssociationId": "rtbassoc-d8ccddba",
53
+ * "RouteTableId": "rtb-1f382e7d"
54
+ * }
55
+ * ],
56
+ * "PropagatingVgws": [],
57
+ * "RouteTableId": "rtb-1f382e7d",
58
+ * "Routes": [
59
+ * {
60
+ * "DestinationCidrBlock": "10.0.0.0/16",
61
+ * "GatewayId": "local",
62
+ * "State": "active"
63
+ * }
64
+ * ],
65
+ * "Tags": [],
66
+ * "VpcId": "vpc-a01106c2"
67
+ * }
68
+ * ]
69
+ * }
70
+ * *\/
71
+ * // example id: ec2-describe-route-tables-1
72
+ * ```
73
+ *
35
74
  */
36
75
  export declare class DescribeRouteTablesCommand extends $Command<DescribeRouteTablesCommandInput, DescribeRouteTablesCommandOutput, EC2ClientResolvedConfig> {
37
76
  readonly input: DescribeRouteTablesCommandInput;
@@ -32,6 +32,55 @@ export interface DescribeScheduledInstanceAvailabilityCommandOutput extends Desc
32
32
  * @see {@link DescribeScheduledInstanceAvailabilityCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To describe an available schedule
36
+ * ```javascript
37
+ * // This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.
38
+ * const input = {
39
+ * "FirstSlotStartTimeRange": {
40
+ * "EarliestTime": "2016-01-31T00:00:00Z",
41
+ * "LatestTime": "2016-01-31T04:00:00Z"
42
+ * },
43
+ * "Recurrence": {
44
+ * "Frequency": "Weekly",
45
+ * "Interval": 1,
46
+ * "OccurrenceDays": [
47
+ * 1
48
+ * ]
49
+ * }
50
+ * };
51
+ * const command = new DescribeScheduledInstanceAvailabilityCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "ScheduledInstanceAvailabilitySet": [
56
+ * {
57
+ * "AvailabilityZone": "us-west-2b",
58
+ * "AvailableInstanceCount": 20,
59
+ * "FirstSlotStartTime": "2016-01-31T00:00:00Z",
60
+ * "HourlyPrice": "0.095",
61
+ * "InstanceType": "c4.large",
62
+ * "MaxTermDurationInDays": 366,
63
+ * "MinTermDurationInDays": 366,
64
+ * "NetworkPlatform": "EC2-VPC",
65
+ * "Platform": "Linux/UNIX",
66
+ * "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...",
67
+ * "Recurrence": {
68
+ * "Frequency": "Weekly",
69
+ * "Interval": 1,
70
+ * "OccurrenceDaySet": [
71
+ * 1
72
+ * ],
73
+ * "OccurrenceRelativeToEnd": false
74
+ * },
75
+ * "SlotDurationInHours": 23,
76
+ * "TotalScheduledInstanceHours": 1219
77
+ * }
78
+ * ]
79
+ * }
80
+ * *\/
81
+ * // example id: ec2-describe-scheduled-instance-availability-1
82
+ * ```
83
+ *
35
84
  */
36
85
  export declare class DescribeScheduledInstanceAvailabilityCommand extends $Command<DescribeScheduledInstanceAvailabilityCommandInput, DescribeScheduledInstanceAvailabilityCommandOutput, EC2ClientResolvedConfig> {
37
86
  readonly input: DescribeScheduledInstanceAvailabilityCommandInput;
@@ -29,6 +29,49 @@ export interface DescribeScheduledInstancesCommandOutput extends DescribeSchedul
29
29
  * @see {@link DescribeScheduledInstancesCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe your Scheduled Instances
33
+ * ```javascript
34
+ * // This example describes the specified Scheduled Instance.
35
+ * const input = {
36
+ * "ScheduledInstanceIds": [
37
+ * "sci-1234-1234-1234-1234-123456789012"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeScheduledInstancesCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ScheduledInstanceSet": [
45
+ * {
46
+ * "AvailabilityZone": "us-west-2b",
47
+ * "CreateDate": "2016-01-25T21:43:38.612Z",
48
+ * "HourlyPrice": "0.095",
49
+ * "InstanceCount": 1,
50
+ * "InstanceType": "c4.large",
51
+ * "NetworkPlatform": "EC2-VPC",
52
+ * "NextSlotStartTime": "2016-01-31T09:00:00Z",
53
+ * "Platform": "Linux/UNIX",
54
+ * "Recurrence": {
55
+ * "Frequency": "Weekly",
56
+ * "Interval": 1,
57
+ * "OccurrenceDaySet": [
58
+ * 1
59
+ * ],
60
+ * "OccurrenceRelativeToEnd": false,
61
+ * "OccurrenceUnit": ""
62
+ * },
63
+ * "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012",
64
+ * "SlotDurationInHours": 32,
65
+ * "TermEndDate": "2017-01-31T09:00:00Z",
66
+ * "TermStartDate": "2016-01-31T09:00:00Z",
67
+ * "TotalScheduledInstanceHours": 1696
68
+ * }
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: ec2-describe-scheduled-instances-1
73
+ * ```
74
+ *
32
75
  */
33
76
  export declare class DescribeScheduledInstancesCommand extends $Command<DescribeScheduledInstancesCommandInput, DescribeScheduledInstancesCommandOutput, EC2ClientResolvedConfig> {
34
77
  readonly input: DescribeScheduledInstancesCommandInput;
@@ -29,6 +29,30 @@ export interface DescribeSecurityGroupReferencesCommandOutput extends DescribeSe
29
29
  * @see {@link DescribeSecurityGroupReferencesCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe security group references
33
+ * ```javascript
34
+ * // This example describes the security group references for the specified security group.
35
+ * const input = {
36
+ * "GroupId": [
37
+ * "sg-903004f8"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeSecurityGroupReferencesCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "SecurityGroupReferenceSet": [
45
+ * {
46
+ * "GroupId": "sg-903004f8",
47
+ * "ReferencingVpcId": "vpc-1a2b3c4d",
48
+ * "VpcPeeringConnectionId": "pcx-b04deed9"
49
+ * }
50
+ * ]
51
+ * }
52
+ * *\/
53
+ * // example id: to-describe-security-group-references-1529354312088
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class DescribeSecurityGroupReferencesCommand extends $Command<DescribeSecurityGroupReferencesCommandInput, DescribeSecurityGroupReferencesCommandOutput, EC2ClientResolvedConfig> {
34
58
  readonly input: DescribeSecurityGroupReferencesCommandInput;
@@ -38,6 +38,37 @@ export interface DescribeSecurityGroupsCommandOutput extends DescribeSecurityGro
38
38
  * @see {@link DescribeSecurityGroupsCommandOutput} for command's `response` shape.
39
39
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
40
40
  *
41
+ * @example To describe a security group
42
+ * ```javascript
43
+ * // This example describes the specified security group.
44
+ * const input = {
45
+ * "GroupIds": [
46
+ * "sg-903004f8"
47
+ * ]
48
+ * };
49
+ * const command = new DescribeSecurityGroupsCommand(input);
50
+ * await client.send(command);
51
+ * // example id: to-describe-a-security-group-1529354426314
52
+ * ```
53
+ *
54
+ * @example To describe a tagged security group
55
+ * ```javascript
56
+ * // This example describes the security groups that include the specified tag (Purpose=test).
57
+ * const input = {
58
+ * "Filters": [
59
+ * {
60
+ * "Name": "tag:Purpose",
61
+ * "Values": [
62
+ * "test"
63
+ * ]
64
+ * }
65
+ * ]
66
+ * };
67
+ * const command = new DescribeSecurityGroupsCommand(input);
68
+ * await client.send(command);
69
+ * // example id: to-describe-a-tagged-security-group-1529354553880
70
+ * ```
71
+ *
41
72
  */
42
73
  export declare class DescribeSecurityGroupsCommand extends $Command<DescribeSecurityGroupsCommandInput, DescribeSecurityGroupsCommandOutput, EC2ClientResolvedConfig> {
43
74
  readonly input: DescribeSecurityGroupsCommandInput;
@@ -31,6 +31,24 @@ export interface DescribeSnapshotAttributeCommandOutput extends DescribeSnapshot
31
31
  * @see {@link DescribeSnapshotAttributeCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To describe snapshot attributes
35
+ * ```javascript
36
+ * // This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.
37
+ * const input = {
38
+ * "Attribute": "createVolumePermission",
39
+ * "SnapshotId": "snap-066877671789bd71b"
40
+ * };
41
+ * const command = new DescribeSnapshotAttributeCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "CreateVolumePermissions": [],
46
+ * "SnapshotId": "snap-066877671789bd71b"
47
+ * }
48
+ * *\/
49
+ * // example id: to-describe-snapshot-attributes-1472503199736
50
+ * ```
51
+ *
34
52
  */
35
53
  export declare class DescribeSnapshotAttributeCommand extends $Command<DescribeSnapshotAttributeCommandInput, DescribeSnapshotAttributeCommandOutput, EC2ClientResolvedConfig> {
36
54
  readonly input: DescribeSnapshotAttributeCommandInput;
@@ -71,6 +71,74 @@ export interface DescribeSnapshotsCommandOutput extends DescribeSnapshotsResult,
71
71
  * @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape.
72
72
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
73
73
  *
74
+ * @example To describe a snapshot
75
+ * ```javascript
76
+ * // This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.
77
+ * const input = {
78
+ * "SnapshotIds": [
79
+ * "snap-1234567890abcdef0"
80
+ * ]
81
+ * };
82
+ * const command = new DescribeSnapshotsCommand(input);
83
+ * const response = await client.send(command);
84
+ * /* response ==
85
+ * {
86
+ * "NextToken": "",
87
+ * "Snapshots": [
88
+ * {
89
+ * "Description": "This is my snapshot.",
90
+ * "OwnerId": "012345678910",
91
+ * "Progress": "100%",
92
+ * "SnapshotId": "snap-1234567890abcdef0",
93
+ * "StartTime": "2014-02-28T21:28:32.000Z",
94
+ * "State": "completed",
95
+ * "VolumeId": "vol-049df61146c4d7901",
96
+ * "VolumeSize": 8
97
+ * }
98
+ * ]
99
+ * }
100
+ * *\/
101
+ * // example id: to-describe-a-snapshot-1472503807850
102
+ * ```
103
+ *
104
+ * @example To describe snapshots using filters
105
+ * ```javascript
106
+ * // This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.
107
+ * const input = {
108
+ * "Filters": [
109
+ * {
110
+ * "Name": "status",
111
+ * "Values": [
112
+ * "pending"
113
+ * ]
114
+ * }
115
+ * ],
116
+ * "OwnerIds": [
117
+ * "012345678910"
118
+ * ]
119
+ * };
120
+ * const command = new DescribeSnapshotsCommand(input);
121
+ * const response = await client.send(command);
122
+ * /* response ==
123
+ * {
124
+ * "NextToken": "",
125
+ * "Snapshots": [
126
+ * {
127
+ * "Description": "This is my copied snapshot.",
128
+ * "OwnerId": "012345678910",
129
+ * "Progress": "87%",
130
+ * "SnapshotId": "snap-066877671789bd71b",
131
+ * "StartTime": "2014-02-28T21:37:27.000Z",
132
+ * "State": "pending",
133
+ * "VolumeId": "vol-1234567890abcdef0",
134
+ * "VolumeSize": 8
135
+ * }
136
+ * ]
137
+ * }
138
+ * *\/
139
+ * // example id: to-describe-snapshots-using-filters-1472503929793
140
+ * ```
141
+ *
74
142
  */
75
143
  export declare class DescribeSnapshotsCommand extends $Command<DescribeSnapshotsCommandInput, DescribeSnapshotsCommandOutput, EC2ClientResolvedConfig> {
76
144
  readonly input: DescribeSnapshotsCommandInput;
@@ -30,6 +30,25 @@ export interface DescribeSpotDatafeedSubscriptionCommandOutput extends DescribeS
30
30
  * @see {@link DescribeSpotDatafeedSubscriptionCommandOutput} for command's `response` shape.
31
31
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
32
32
  *
33
+ * @example To describe the datafeed for your AWS account
34
+ * ```javascript
35
+ * // This example describes the Spot Instance datafeed subscription for your AWS account.
36
+ * const input = undefined;
37
+ * const command = new DescribeSpotDatafeedSubscriptionCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "SpotDatafeedSubscription": {
42
+ * "Bucket": "my-s3-bucket",
43
+ * "OwnerId": "123456789012",
44
+ * "Prefix": "spotdata",
45
+ * "State": "Active"
46
+ * }
47
+ * }
48
+ * *\/
49
+ * // example id: ec2-describe-spot-datafeed-subscription-1
50
+ * ```
51
+ *
33
52
  */
34
53
  export declare class DescribeSpotDatafeedSubscriptionCommand extends $Command<DescribeSpotDatafeedSubscriptionCommandInput, DescribeSpotDatafeedSubscriptionCommandOutput, EC2ClientResolvedConfig> {
35
54
  readonly input: DescribeSpotDatafeedSubscriptionCommandInput;
@@ -29,6 +29,29 @@ export interface DescribeSpotFleetInstancesCommandOutput extends DescribeSpotFle
29
29
  * @see {@link DescribeSpotFleetInstancesCommandOutput} for command's `response` shape.
30
30
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
31
31
  *
32
+ * @example To describe the Spot Instances associated with a Spot fleet
33
+ * ```javascript
34
+ * // This example lists the Spot Instances associated with the specified Spot fleet.
35
+ * const input = {
36
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
37
+ * };
38
+ * const command = new DescribeSpotFleetInstancesCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "ActiveInstances": [
43
+ * {
44
+ * "InstanceId": "i-1234567890abcdef0",
45
+ * "InstanceType": "m3.medium",
46
+ * "SpotInstanceRequestId": "sir-08b93456"
47
+ * }
48
+ * ],
49
+ * "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
50
+ * }
51
+ * *\/
52
+ * // example id: ec2-describe-spot-fleet-instances-1
53
+ * ```
54
+ *
32
55
  */
33
56
  export declare class DescribeSpotFleetInstancesCommand extends $Command<DescribeSpotFleetInstancesCommandInput, DescribeSpotFleetInstancesCommandOutput, EC2ClientResolvedConfig> {
34
57
  readonly input: DescribeSpotFleetInstancesCommandInput;