@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
@@ -45,6 +45,37 @@ export interface CreateImageCommandOutput extends CreateImageResult, __MetadataB
45
45
  * @see {@link CreateImageCommandOutput} for command's `response` shape.
46
46
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
47
47
  *
48
+ * @example To create an AMI from an Amazon EBS-backed instance
49
+ * ```javascript
50
+ * // This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc.
51
+ * const input = {
52
+ * "BlockDeviceMappings": [
53
+ * {
54
+ * "DeviceName": "/dev/sdh",
55
+ * "Ebs": {
56
+ * "VolumeSize": "100"
57
+ * }
58
+ * },
59
+ * {
60
+ * "DeviceName": "/dev/sdc",
61
+ * "VirtualName": "ephemeral1"
62
+ * }
63
+ * ],
64
+ * "Description": "An AMI for my server",
65
+ * "InstanceId": "i-1234567890abcdef0",
66
+ * "Name": "My server",
67
+ * "NoReboot": true
68
+ * };
69
+ * const command = new CreateImageCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "ImageId": "ami-1a2b3c4d"
74
+ * }
75
+ * *\/
76
+ * // example id: to-create-an-ami-from-an-amazon-ebs-backed-instance-1529023150636
77
+ * ```
78
+ *
48
79
  */
49
80
  export declare class CreateImageCommand extends $Command<CreateImageCommandInput, CreateImageCommandOutput, EC2ClientResolvedConfig> {
50
81
  readonly input: CreateImageCommandInput;
@@ -31,6 +31,24 @@ export interface CreateInternetGatewayCommandOutput extends CreateInternetGatewa
31
31
  * @see {@link CreateInternetGatewayCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To create an Internet gateway
35
+ * ```javascript
36
+ * // This example creates an Internet gateway.
37
+ * const input = undefined;
38
+ * const command = new CreateInternetGatewayCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "InternetGateway": {
43
+ * "Attachments": [],
44
+ * "InternetGatewayId": "igw-c0a643a9",
45
+ * "Tags": []
46
+ * }
47
+ * }
48
+ * *\/
49
+ * // example id: ec2-create-internet-gateway-1
50
+ * ```
51
+ *
34
52
  */
35
53
  export declare class CreateInternetGatewayCommand extends $Command<CreateInternetGatewayCommandInput, CreateInternetGatewayCommandOutput, EC2ClientResolvedConfig> {
36
54
  readonly input: CreateInternetGatewayCommandInput;
@@ -39,6 +39,17 @@ export interface CreateKeyPairCommandOutput extends KeyPair, __MetadataBearer {
39
39
  * @see {@link CreateKeyPairCommandOutput} for command's `response` shape.
40
40
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
41
41
  *
42
+ * @example To create a key pair
43
+ * ```javascript
44
+ * // This example creates a key pair named my-key-pair.
45
+ * const input = {
46
+ * "KeyName": "my-key-pair"
47
+ * };
48
+ * const command = new CreateKeyPairCommand(input);
49
+ * await client.send(command);
50
+ * // example id: ec2-create-key-pair-1
51
+ * ```
52
+ *
42
53
  */
43
54
  export declare class CreateKeyPairCommand extends $Command<CreateKeyPairCommandInput, CreateKeyPairCommandOutput, EC2ClientResolvedConfig> {
44
55
  readonly input: CreateKeyPairCommandInput;
@@ -38,6 +38,53 @@ export interface CreateLaunchTemplateCommandOutput extends CreateLaunchTemplateR
38
38
  * @see {@link CreateLaunchTemplateCommandOutput} for command's `response` shape.
39
39
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
40
40
  *
41
+ * @example To create a launch template
42
+ * ```javascript
43
+ * // This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.
44
+ * const input = {
45
+ * "LaunchTemplateData": {
46
+ * "ImageId": "ami-8c1be5f6",
47
+ * "InstanceType": "t2.small",
48
+ * "NetworkInterfaces": [
49
+ * {
50
+ * "AssociatePublicIpAddress": true,
51
+ * "DeviceIndex": 0,
52
+ * "Ipv6AddressCount": 1,
53
+ * "SubnetId": "subnet-7b16de0c"
54
+ * }
55
+ * ],
56
+ * "TagSpecifications": [
57
+ * {
58
+ * "ResourceType": "instance",
59
+ * "Tags": [
60
+ * {
61
+ * "Key": "Name",
62
+ * "Value": "webserver"
63
+ * }
64
+ * ]
65
+ * }
66
+ * ]
67
+ * },
68
+ * "LaunchTemplateName": "my-template",
69
+ * "VersionDescription": "WebVersion1"
70
+ * };
71
+ * const command = new CreateLaunchTemplateCommand(input);
72
+ * const response = await client.send(command);
73
+ * /* response ==
74
+ * {
75
+ * "LaunchTemplate": {
76
+ * "CreateTime": "2017-11-27T09:13:24.000Z",
77
+ * "CreatedBy": "arn:aws:iam::123456789012:root",
78
+ * "DefaultVersionNumber": 1,
79
+ * "LatestVersionNumber": 1,
80
+ * "LaunchTemplateId": "lt-01238c059e3466abc",
81
+ * "LaunchTemplateName": "my-template"
82
+ * }
83
+ * }
84
+ * *\/
85
+ * // example id: to-create-a-launch-template-1529023655488
86
+ * ```
87
+ *
41
88
  */
42
89
  export declare class CreateLaunchTemplateCommand extends $Command<CreateLaunchTemplateCommandInput, CreateLaunchTemplateCommandOutput, EC2ClientResolvedConfig> {
43
90
  readonly input: CreateLaunchTemplateCommandInput;
@@ -37,6 +37,51 @@ export interface CreateLaunchTemplateVersionCommandOutput extends CreateLaunchTe
37
37
  * @see {@link CreateLaunchTemplateVersionCommandOutput} for command's `response` shape.
38
38
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
39
39
  *
40
+ * @example To create a launch template version
41
+ * ```javascript
42
+ * // This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.
43
+ * const input = {
44
+ * "LaunchTemplateData": {
45
+ * "ImageId": "ami-c998b6b2"
46
+ * },
47
+ * "LaunchTemplateId": "lt-0abcd290751193123",
48
+ * "SourceVersion": "1",
49
+ * "VersionDescription": "WebVersion2"
50
+ * };
51
+ * const command = new CreateLaunchTemplateVersionCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "LaunchTemplateVersion": {
56
+ * "CreateTime": "2017-12-01T13:35:46.000Z",
57
+ * "CreatedBy": "arn:aws:iam::123456789012:root",
58
+ * "DefaultVersion": false,
59
+ * "LaunchTemplateData": {
60
+ * "ImageId": "ami-c998b6b2",
61
+ * "InstanceType": "t2.micro",
62
+ * "NetworkInterfaces": [
63
+ * {
64
+ * "AssociatePublicIpAddress": true,
65
+ * "DeviceIndex": 0,
66
+ * "Ipv6Addresses": [
67
+ * {
68
+ * "Ipv6Address": "2001:db8:1234:1a00::123"
69
+ * }
70
+ * ],
71
+ * "SubnetId": "subnet-7b16de0c"
72
+ * }
73
+ * ]
74
+ * },
75
+ * "LaunchTemplateId": "lt-0abcd290751193123",
76
+ * "LaunchTemplateName": "my-template",
77
+ * "VersionDescription": "WebVersion2",
78
+ * "VersionNumber": 2
79
+ * }
80
+ * }
81
+ * *\/
82
+ * // example id: to-create-a-launch-template-version-1529024195702
83
+ * ```
84
+ *
40
85
  */
41
86
  export declare class CreateLaunchTemplateVersionCommand extends $Command<CreateLaunchTemplateVersionCommandInput, CreateLaunchTemplateVersionCommandOutput, EC2ClientResolvedConfig> {
42
87
  readonly input: CreateLaunchTemplateVersionCommandInput;
@@ -38,6 +38,34 @@ export interface CreateNatGatewayCommandOutput extends CreateNatGatewayResult, _
38
38
  * @see {@link CreateNatGatewayCommandOutput} for command's `response` shape.
39
39
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
40
40
  *
41
+ * @example To create a NAT gateway
42
+ * ```javascript
43
+ * // This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.
44
+ * const input = {
45
+ * "AllocationId": "eipalloc-37fc1a52",
46
+ * "SubnetId": "subnet-1a2b3c4d"
47
+ * };
48
+ * const command = new CreateNatGatewayCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "NatGateway": {
53
+ * "CreateTime": "2015-12-17T12:45:26.732Z",
54
+ * "NatGatewayAddresses": [
55
+ * {
56
+ * "AllocationId": "eipalloc-37fc1a52"
57
+ * }
58
+ * ],
59
+ * "NatGatewayId": "nat-08d48af2a8e83edfd",
60
+ * "State": "pending",
61
+ * "SubnetId": "subnet-1a2b3c4d",
62
+ * "VpcId": "vpc-1122aabb"
63
+ * }
64
+ * }
65
+ * *\/
66
+ * // example id: ec2-create-nat-gateway-1
67
+ * ```
68
+ *
41
69
  */
42
70
  export declare class CreateNatGatewayCommand extends $Command<CreateNatGatewayCommandInput, CreateNatGatewayCommandOutput, EC2ClientResolvedConfig> {
43
71
  readonly input: CreateNatGatewayCommandInput;
@@ -31,6 +31,44 @@ export interface CreateNetworkAclCommandOutput extends CreateNetworkAclResult, _
31
31
  * @see {@link CreateNetworkAclCommandOutput} for command's `response` shape.
32
32
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
33
33
  *
34
+ * @example To create a network ACL
35
+ * ```javascript
36
+ * // This example creates a network ACL for the specified VPC.
37
+ * const input = {
38
+ * "VpcId": "vpc-a01106c2"
39
+ * };
40
+ * const command = new CreateNetworkAclCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "NetworkAcl": {
45
+ * "Associations": [],
46
+ * "Entries": [
47
+ * {
48
+ * "CidrBlock": "0.0.0.0/0",
49
+ * "Egress": true,
50
+ * "Protocol": "-1",
51
+ * "RuleAction": "deny",
52
+ * "RuleNumber": 32767
53
+ * },
54
+ * {
55
+ * "CidrBlock": "0.0.0.0/0",
56
+ * "Egress": false,
57
+ * "Protocol": "-1",
58
+ * "RuleAction": "deny",
59
+ * "RuleNumber": 32767
60
+ * }
61
+ * ],
62
+ * "IsDefault": false,
63
+ * "NetworkAclId": "acl-5fb85d36",
64
+ * "Tags": [],
65
+ * "VpcId": "vpc-a01106c2"
66
+ * }
67
+ * }
68
+ * *\/
69
+ * // example id: ec2-create-network-acl-1
70
+ * ```
71
+ *
34
72
  */
35
73
  export declare class CreateNetworkAclCommand extends $Command<CreateNetworkAclCommandInput, CreateNetworkAclCommandOutput, EC2ClientResolvedConfig> {
36
74
  readonly input: CreateNetworkAclCommandInput;
@@ -36,6 +36,26 @@ export interface CreateNetworkAclEntryCommandOutput extends __MetadataBearer {
36
36
  * @see {@link CreateNetworkAclEntryCommandOutput} for command's `response` shape.
37
37
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
38
38
  *
39
+ * @example To create a network ACL entry
40
+ * ```javascript
41
+ * // This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.
42
+ * const input = {
43
+ * "CidrBlock": "0.0.0.0/0",
44
+ * "Egress": false,
45
+ * "NetworkAclId": "acl-5fb85d36",
46
+ * "PortRange": {
47
+ * "From": 53,
48
+ * "To": 53
49
+ * },
50
+ * "Protocol": "17",
51
+ * "RuleAction": "allow",
52
+ * "RuleNumber": 100
53
+ * };
54
+ * const command = new CreateNetworkAclEntryCommand(input);
55
+ * await client.send(command);
56
+ * // example id: ec2-create-network-acl-entry-1
57
+ * ```
58
+ *
39
59
  */
40
60
  export declare class CreateNetworkAclEntryCommand extends $Command<CreateNetworkAclEntryCommandInput, CreateNetworkAclEntryCommandOutput, EC2ClientResolvedConfig> {
41
61
  readonly input: CreateNetworkAclEntryCommandInput;
@@ -34,6 +34,52 @@ export interface CreateNetworkInterfaceCommandOutput extends CreateNetworkInterf
34
34
  * @see {@link CreateNetworkInterfaceCommandOutput} for command's `response` shape.
35
35
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
36
36
  *
37
+ * @example To create a network interface
38
+ * ```javascript
39
+ * // This example creates a network interface for the specified subnet.
40
+ * const input = {
41
+ * "Description": "my network interface",
42
+ * "Groups": [
43
+ * "sg-903004f8"
44
+ * ],
45
+ * "PrivateIpAddress": "10.0.2.17",
46
+ * "SubnetId": "subnet-9d4a7b6c"
47
+ * };
48
+ * const command = new CreateNetworkInterfaceCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "NetworkInterface": {
53
+ * "AvailabilityZone": "us-east-1d",
54
+ * "Description": "my network interface",
55
+ * "Groups": [
56
+ * {
57
+ * "GroupId": "sg-903004f8",
58
+ * "GroupName": "default"
59
+ * }
60
+ * ],
61
+ * "MacAddress": "02:1a:80:41:52:9c",
62
+ * "NetworkInterfaceId": "eni-e5aa89a3",
63
+ * "OwnerId": "123456789012",
64
+ * "PrivateIpAddress": "10.0.2.17",
65
+ * "PrivateIpAddresses": [
66
+ * {
67
+ * "Primary": true,
68
+ * "PrivateIpAddress": "10.0.2.17"
69
+ * }
70
+ * ],
71
+ * "RequesterManaged": false,
72
+ * "SourceDestCheck": true,
73
+ * "Status": "pending",
74
+ * "SubnetId": "subnet-9d4a7b6c",
75
+ * "TagSet": [],
76
+ * "VpcId": "vpc-a01106c2"
77
+ * }
78
+ * }
79
+ * *\/
80
+ * // example id: ec2-create-network-interface-1
81
+ * ```
82
+ *
37
83
  */
38
84
  export declare class CreateNetworkInterfaceCommand extends $Command<CreateNetworkInterfaceCommandInput, CreateNetworkInterfaceCommandOutput, EC2ClientResolvedConfig> {
39
85
  readonly input: CreateNetworkInterfaceCommandInput;
@@ -38,6 +38,18 @@ export interface CreatePlacementGroupCommandOutput extends CreatePlacementGroupR
38
38
  * @see {@link CreatePlacementGroupCommandOutput} for command's `response` shape.
39
39
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
40
40
  *
41
+ * @example To create a placement group
42
+ * ```javascript
43
+ * // This example creates a placement group with the specified name.
44
+ * const input = {
45
+ * "GroupName": "my-cluster",
46
+ * "Strategy": "cluster"
47
+ * };
48
+ * const command = new CreatePlacementGroupCommand(input);
49
+ * await client.send(command);
50
+ * // example id: to-create-a-placement-group-1472712245768
51
+ * ```
52
+ *
41
53
  */
42
54
  export declare class CreatePlacementGroupCommand extends $Command<CreatePlacementGroupCommandInput, CreatePlacementGroupCommandOutput, EC2ClientResolvedConfig> {
43
55
  readonly input: CreatePlacementGroupCommandInput;
@@ -49,6 +49,19 @@ export interface CreateRouteCommandOutput extends CreateRouteResult, __MetadataB
49
49
  * @see {@link CreateRouteCommandOutput} for command's `response` shape.
50
50
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
51
51
  *
52
+ * @example To create a route
53
+ * ```javascript
54
+ * // This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.
55
+ * const input = {
56
+ * "DestinationCidrBlock": "0.0.0.0/0",
57
+ * "GatewayId": "igw-c0a643a9",
58
+ * "RouteTableId": "rtb-22574640"
59
+ * };
60
+ * const command = new CreateRouteCommand(input);
61
+ * await client.send(command);
62
+ * // example id: ec2-create-route-1
63
+ * ```
64
+ *
52
65
  */
53
66
  export declare class CreateRouteCommand extends $Command<CreateRouteCommandInput, CreateRouteCommandOutput, EC2ClientResolvedConfig> {
54
67
  readonly input: CreateRouteCommandInput;
@@ -32,6 +32,35 @@ export interface CreateRouteTableCommandOutput extends CreateRouteTableResult, _
32
32
  * @see {@link CreateRouteTableCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To create a route table
36
+ * ```javascript
37
+ * // This example creates a route table for the specified VPC.
38
+ * const input = {
39
+ * "VpcId": "vpc-a01106c2"
40
+ * };
41
+ * const command = new CreateRouteTableCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "RouteTable": {
46
+ * "Associations": [],
47
+ * "PropagatingVgws": [],
48
+ * "RouteTableId": "rtb-22574640",
49
+ * "Routes": [
50
+ * {
51
+ * "DestinationCidrBlock": "10.0.0.0/16",
52
+ * "GatewayId": "local",
53
+ * "State": "active"
54
+ * }
55
+ * ],
56
+ * "Tags": [],
57
+ * "VpcId": "vpc-a01106c2"
58
+ * }
59
+ * }
60
+ * *\/
61
+ * // example id: ec2-create-route-table-1
62
+ * ```
63
+ *
35
64
  */
36
65
  export declare class CreateRouteTableCommand extends $Command<CreateRouteTableCommandInput, CreateRouteTableCommandOutput, EC2ClientResolvedConfig> {
37
66
  readonly input: CreateRouteTableCommandInput;
@@ -46,6 +46,24 @@ export interface CreateSecurityGroupCommandOutput extends CreateSecurityGroupRes
46
46
  * @see {@link CreateSecurityGroupCommandOutput} for command's `response` shape.
47
47
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
48
48
  *
49
+ * @example To create a security group for a VPC
50
+ * ```javascript
51
+ * // This example creates a security group for the specified VPC.
52
+ * const input = {
53
+ * "Description": "My security group",
54
+ * "GroupName": "my-security-group",
55
+ * "VpcId": "vpc-1a2b3c4d"
56
+ * };
57
+ * const command = new CreateSecurityGroupCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "GroupId": "sg-903004f8"
62
+ * }
63
+ * *\/
64
+ * // example id: to-create-a-security-group-for-a-vpc-1529024532716
65
+ * ```
66
+ *
49
67
  */
50
68
  export declare class CreateSecurityGroupCommand extends $Command<CreateSecurityGroupCommandInput, CreateSecurityGroupCommandOutput, EC2ClientResolvedConfig> {
51
69
  readonly input: CreateSecurityGroupCommandInput;
@@ -53,6 +53,30 @@ export interface CreateSnapshotCommandOutput extends Snapshot, __MetadataBearer
53
53
  * @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
54
54
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
55
55
  *
56
+ * @example To create a snapshot
57
+ * ```javascript
58
+ * // This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.
59
+ * const input = {
60
+ * "Description": "This is my root volume snapshot.",
61
+ * "VolumeId": "vol-1234567890abcdef0"
62
+ * };
63
+ * const command = new CreateSnapshotCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "Description": "This is my root volume snapshot.",
68
+ * "OwnerId": "012345678910",
69
+ * "SnapshotId": "snap-066877671789bd71b",
70
+ * "StartTime": "2014-02-28T21:06:01.000Z",
71
+ * "State": "pending",
72
+ * "Tags": [],
73
+ * "VolumeId": "vol-1234567890abcdef0",
74
+ * "VolumeSize": 8
75
+ * }
76
+ * *\/
77
+ * // example id: to-create-a-snapshot-1472502529790
78
+ * ```
79
+ *
56
80
  */
57
81
  export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, EC2ClientResolvedConfig> {
58
82
  readonly input: CreateSnapshotCommandInput;
@@ -32,6 +32,28 @@ export interface CreateSpotDatafeedSubscriptionCommandOutput extends CreateSpotD
32
32
  * @see {@link CreateSpotDatafeedSubscriptionCommandOutput} for command's `response` shape.
33
33
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
34
34
  *
35
+ * @example To create a Spot Instance datafeed
36
+ * ```javascript
37
+ * // This example creates a Spot Instance data feed for your AWS account.
38
+ * const input = {
39
+ * "Bucket": "my-s3-bucket",
40
+ * "Prefix": "spotdata"
41
+ * };
42
+ * const command = new CreateSpotDatafeedSubscriptionCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "SpotDatafeedSubscription": {
47
+ * "Bucket": "my-s3-bucket",
48
+ * "OwnerId": "123456789012",
49
+ * "Prefix": "spotdata",
50
+ * "State": "Active"
51
+ * }
52
+ * }
53
+ * *\/
54
+ * // example id: ec2-create-spot-datafeed-subscription-1
55
+ * ```
56
+ *
35
57
  */
36
58
  export declare class CreateSpotDatafeedSubscriptionCommand extends $Command<CreateSpotDatafeedSubscriptionCommandInput, CreateSpotDatafeedSubscriptionCommandOutput, EC2ClientResolvedConfig> {
37
59
  readonly input: CreateSpotDatafeedSubscriptionCommandInput;
@@ -45,6 +45,30 @@ export interface CreateSubnetCommandOutput extends CreateSubnetResult, __Metadat
45
45
  * @see {@link CreateSubnetCommandOutput} for command's `response` shape.
46
46
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
47
47
  *
48
+ * @example To create a subnet
49
+ * ```javascript
50
+ * // This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.
51
+ * const input = {
52
+ * "CidrBlock": "10.0.1.0/24",
53
+ * "VpcId": "vpc-a01106c2"
54
+ * };
55
+ * const command = new CreateSubnetCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "Subnet": {
60
+ * "AvailabilityZone": "us-west-2c",
61
+ * "AvailableIpAddressCount": 251,
62
+ * "CidrBlock": "10.0.1.0/24",
63
+ * "State": "pending",
64
+ * "SubnetId": "subnet-9d4a7b6c",
65
+ * "VpcId": "vpc-a01106c2"
66
+ * }
67
+ * }
68
+ * *\/
69
+ * // example id: ec2-create-subnet-1
70
+ * ```
71
+ *
48
72
  */
49
73
  export declare class CreateSubnetCommand extends $Command<CreateSubnetCommandInput, CreateSubnetCommandOutput, EC2ClientResolvedConfig> {
50
74
  readonly input: CreateSubnetCommandInput;
@@ -37,6 +37,25 @@ export interface CreateTagsCommandOutput extends __MetadataBearer {
37
37
  * @see {@link CreateTagsCommandOutput} for command's `response` shape.
38
38
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
39
39
  *
40
+ * @example To add a tag to a resource
41
+ * ```javascript
42
+ * // This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.
43
+ * const input = {
44
+ * "Resources": [
45
+ * "ami-78a54011"
46
+ * ],
47
+ * "Tags": [
48
+ * {
49
+ * "Key": "Stack",
50
+ * "Value": "production"
51
+ * }
52
+ * ]
53
+ * };
54
+ * const command = new CreateTagsCommand(input);
55
+ * await client.send(command);
56
+ * // example id: ec2-create-tags-1
57
+ * ```
58
+ *
40
59
  */
41
60
  export declare class CreateTagsCommand extends $Command<CreateTagsCommandInput, CreateTagsCommandOutput, EC2ClientResolvedConfig> {
42
61
  readonly input: CreateTagsCommandInput;
@@ -39,6 +39,60 @@ export interface CreateVolumeCommandOutput extends Volume, __MetadataBearer {
39
39
  * @see {@link CreateVolumeCommandOutput} for command's `response` shape.
40
40
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
41
41
  *
42
+ * @example To create a new volume
43
+ * ```javascript
44
+ * // This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.
45
+ * const input = {
46
+ * "AvailabilityZone": "us-east-1a",
47
+ * "Size": 80,
48
+ * "VolumeType": "gp2"
49
+ * };
50
+ * const command = new CreateVolumeCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "AvailabilityZone": "us-east-1a",
55
+ * "CreateTime": "2016-08-29T18:52:32.724Z",
56
+ * "Encrypted": false,
57
+ * "Iops": 240,
58
+ * "Size": 80,
59
+ * "SnapshotId": "",
60
+ * "State": "creating",
61
+ * "VolumeId": "vol-6b60b7c7",
62
+ * "VolumeType": "gp2"
63
+ * }
64
+ * *\/
65
+ * // example id: to-create-a-new-volume-1472496724296
66
+ * ```
67
+ *
68
+ * @example To create a new Provisioned IOPS (SSD) volume from a snapshot
69
+ * ```javascript
70
+ * // This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.
71
+ * const input = {
72
+ * "AvailabilityZone": "us-east-1a",
73
+ * "Iops": 1000,
74
+ * "SnapshotId": "snap-066877671789bd71b",
75
+ * "VolumeType": "io1"
76
+ * };
77
+ * const command = new CreateVolumeCommand(input);
78
+ * const response = await client.send(command);
79
+ * /* response ==
80
+ * {
81
+ * "Attachments": [],
82
+ * "AvailabilityZone": "us-east-1a",
83
+ * "CreateTime": "2016-08-29T18:52:32.724Z",
84
+ * "Iops": 1000,
85
+ * "Size": 500,
86
+ * "SnapshotId": "snap-066877671789bd71b",
87
+ * "State": "creating",
88
+ * "Tags": [],
89
+ * "VolumeId": "vol-1234567890abcdef0",
90
+ * "VolumeType": "io1"
91
+ * }
92
+ * *\/
93
+ * // example id: to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176
94
+ * ```
95
+ *
42
96
  */
43
97
  export declare class CreateVolumeCommand extends $Command<CreateVolumeCommandInput, CreateVolumeCommandOutput, EC2ClientResolvedConfig> {
44
98
  readonly input: CreateVolumeCommandInput;
@@ -39,6 +39,28 @@ export interface CreateVpcCommandOutput extends CreateVpcResult, __MetadataBeare
39
39
  * @see {@link CreateVpcCommandOutput} for command's `response` shape.
40
40
  * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
41
41
  *
42
+ * @example To create a VPC
43
+ * ```javascript
44
+ * // This example creates a VPC with the specified CIDR block.
45
+ * const input = {
46
+ * "CidrBlock": "10.0.0.0/16"
47
+ * };
48
+ * const command = new CreateVpcCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "Vpc": {
53
+ * "CidrBlock": "10.0.0.0/16",
54
+ * "DhcpOptionsId": "dopt-7a8b9c2d",
55
+ * "InstanceTenancy": "default",
56
+ * "State": "pending",
57
+ * "VpcId": "vpc-a01106c2"
58
+ * }
59
+ * }
60
+ * *\/
61
+ * // example id: ec2-create-vpc-1
62
+ * ```
63
+ *
42
64
  */
43
65
  export declare class CreateVpcCommand extends $Command<CreateVpcCommandInput, CreateVpcCommandOutput, EC2ClientResolvedConfig> {
44
66
  readonly input: CreateVpcCommandInput;