aws-sdk 1.13.0 → 1.14.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 (42) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +3 -3
  3. data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
  4. data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
  5. data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
  6. data/lib/aws/auto_scaling/client.rb +0 -530
  7. data/lib/aws/cloud_formation/client.rb +0 -356
  8. data/lib/aws/cloud_front/client.rb +0 -1567
  9. data/lib/aws/cloud_search/client.rb +0 -578
  10. data/lib/aws/cloud_watch/client.rb +0 -445
  11. data/lib/aws/data_pipeline/client.rb +0 -396
  12. data/lib/aws/direct_connect/client.rb +0 -248
  13. data/lib/aws/dynamo_db.rb +0 -1
  14. data/lib/aws/dynamo_db/client.rb +70 -1
  15. data/lib/aws/dynamo_db/client_v2.rb +1 -1
  16. data/lib/aws/ec2/client.rb +0 -3942
  17. data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
  18. data/lib/aws/ec2/tag_collection.rb +1 -1
  19. data/lib/aws/elastic_beanstalk/client.rb +0 -898
  20. data/lib/aws/elastic_transcoder/client.rb +0 -1755
  21. data/lib/aws/elasticache/client.rb +0 -947
  22. data/lib/aws/elb/client.rb +0 -509
  23. data/lib/aws/emr/client.rb +0 -314
  24. data/lib/aws/glacier/client.rb +0 -278
  25. data/lib/aws/iam/client.rb +0 -1155
  26. data/lib/aws/import_export/client.rb +0 -96
  27. data/lib/aws/ops_works/client.rb +0 -1255
  28. data/lib/aws/rds/client.rb +0 -2367
  29. data/lib/aws/redshift/client.rb +0 -1458
  30. data/lib/aws/route_53/client.rb +0 -420
  31. data/lib/aws/simple_db/client.rb +2 -250
  32. data/lib/aws/simple_email_service/client.rb +0 -282
  33. data/lib/aws/simple_workflow/client.rb +0 -1248
  34. data/lib/aws/sns/client.rb +0 -283
  35. data/lib/aws/sns/message.rb +1 -1
  36. data/lib/aws/sqs/client.rb +0 -255
  37. data/lib/aws/storage_gateway/client.rb +0 -582
  38. data/lib/aws/sts/client.rb +0 -183
  39. data/lib/aws/support/client.rb +0 -232
  40. data/lib/aws/version.rb +1 -1
  41. metadata +2 -3
  42. data/lib/aws/dynamo_db/client_base.rb +0 -92
@@ -26,254 +26,6 @@ module AWS
26
26
 
27
27
  class Client::V20121025 < Client
28
28
 
29
- # client methods #
30
-
31
- # @!method create_connection(options = {})
32
- # Calls the CreateConnection API operation.
33
- # @param [Hash] options
34
- #
35
- # * `:offering_id` - *required* - (String)
36
- # * `:connection_name` - *required* - (String)
37
- # @return [Core::Response]
38
- # The #data method of the response object returns
39
- # a hash with the following structure:
40
- #
41
- # * `:connection_id` - (String)
42
- # * `:connection_name` - (String)
43
- # * `:connection_state` - (String)
44
- # * `:region` - (String)
45
- # * `:location` - (String)
46
-
47
- # @!method create_private_virtual_interface(options = {})
48
- # Calls the CreatePrivateVirtualInterface API operation.
49
- # @param [Hash] options
50
- #
51
- # * `:connection_id` - (String)
52
- # * `:new_private_virtual_interface` - (Hash) Detailed information of
53
- # the private virtual interface to be created. Default: None
54
- # * `:virtual_interface_name` - (String)
55
- # * `:vlan` - (Integer)
56
- # * `:asn` - (Integer)
57
- # * `:auth_key` - (String)
58
- # * `:amazon_address` - (String)
59
- # * `:customer_address` - (String)
60
- # * `:virtual_gateway_id` - (String)
61
- # @return [Core::Response]
62
- # The #data method of the response object returns
63
- # a hash with the following structure:
64
- #
65
- # * `:virtual_interface_id` - (String)
66
- # * `:location` - (String)
67
- # * `:connection_id` - (String)
68
- # * `:virtual_interface_type` - (String)
69
- # * `:virtual_interface_name` - (String)
70
- # * `:vlan` - (Integer)
71
- # * `:asn` - (Integer)
72
- # * `:auth_key` - (String)
73
- # * `:amazon_address` - (String)
74
- # * `:customer_address` - (String)
75
- # * `:virtual_interface_state` - (String)
76
- # * `:customer_router_config` - (String)
77
- # * `:virtual_gateway_id` - (String)
78
- # * `:route_filter_prefixes` - (Array<Hash>)
79
- # * `:cidr` - (String)
80
-
81
- # @!method create_public_virtual_interface(options = {})
82
- # Calls the CreatePublicVirtualInterface API operation.
83
- # @param [Hash] options
84
- #
85
- # * `:connection_id` - (String)
86
- # * `:new_public_virtual_interface` - (Hash) Detailed information of
87
- # the public virtual interface to be created. Default: None
88
- # * `:virtual_interface_name` - (String)
89
- # * `:vlan` - (Integer)
90
- # * `:asn` - (Integer)
91
- # * `:auth_key` - (String)
92
- # * `:amazon_address` - (String)
93
- # * `:customer_address` - (String)
94
- # * `:route_filter_prefixes` - (Array<Hash>)
95
- # * `:cidr` - (String) CIDR notation for the advertised route.
96
- # Multiple routes are separated by commas Example:
97
- # 10.10.10.0/24,10.10.11.0/24
98
- # @return [Core::Response]
99
- # The #data method of the response object returns
100
- # a hash with the following structure:
101
- #
102
- # * `:virtual_interface_id` - (String)
103
- # * `:location` - (String)
104
- # * `:connection_id` - (String)
105
- # * `:virtual_interface_type` - (String)
106
- # * `:virtual_interface_name` - (String)
107
- # * `:vlan` - (Integer)
108
- # * `:asn` - (Integer)
109
- # * `:auth_key` - (String)
110
- # * `:amazon_address` - (String)
111
- # * `:customer_address` - (String)
112
- # * `:virtual_interface_state` - (String)
113
- # * `:customer_router_config` - (String)
114
- # * `:virtual_gateway_id` - (String)
115
- # * `:route_filter_prefixes` - (Array<Hash>)
116
- # * `:cidr` - (String)
117
-
118
- # @!method delete_connection(options = {})
119
- # Calls the DeleteConnection API operation.
120
- # @param [Hash] options
121
- #
122
- # * `:connection_id` - *required* - (String)
123
- # @return [Core::Response]
124
- # The #data method of the response object returns
125
- # a hash with the following structure:
126
- #
127
- # * `:connection_id` - (String)
128
- # * `:connection_name` - (String)
129
- # * `:connection_state` - (String)
130
- # * `:region` - (String)
131
- # * `:location` - (String)
132
-
133
- # @!method delete_virtual_interface(options = {})
134
- # Calls the DeleteVirtualInterface API operation.
135
- # @param [Hash] options
136
- #
137
- # * `:virtual_interface_id` - (String)
138
- # @return [Core::Response]
139
- # The #data method of the response object returns
140
- # a hash with the following structure:
141
- #
142
- # * `:virtual_interface_state` - (String)
143
-
144
- # @!method describe_connection_detail(options = {})
145
- # Calls the DescribeConnectionDetail API operation.
146
- # @param [Hash] options
147
- #
148
- # * `:connection_id` - *required* - (String)
149
- # @return [Core::Response]
150
- # The #data method of the response object returns
151
- # a hash with the following structure:
152
- #
153
- # * `:connection_id` - (String)
154
- # * `:connection_name` - (String)
155
- # * `:connection_state` - (String)
156
- # * `:region` - (String)
157
- # * `:location` - (String)
158
- # * `:bandwidth` - (String)
159
- # * `:connection_costs` - (Array<Hash>)
160
- # * `:name` - (String)
161
- # * `:unit` - (String)
162
- # * `:currency_code` - (String)
163
- # * `:amount` - (String)
164
- # * `:order_steps` - (Array<Hash>)
165
- # * `:number` - (String)
166
- # * `:name` - (String)
167
- # * `:description` - (String)
168
- # * `:owner` - (String)
169
- # * `:sla` - (Integer)
170
- # * `:step_state` - (String)
171
-
172
- # @!method describe_connections(options = {})
173
- # Calls the DescribeConnections API operation.
174
- # @param [Hash] options
175
- #
176
- # * `:connection_id` - (String)
177
- # @return [Core::Response]
178
- # The #data method of the response object returns
179
- # a hash with the following structure:
180
- #
181
- # * `:connections` - (Array<Hash>)
182
- # * `:connection_id` - (String)
183
- # * `:connection_name` - (String)
184
- # * `:connection_state` - (String)
185
- # * `:region` - (String)
186
- # * `:location` - (String)
187
-
188
- # @!method describe_offering_detail(options = {})
189
- # Calls the DescribeOfferingDetail API operation.
190
- # @param [Hash] options
191
- #
192
- # * `:offering_id` - *required* - (String)
193
- # @return [Core::Response]
194
- # The #data method of the response object returns
195
- # a hash with the following structure:
196
- #
197
- # * `:offering_id` - (String)
198
- # * `:region` - (String)
199
- # * `:location` - (String)
200
- # * `:offering_name` - (String)
201
- # * `:description` - (String)
202
- # * `:bandwidth` - (String)
203
- # * `:connection_costs` - (Array<Hash>)
204
- # * `:name` - (String)
205
- # * `:unit` - (String)
206
- # * `:currency_code` - (String)
207
- # * `:amount` - (String)
208
- # * `:order_steps` - (Array<Hash>)
209
- # * `:number` - (String)
210
- # * `:name` - (String)
211
- # * `:description` - (String)
212
- # * `:owner` - (String)
213
- # * `:sla` - (Integer)
214
-
215
- # @!method describe_offerings(options = {})
216
- # Calls the DescribeOfferings API operation.
217
- # @param [Hash] options
218
- #
219
- # @return [Core::Response]
220
- # The #data method of the response object returns
221
- # a hash with the following structure:
222
- #
223
- # * `:offerings` - (Array<Hash>)
224
- # * `:offering_id` - (String)
225
- # * `:region` - (String)
226
- # * `:location` - (String)
227
- # * `:offering_name` - (String)
228
- # * `:description` - (String)
229
- # * `:bandwidth` - (String)
230
- # * `:connection_costs` - (Array<Hash>)
231
- # * `:name` - (String)
232
- # * `:unit` - (String)
233
- # * `:currency_code` - (String)
234
- # * `:amount` - (String)
235
-
236
- # @!method describe_virtual_gateways(options = {})
237
- # Calls the DescribeVirtualGateways API operation.
238
- # @param [Hash] options
239
- #
240
- # @return [Core::Response]
241
- # The #data method of the response object returns
242
- # a hash with the following structure:
243
- #
244
- # * `:virtual_gateways` - (Array<Hash>)
245
- # * `:virtual_gateway_id` - (String)
246
- # * `:virtual_gateway_state` - (String)
247
-
248
- # @!method describe_virtual_interfaces(options = {})
249
- # Calls the DescribeVirtualInterfaces API operation.
250
- # @param [Hash] options
251
- #
252
- # * `:connection_id` - (String)
253
- # * `:virtual_interface_id` - (String)
254
- # @return [Core::Response]
255
- # The #data method of the response object returns
256
- # a hash with the following structure:
257
- #
258
- # * `:virtual_interfaces` - (Array<Hash>)
259
- # * `:virtual_interface_id` - (String)
260
- # * `:location` - (String)
261
- # * `:connection_id` - (String)
262
- # * `:virtual_interface_type` - (String)
263
- # * `:virtual_interface_name` - (String)
264
- # * `:vlan` - (Integer)
265
- # * `:asn` - (Integer)
266
- # * `:auth_key` - (String)
267
- # * `:amazon_address` - (String)
268
- # * `:customer_address` - (String)
269
- # * `:virtual_interface_state` - (String)
270
- # * `:customer_router_config` - (String)
271
- # * `:virtual_gateway_id` - (String)
272
- # * `:route_filter_prefixes` - (Array<Hash>)
273
- # * `:cidr` - (String)
274
-
275
- # end client methods #
276
-
277
29
  define_client_methods('2012-10-25')
278
30
 
279
31
  end
@@ -106,7 +106,6 @@ module AWS
106
106
  autoload :BatchGet, 'aws/dynamo_db/batch_get'
107
107
  autoload :BatchWrite, 'aws/dynamo_db/batch_write'
108
108
  autoload :Binary, 'aws/dynamo_db/binary'
109
- autoload :ClientBase, 'aws/dynamo_db/client_base'
110
109
  autoload :Client, 'aws/dynamo_db/client'
111
110
  autoload :ClientV2, 'aws/dynamo_db/client_v2'
112
111
  autoload :Errors, 'aws/dynamo_db/errors'
@@ -11,6 +11,8 @@
11
11
  # ANY KIND, either express or implied. See the License for the specific
12
12
  # language governing permissions and limitations under the License.
13
13
 
14
+ require 'zlib'
15
+
14
16
  module AWS
15
17
  class DynamoDB
16
18
 
@@ -46,13 +48,80 @@ module AWS
46
48
  # @see V20111205
47
49
  # @see V20120810
48
50
  #
49
- class Client < ClientBase
51
+ class Client < Core::JSONClient
50
52
 
51
53
  autoload :V20111205, 'aws/dynamo_db/client/v20111205'
52
54
  autoload :V20120810, 'aws/dynamo_db/client/v20120810'
53
55
 
54
56
  API_VERSION = '2011-12-05'
55
57
 
58
+ # @private
59
+ REGION_US_E1 = 'dynamodb.us-east-1.amazonaws.com'
60
+
61
+ # @private
62
+ CACHEABLE_REQUESTS = Set[:list_tables, :describe_table]
63
+
64
+ protected
65
+
66
+ def extract_error_details response
67
+ if response.http_response.status == 413
68
+ ['RequestEntityTooLarge', 'Request entity too large']
69
+ elsif crc32_is_valid?(response) == false
70
+ ['CRC32CheckFailed', 'CRC32 integrity check failed']
71
+ else
72
+ super
73
+ end
74
+ end
75
+
76
+ def retryable_error? response
77
+ case response.error
78
+ when Errors::ProvisionedThroughputExceededException
79
+ config.dynamo_db_retry_throughput_errors?
80
+ when Errors::CRC32CheckFailed
81
+ true
82
+ else
83
+ super
84
+ end
85
+ end
86
+
87
+ def sleep_durations response
88
+
89
+ retry_count =
90
+ if expired_credentials?(response)
91
+ config.max_retries == 0 ? 0 : 1
92
+ else
93
+ config.max_retries { 10 }
94
+ end
95
+
96
+ # given a retry_count of 10, the sleep durations will look like:
97
+ # 0, 50, 100, 200, 400, 800, 1600, 3200, 6400, 12800 (milliseconds)
98
+ (0...retry_count).map do |n|
99
+ if n == 0
100
+ 0
101
+ else
102
+ 50 * (2 ** (n - 1)) / 1000.0
103
+ end
104
+ end
105
+
106
+ end
107
+
108
+ private
109
+
110
+ # @return [Boolean] whether the CRC32 response header matches the body.
111
+ # @return [nil] if no CRC32 header is present or we are not verifying CRC32
112
+ def crc32_is_valid? response
113
+ return nil unless config.dynamo_db_crc32
114
+ if crcs = response.http_response.headers['x-amz-crc32']
115
+ crcs[0].to_i == calculate_crc32(response)
116
+ else
117
+ nil
118
+ end
119
+ end
120
+
121
+ def calculate_crc32 response
122
+ Zlib.crc32(response.http_response.body)
123
+ end
124
+
56
125
  end
57
126
  end
58
127
  end
@@ -24,7 +24,7 @@ module AWS
24
24
  # AWS::DynamoDB::Client.new
25
25
  # #=> #<AWS::DynamoDB::Client::V20111205>
26
26
  #
27
- # @api private
27
+ # @deprecated
28
28
  class ClientV2
29
29
 
30
30
  DEPRECATION_MSG = "DEPRECATION WARNING: AWS::DynamoDB::ClientV2 is deprecated, use AWS::DynamoDB::Client.new(:api_version => '2012-08-10')"
@@ -62,3948 +62,6 @@ module AWS
62
62
 
63
63
  class Client::V20130201 < Client
64
64
 
65
- # client methods #
66
-
67
- # @!method activate_license(options = {})
68
- # Calls the ActivateLicense API operation.
69
- # @param [Hash] options
70
- #
71
- # * `:license_id` - *required* - (String) Specifies the ID for the
72
- # specific license to activate against.
73
- # * `:capacity` - *required* - (Integer) Specifies the additional
74
- # number of licenses to activate.
75
- # @return [Core::Response]
76
-
77
- # @!method allocate_address(options = {})
78
- # Calls the AllocateAddress API operation.
79
- # @param [Hash] options
80
- #
81
- # * `:domain` - (String) Set to vpc to allocate the address to your
82
- # VPC. By default, will allocate to EC2. Valid values include:
83
- # * `vpc`
84
- # * `standard`
85
- # @return [Core::Response]
86
- # The #data method of the response object returns
87
- # a hash with the following structure:
88
- #
89
- # * `:public_ip` - (String)
90
- # * `:domain` - (String)
91
- # * `:allocation_id` - (String)
92
-
93
- # @!method assign_private_ip_addresses(options = {})
94
- # Calls the AssignPrivateIpAddresses API operation.
95
- # @param [Hash] options
96
- #
97
- # * `:network_interface_id` - *required* - (String)
98
- # * `:private_ip_addresses` - (Array<String>)
99
- # * `:secondary_private_ip_address_count` - (Integer)
100
- # * `:allow_reassignment` - (Boolean)
101
- # @return [Core::Response]
102
-
103
- # @!method associate_address(options = {})
104
- # Calls the AssociateAddress API operation.
105
- # @param [Hash] options
106
- #
107
- # * `:instance_id` - (String) The instance to associate with the IP
108
- # address.
109
- # * `:public_ip` - (String) IP address that you are assigning to the
110
- # instance.
111
- # * `:allocation_id` - (String) The allocation ID that AWS returned
112
- # when you allocated the elastic IP address for use with Amazon VPC.
113
- # * `:network_interface_id` - (String)
114
- # * `:private_ip_address` - (String)
115
- # * `:allow_reassociation` - (Boolean)
116
- # @return [Core::Response]
117
- # The #data method of the response object returns
118
- # a hash with the following structure:
119
- #
120
- # * `:association_id` - (String)
121
-
122
- # @!method associate_dhcp_options(options = {})
123
- # Calls the AssociateDhcpOptions API operation.
124
- # @param [Hash] options
125
- #
126
- # * `:dhcp_options_id` - *required* - (String) The ID of the DHCP
127
- # options to associate with the VPC. Specify "default" to associate
128
- # the default DHCP options with the VPC.
129
- # * `:vpc_id` - *required* - (String) The ID of the VPC to associate
130
- # the DHCP options with.
131
- # @return [Core::Response]
132
-
133
- # @!method associate_route_table(options = {})
134
- # Calls the AssociateRouteTable API operation.
135
- # @param [Hash] options
136
- #
137
- # * `:subnet_id` - *required* - (String) The ID of the subnet.
138
- # * `:route_table_id` - *required* - (String) The ID of the route
139
- # table.
140
- # @return [Core::Response]
141
- # The #data method of the response object returns
142
- # a hash with the following structure:
143
- #
144
- # * `:association_id` - (String)
145
-
146
- # @!method attach_internet_gateway(options = {})
147
- # Calls the AttachInternetGateway API operation.
148
- # @param [Hash] options
149
- #
150
- # * `:internet_gateway_id` - *required* - (String) The ID of the
151
- # Internet gateway to attach.
152
- # * `:vpc_id` - *required* - (String) The ID of the VPC.
153
- # @return [Core::Response]
154
-
155
- # @!method attach_network_interface(options = {})
156
- # Calls the AttachNetworkInterface API operation.
157
- # @param [Hash] options
158
- #
159
- # * `:network_interface_id` - *required* - (String)
160
- # * `:instance_id` - *required* - (String)
161
- # * `:device_index` - *required* - (Integer)
162
- # @return [Core::Response]
163
- # The #data method of the response object returns
164
- # a hash with the following structure:
165
- #
166
- # * `:attachment_id` - (String)
167
-
168
- # @!method attach_volume(options = {})
169
- # Calls the AttachVolume API operation.
170
- # @param [Hash] options
171
- #
172
- # * `:volume_id` - *required* - (String) The ID of the Amazon EBS
173
- # volume. The volume and instance must be within the same
174
- # Availability Zone and the instance must be running.
175
- # * `:instance_id` - *required* - (String) The ID of the instance to
176
- # which the volume attaches. The volume and instance must be within
177
- # the same Availability Zone and the instance must be running.
178
- # * `:device` - *required* - (String) Specifies how the device is
179
- # exposed to the instance (e.g., /dev/sdh).
180
- # @return [Core::Response]
181
- # The #data method of the response object returns
182
- # a hash with the following structure:
183
- #
184
- # * `:volume_id` - (String)
185
- # * `:instance_id` - (String)
186
- # * `:device` - (String)
187
- # * `:status` - (String)
188
- # * `:attach_time` - (Time)
189
- # * `:delete_on_termination` - (Boolean)
190
-
191
- # @!method attach_vpn_gateway(options = {})
192
- # Calls the AttachVpnGateway API operation.
193
- # @param [Hash] options
194
- #
195
- # * `:vpn_gateway_id` - *required* - (String) The ID of the VPN gateway
196
- # to attach to the VPC.
197
- # * `:vpc_id` - *required* - (String) The ID of the VPC to attach to
198
- # the VPN gateway.
199
- # @return [Core::Response]
200
- # The #data method of the response object returns
201
- # a hash with the following structure:
202
- #
203
- # * `:attachment` - (Hash)
204
- # * `:vpc_id` - (String)
205
- # * `:state` - (String)
206
-
207
- # @!method authorize_security_group_egress(options = {})
208
- # Calls the AuthorizeSecurityGroupEgress API operation.
209
- # @param [Hash] options
210
- #
211
- # * `:group_id` - *required* - (String) ID of the VPC security group to
212
- # modify.
213
- # * `:source_security_group_name` - (String) Deprecated.
214
- # * `:source_security_group_owner_id` - (String) Deprecated.
215
- # * `:ip_protocol` - (String) Deprecated.
216
- # * `:from_port` - (Integer) Deprecated.
217
- # * `:to_port` - (Integer) Deprecated.
218
- # * `:cidr_ip` - (String) Deprecated.
219
- # * `:ip_permissions` - (Array<Hash>) List of IP permissions to
220
- # authorize on the specified security group. Specifying permissions
221
- # through IP permissions is the preferred way of authorizing
222
- # permissions since it offers more flexibility and control.
223
- # * `:ip_protocol` - (String) The IP protocol of this permission.
224
- # Valid protocol values: tcp, udp, icmp
225
- # * `:from_port` - (Integer) Start of port range for the TCP and UDP
226
- # protocols, or an ICMP type number. An ICMP type number of -1
227
- # indicates a wildcard (i.e., any ICMP type number).
228
- # * `:to_port` - (Integer) End of port range for the TCP and UDP
229
- # protocols, or an ICMP code. An ICMP code of -1 indicates a
230
- # wildcard (i.e., any ICMP code).
231
- # * `:user_id_group_pairs` - (Array<Hash>) The list of AWS user IDs
232
- # and groups included in this permission.
233
- # * `:user_id` - (String) The AWS user ID of an account.
234
- # * `:group_name` - (String) Name of the security group in the
235
- # specified AWS account. Cannot be used when specifying a CIDR IP
236
- # address range.
237
- # * `:group_id` - (String) ID of the security group in the
238
- # specified AWS account. Cannot be used when specifying a CIDR IP
239
- # address range.
240
- # * `:ip_ranges` - (Array<Hash>) The list of CIDR IP ranges included
241
- # in this permission.
242
- # * `:cidr_ip` - (String) The list of CIDR IP ranges.
243
- # @return [Core::Response]
244
-
245
- # @!method authorize_security_group_ingress(options = {})
246
- # Calls the AuthorizeSecurityGroupIngress API operation.
247
- # @param [Hash] options
248
- #
249
- # * `:group_name` - (String) Name of the standard (EC2) security group
250
- # to modify. The group must belong to your account. Can be used
251
- # instead of GroupID for standard (EC2) security groups.
252
- # * `:group_id` - (String) ID of the standard (EC2) or VPC security
253
- # group to modify. The group must belong to your account. Required
254
- # for VPC security groups; can be used instead of GroupName for
255
- # standard (EC2) security groups.
256
- # * `:source_security_group_name` - (String) Deprecated
257
- # * `:source_security_group_owner_id` - (String) Deprecated
258
- # * `:ip_protocol` - (String) Deprecated
259
- # * `:from_port` - (Integer) Deprecated
260
- # * `:to_port` - (Integer) Deprecated
261
- # * `:cidr_ip` - (String) Deprecated
262
- # * `:ip_permissions` - (Array<Hash>) List of IP permissions to
263
- # authorize on the specified security group. Specifying permissions
264
- # through IP permissions is the preferred way of authorizing
265
- # permissions since it offers more flexibility and control.
266
- # * `:ip_protocol` - (String) The IP protocol of this permission.
267
- # Valid protocol values: tcp, udp, icmp
268
- # * `:from_port` - (Integer) Start of port range for the TCP and UDP
269
- # protocols, or an ICMP type number. An ICMP type number of -1
270
- # indicates a wildcard (i.e., any ICMP type number).
271
- # * `:to_port` - (Integer) End of port range for the TCP and UDP
272
- # protocols, or an ICMP code. An ICMP code of -1 indicates a
273
- # wildcard (i.e., any ICMP code).
274
- # * `:user_id_group_pairs` - (Array<Hash>) The list of AWS user IDs
275
- # and groups included in this permission.
276
- # * `:user_id` - (String) The AWS user ID of an account.
277
- # * `:group_name` - (String) Name of the security group in the
278
- # specified AWS account. Cannot be used when specifying a CIDR IP
279
- # address range.
280
- # * `:group_id` - (String) ID of the security group in the
281
- # specified AWS account. Cannot be used when specifying a CIDR IP
282
- # address range.
283
- # * `:ip_ranges` - (Array<Hash>) The list of CIDR IP ranges included
284
- # in this permission.
285
- # * `:cidr_ip` - (String) The list of CIDR IP ranges.
286
- # @return [Core::Response]
287
-
288
- # @!method bundle_instance(options = {})
289
- # Calls the BundleInstance API operation.
290
- # @param [Hash] options
291
- #
292
- # * `:instance_id` - *required* - (String) The ID of the instance to
293
- # bundle.
294
- # * `:storage` - *required* - (Hash)
295
- # * `:s3` - (Hash) The details of S3 storage for bundling a Windows
296
- # instance.
297
- # * `:bucket` - (String) The bucket in which to store the AMI. You
298
- # can specify a bucket that you already own or a new bucket that
299
- # Amazon EC2 creates on your behalf. If you specify a bucket that
300
- # belongs to someone else, Amazon EC2 returns an error.
301
- # * `:prefix` - (String) The prefix to use when storing the AMI in
302
- # S3.
303
- # * `:aws_access_key_id` - (String) The Access Key ID of the owner
304
- # of the Amazon S3 bucket.
305
- # * `:upload_policy` - (String) A Base64-encoded Amazon S3 upload
306
- # policy that gives Amazon EC2 permission to upload items into
307
- # Amazon S3 on the user's behalf.
308
- # * `:upload_policy_signature` - (String) The signature of the
309
- # Base64 encoded JSON document.
310
- # @return [Core::Response]
311
- # The #data method of the response object returns
312
- # a hash with the following structure:
313
- #
314
- # * `:bundle_instance_task` - (Hash)
315
- # * `:instance_id` - (String)
316
- # * `:bundle_id` - (String)
317
- # * `:state` - (String)
318
- # * `:start_time` - (Time)
319
- # * `:update_time` - (Time)
320
- # * `:storage` - (Hash)
321
- # * `:s3` - (Hash)
322
- # * `:bucket` - (String)
323
- # * `:prefix` - (String)
324
- # * `:aws_access_key_id` - (String)
325
- # * `:upload_policy` - (String)
326
- # * `:upload_policy_signature` - (String)
327
- # * `:progress` - (String)
328
- # * `:error` - (Hash)
329
- # * `:code` - (String)
330
- # * `:message` - (String)
331
-
332
- # @!method cancel_bundle_task(options = {})
333
- # Calls the CancelBundleTask API operation.
334
- # @param [Hash] options
335
- #
336
- # * `:bundle_id` - *required* - (String) The ID of the bundle task to
337
- # cancel.
338
- # @return [Core::Response]
339
- # The #data method of the response object returns
340
- # a hash with the following structure:
341
- #
342
- # * `:bundle_instance_task` - (Hash)
343
- # * `:instance_id` - (String)
344
- # * `:bundle_id` - (String)
345
- # * `:state` - (String)
346
- # * `:start_time` - (Time)
347
- # * `:update_time` - (Time)
348
- # * `:storage` - (Hash)
349
- # * `:s3` - (Hash)
350
- # * `:bucket` - (String)
351
- # * `:prefix` - (String)
352
- # * `:aws_access_key_id` - (String)
353
- # * `:upload_policy` - (String)
354
- # * `:upload_policy_signature` - (String)
355
- # * `:progress` - (String)
356
- # * `:error` - (Hash)
357
- # * `:code` - (String)
358
- # * `:message` - (String)
359
-
360
- # @!method cancel_conversion_task(options = {})
361
- # Calls the CancelConversionTask API operation.
362
- # @param [Hash] options
363
- #
364
- # * `:conversion_task_id` - *required* - (String)
365
- # * `:reason_message` - (String)
366
- # @return [Core::Response]
367
-
368
- # @!method cancel_export_task(options = {})
369
- # Calls the CancelExportTask API operation.
370
- # @param [Hash] options
371
- #
372
- # * `:export_task_id` - *required* - (String)
373
- # @return [Core::Response]
374
-
375
- # @!method cancel_reserved_instances_listing(options = {})
376
- # Calls the CancelReservedInstancesListing API operation.
377
- # @param [Hash] options
378
- #
379
- # * `:reserved_instances_listing_id` - *required* - (String)
380
- # @return [Core::Response]
381
- # The #data method of the response object returns
382
- # a hash with the following structure:
383
- #
384
- # * `:reserved_instances_listings_set` - (Array<Hash>)
385
- # * `:reserved_instances_listing_id` - (String)
386
- # * `:reserved_instances_id` - (String)
387
- # * `:create_date` - (Time)
388
- # * `:update_date` - (Time)
389
- # * `:status` - (String)
390
- # * `:status_message` - (String)
391
- # * `:instance_counts` - (Array<Hash>)
392
- # * `:state` - (String)
393
- # * `:instance_count` - (Integer)
394
- # * `:price_schedules` - (Array<Hash>)
395
- # * `:term` - (Integer)
396
- # * `:price` - (Numeric)
397
- # * `:currency_code` - (String)
398
- # * `:active` - (Boolean)
399
- # * `:tag_set` - (Array<Hash>)
400
- # * `:key` - (String)
401
- # * `:value` - (String)
402
- # * `:client_token` - (String)
403
-
404
- # @!method cancel_spot_instance_requests(options = {})
405
- # Calls the CancelSpotInstanceRequests API operation.
406
- # @param [Hash] options
407
- #
408
- # * `:spot_instance_request_ids` - *required* - (Array<String>)
409
- # Specifies the ID of the Spot Instance request.
410
- # @return [Core::Response]
411
- # The #data method of the response object returns
412
- # a hash with the following structure:
413
- #
414
- # * `:spot_instance_request_set` - (Array<Hash>)
415
- # * `:spot_instance_request_id` - (String)
416
- # * `:state` - (String)
417
-
418
- # @!method confirm_product_instance(options = {})
419
- # Calls the ConfirmProductInstance API operation.
420
- # @param [Hash] options
421
- #
422
- # * `:product_code` - *required* - (String) The product code to
423
- # confirm.
424
- # * `:instance_id` - *required* - (String) The ID of the instance to
425
- # confirm.
426
- # @return [Core::Response]
427
- # The #data method of the response object returns
428
- # a hash with the following structure:
429
- #
430
- # * `:owner_id` - (String)
431
-
432
- # @!method copy_image(options = {})
433
- # Calls the CopyImage API operation.
434
- # @param [Hash] options
435
- #
436
- # * `:source_region` - *required* - (String)
437
- # * `:source_image_id` - *required* - (String)
438
- # * `:name` - *required* - (String)
439
- # * `:description` - (String)
440
- # * `:client_token` - (String)
441
- # @return [Core::Response]
442
- # The #data method of the response object returns
443
- # a hash with the following structure:
444
- #
445
- # * `:image_id` - (String)
446
-
447
- # @!method copy_snapshot(options = {})
448
- # Calls the CopySnapshot API operation.
449
- # @param [Hash] options
450
- #
451
- # * `:source_region` - *required* - (String)
452
- # * `:source_snapshot_id` - *required* - (String)
453
- # * `:description` - (String)
454
- # @return [Core::Response]
455
- # The #data method of the response object returns
456
- # a hash with the following structure:
457
- #
458
- # * `:snapshot_id` - (String)
459
-
460
- # @!method create_customer_gateway(options = {})
461
- # Calls the CreateCustomerGateway API operation.
462
- # @param [Hash] options
463
- #
464
- # * `:type` - *required* - (String) The type of VPN connection this
465
- # customer gateway supports.
466
- # * `:public_ip` - *required* - (String) The Internet-routable IP
467
- # address for the customer gateway's outside interface. The address
468
- # must be static
469
- # * `:bgp_asn` - *required* - (Integer) The customer gateway's Border
470
- # Gateway Protocol (BGP) Autonomous System Number (ASN).
471
- # @return [Core::Response]
472
- # The #data method of the response object returns
473
- # a hash with the following structure:
474
- #
475
- # * `:customer_gateway` - (Hash)
476
- # * `:customer_gateway_id` - (String)
477
- # * `:state` - (String)
478
- # * `:type` - (String)
479
- # * `:ip_address` - (String)
480
- # * `:bgp_asn` - (String)
481
- # * `:tag_set` - (Array<Hash>)
482
- # * `:key` - (String)
483
- # * `:value` - (String)
484
-
485
- # @!method create_dhcp_options(options = {})
486
- # Calls the CreateDhcpOptions API operation.
487
- # @param [Hash] options
488
- #
489
- # * `:dhcp_configurations` - *required* - (Array<Hash>) A set of one or
490
- # more DHCP configurations.
491
- # * `:key` - (String) Contains the name of a DHCP option.
492
- # * `:values` - (Array<String>) Contains a set of values for a DHCP
493
- # option.
494
- # @return [Core::Response]
495
- # The #data method of the response object returns
496
- # a hash with the following structure:
497
- #
498
- # * `:dhcp_options` - (Hash)
499
- # * `:dhcp_options_id` - (String)
500
- # * `:dhcp_configuration_set` - (Array<Hash>)
501
- # * `:key` - (String)
502
- # * `:value_set` - (Array<String>)
503
- # * `:tag_set` - (Array<Hash>)
504
- # * `:key` - (String)
505
- # * `:value` - (String)
506
-
507
- # @!method create_image(options = {})
508
- # Calls the CreateImage API operation.
509
- # @param [Hash] options
510
- #
511
- # * `:instance_id` - *required* - (String) The ID of the instance from
512
- # which to create the new image.
513
- # * `:name` - *required* - (String) The name for the new AMI being
514
- # created.
515
- # * `:description` - (String) The description for the new AMI being
516
- # created.
517
- # * `:no_reboot` - (Boolean) By default this property is set to `false`
518
- # , which means Amazon EC2 attempts to cleanly shut down the instance
519
- # before image creation and reboots the instance afterwards. When set
520
- # to `true` , Amazon EC2 will not shut down the instance before
521
- # creating the image. When this option is used, file system integrity
522
- # on the created image cannot be guaranteed.
523
- # * `:block_device_mappings` - (Array<Hash>)
524
- # * `:virtual_name` - (String) Specifies the virtual device name.
525
- # * `:device_name` - (String) Specifies the device name (e.g.,
526
- # /dev/sdh).
527
- # * `:ebs` - (Hash) Specifies parameters used to automatically setup
528
- # Amazon EBS volumes when the instance is launched.
529
- # * `:snapshot_id` - (String) The ID of the snapshot from which the
530
- # volume will be created.
531
- # * `:volume_size` - (Integer) The size of the volume, in
532
- # gigabytes.
533
- # * `:delete_on_termination` - (Boolean) Specifies whether the
534
- # Amazon EBS volume is deleted on instance termination.
535
- # * `:volume_type` - (String) Valid values include:
536
- # * `standard`
537
- # * `io1`
538
- # * `:iops` - (Integer)
539
- # * `:no_device` - (String) Specifies the device name to suppress
540
- # during instance launch.
541
- # @return [Core::Response]
542
- # The #data method of the response object returns
543
- # a hash with the following structure:
544
- #
545
- # * `:image_id` - (String)
546
-
547
- # @!method create_instance_export_task(options = {})
548
- # Calls the CreateInstanceExportTask API operation.
549
- # @param [Hash] options
550
- #
551
- # * `:description` - (String)
552
- # * `:instance_id` - *required* - (String)
553
- # * `:target_environment` - (String) Valid values include:
554
- # * `citrix`
555
- # * `vmware`
556
- # * `:export_to_s3_task` - (Hash)
557
- # * `:disk_image_format` - (String) Valid values include:
558
- # * `vmdk`
559
- # * `vhd`
560
- # * `:container_format` - (String) Valid values include:
561
- # * `ova`
562
- # * `:s3_bucket` - (String)
563
- # * `:s3_prefix` - (String)
564
- # @return [Core::Response]
565
- # The #data method of the response object returns
566
- # a hash with the following structure:
567
- #
568
- # * `:export_task` - (Hash)
569
- # * `:export_task_id` - (String)
570
- # * `:description` - (String)
571
- # * `:state` - (String)
572
- # * `:status_message` - (String)
573
- # * `:instance_export` - (Hash)
574
- # * `:instance_id` - (String)
575
- # * `:target_environment` - (String)
576
- # * `:export_to_s3` - (Hash)
577
- # * `:disk_image_format` - (String)
578
- # * `:container_format` - (String)
579
- # * `:s3_bucket` - (String)
580
- # * `:s3_key` - (String)
581
-
582
- # @!method create_internet_gateway(options = {})
583
- # Calls the CreateInternetGateway API operation.
584
- # @param [Hash] options
585
- #
586
- # @return [Core::Response]
587
- # The #data method of the response object returns
588
- # a hash with the following structure:
589
- #
590
- # * `:internet_gateway` - (Hash)
591
- # * `:internet_gateway_id` - (String)
592
- # * `:attachment_set` - (Array<Hash>)
593
- # * `:vpc_id` - (String)
594
- # * `:state` - (String)
595
- # * `:tag_set` - (Array<Hash>)
596
- # * `:key` - (String)
597
- # * `:value` - (String)
598
-
599
- # @!method create_key_pair(options = {})
600
- # Calls the CreateKeyPair API operation.
601
- # @param [Hash] options
602
- #
603
- # * `:key_name` - *required* - (String) The unique name for the new key
604
- # pair.
605
- # @return [Core::Response]
606
- # The #data method of the response object returns
607
- # a hash with the following structure:
608
- #
609
- # * `:key_pair` - (Hash)
610
- # * `:key_name` - (String)
611
- # * `:key_fingerprint` - (String)
612
- # * `:key_material` - (String)
613
-
614
- # @!method create_network_acl(options = {})
615
- # Calls the CreateNetworkAcl API operation.
616
- # @param [Hash] options
617
- #
618
- # * `:vpc_id` - *required* - (String) The ID of the VPC where the
619
- # network ACL will be created.
620
- # @return [Core::Response]
621
- # The #data method of the response object returns
622
- # a hash with the following structure:
623
- #
624
- # * `:network_acl` - (Hash)
625
- # * `:network_acl_id` - (String)
626
- # * `:vpc_id` - (String)
627
- # * `:default` - (Boolean)
628
- # * `:entry_set` - (Array<Hash>)
629
- # * `:rule_number` - (Integer)
630
- # * `:protocol` - (String)
631
- # * `:rule_action` - (String)
632
- # * `:egress` - (Boolean)
633
- # * `:cidr_block` - (String)
634
- # * `:icmp_type_code` - (Hash)
635
- # * `:type` - (Integer)
636
- # * `:code` - (Integer)
637
- # * `:port_range` - (Hash)
638
- # * `:from` - (Integer)
639
- # * `:to` - (Integer)
640
- # * `:association_set` - (Array<Hash>)
641
- # * `:network_acl_association_id` - (String)
642
- # * `:network_acl_id` - (String)
643
- # * `:subnet_id` - (String)
644
- # * `:tag_set` - (Array<Hash>)
645
- # * `:key` - (String)
646
- # * `:value` - (String)
647
-
648
- # @!method create_network_acl_entry(options = {})
649
- # Calls the CreateNetworkAclEntry API operation.
650
- # @param [Hash] options
651
- #
652
- # * `:network_acl_id` - *required* - (String) ID of the ACL where the
653
- # entry will be created.
654
- # * `:rule_number` - *required* - (Integer) Rule number to assign to
655
- # the entry (e.g., 100). ACL entries are processed in ascending order
656
- # by rule number.
657
- # * `:protocol` - *required* - (String) IP protocol the rule applies
658
- # to. Valid Values: tcp, udp, icmp or an IP protocol number.
659
- # * `:rule_action` - *required* - (String) Whether to allow or deny
660
- # traffic that matches the rule. Valid values include:
661
- # * `allow`
662
- # * `deny`
663
- # * `:egress` - *required* - (Boolean) Whether this rule applies to
664
- # egress traffic from the subnet ( `true` ) or ingress traffic to the
665
- # subnet ( `false` ).
666
- # * `:cidr_block` - *required* - (String) The CIDR range to allow or
667
- # deny, in CIDR notation (e.g., 172.16.0.0/24).
668
- # * `:icmp_type_code` - (Hash) ICMP values.
669
- # * `:type` - (Integer) For the ICMP protocol, the ICMP type. A value
670
- # of -1 is a wildcard meaning all types. Required if specifying
671
- # icmp for the protocol.
672
- # * `:code` - (Integer) For the ICMP protocol, the ICMP code. A value
673
- # of -1 is a wildcard meaning all codes. Required if specifying
674
- # icmp for the protocol.
675
- # * `:port_range` - (Hash) Port ranges.
676
- # * `:from` - (Integer) The first port in the range. Required if
677
- # specifying tcp or udp for the protocol.
678
- # * `:to` - (Integer) The last port in the range. Required if
679
- # specifying tcp or udp for the protocol.
680
- # @return [Core::Response]
681
-
682
- # @!method create_network_interface(options = {})
683
- # Calls the CreateNetworkInterface API operation.
684
- # @param [Hash] options
685
- #
686
- # * `:subnet_id` - *required* - (String)
687
- # * `:description` - (String)
688
- # * `:private_ip_address` - (String)
689
- # * `:groups` - (Array<String>)
690
- # * `:private_ip_addresses` - (Array<Hash>)
691
- # * `:private_ip_address` - *required* - (String)
692
- # * `:primary` - (Boolean)
693
- # * `:secondary_private_ip_address_count` - (Integer)
694
- # @return [Core::Response]
695
- # The #data method of the response object returns
696
- # a hash with the following structure:
697
- #
698
- # * `:network_interface` - (Hash)
699
- # * `:network_interface_id` - (String)
700
- # * `:subnet_id` - (String)
701
- # * `:vpc_id` - (String)
702
- # * `:availability_zone` - (String)
703
- # * `:description` - (String)
704
- # * `:owner_id` - (String)
705
- # * `:requester_id` - (String)
706
- # * `:requester_managed` - (Boolean)
707
- # * `:status` - (String)
708
- # * `:mac_address` - (String)
709
- # * `:private_ip_address` - (String)
710
- # * `:private_dns_name` - (String)
711
- # * `:source_dest_check` - (Boolean)
712
- # * `:group_set` - (Array<Hash>)
713
- # * `:group_name` - (String)
714
- # * `:group_id` - (String)
715
- # * `:attachment` - (Hash)
716
- # * `:attachment_id` - (String)
717
- # * `:instance_id` - (String)
718
- # * `:instance_owner_id` - (String)
719
- # * `:device_index` - (Integer)
720
- # * `:status` - (String)
721
- # * `:attach_time` - (Time)
722
- # * `:delete_on_termination` - (Boolean)
723
- # * `:association` - (Hash)
724
- # * `:public_ip` - (String)
725
- # * `:ip_owner_id` - (String)
726
- # * `:allocation_id` - (String)
727
- # * `:association_id` - (String)
728
- # * `:tag_set` - (Array<Hash>)
729
- # * `:key` - (String)
730
- # * `:value` - (String)
731
- # * `:private_ip_addresses_set` - (Array<Hash>)
732
- # * `:private_ip_address` - (String)
733
- # * `:private_dns_name` - (String)
734
- # * `:primary` - (Boolean)
735
- # * `:association` - (Hash)
736
- # * `:public_ip` - (String)
737
- # * `:ip_owner_id` - (String)
738
- # * `:allocation_id` - (String)
739
- # * `:association_id` - (String)
740
-
741
- # @!method create_placement_group(options = {})
742
- # Calls the CreatePlacementGroup API operation.
743
- # @param [Hash] options
744
- #
745
- # * `:group_name` - *required* - (String) The name of the
746
- # PlacementGroup.
747
- # * `:strategy` - *required* - (String) The PlacementGroup strategy.
748
- # Valid values include:
749
- # * `cluster`
750
- # @return [Core::Response]
751
-
752
- # @!method create_reserved_instances_listing(options = {})
753
- # Calls the CreateReservedInstancesListing API operation.
754
- # @param [Hash] options
755
- #
756
- # * `:reserved_instances_id` - *required* - (String)
757
- # * `:instance_count` - *required* - (Integer)
758
- # * `:price_schedules` - *required* - (Array<Hash>)
759
- # * `:term` - (Integer)
760
- # * `:price` - (Float)
761
- # * `:currency_code` - (String)
762
- # * `:client_token` - *required* - (String)
763
- # @return [Core::Response]
764
- # The #data method of the response object returns
765
- # a hash with the following structure:
766
- #
767
- # * `:reserved_instances_listings_set` - (Array<Hash>)
768
- # * `:reserved_instances_listing_id` - (String)
769
- # * `:reserved_instances_id` - (String)
770
- # * `:create_date` - (Time)
771
- # * `:update_date` - (Time)
772
- # * `:status` - (String)
773
- # * `:status_message` - (String)
774
- # * `:instance_counts` - (Array<Hash>)
775
- # * `:state` - (String)
776
- # * `:instance_count` - (Integer)
777
- # * `:price_schedules` - (Array<Hash>)
778
- # * `:term` - (Integer)
779
- # * `:price` - (Numeric)
780
- # * `:currency_code` - (String)
781
- # * `:active` - (Boolean)
782
- # * `:tag_set` - (Array<Hash>)
783
- # * `:key` - (String)
784
- # * `:value` - (String)
785
- # * `:client_token` - (String)
786
-
787
- # @!method create_route(options = {})
788
- # Calls the CreateRoute API operation.
789
- # @param [Hash] options
790
- #
791
- # * `:route_table_id` - *required* - (String) The ID of the route table
792
- # where the route will be added.
793
- # * `:destination_cidr_block` - *required* - (String) The CIDR address
794
- # block used for the destination match. For example: 0.0.0.0/0.
795
- # Routing decisions are based on the most specific match.
796
- # * `:gateway_id` - (String) The ID of a VPN or Internet gateway
797
- # attached to your VPC. You must provide either GatewayId or
798
- # InstanceId, but not both.
799
- # * `:instance_id` - (String) The ID of a NAT instance in your VPC. You
800
- # must provide either GatewayId or InstanceId, but not both.
801
- # * `:network_interface_id` - (String)
802
- # @return [Core::Response]
803
-
804
- # @!method create_route_table(options = {})
805
- # Calls the CreateRouteTable API operation.
806
- # @param [Hash] options
807
- #
808
- # * `:vpc_id` - *required* - (String) The ID of the VPC where the route
809
- # table will be created.
810
- # @return [Core::Response]
811
- # The #data method of the response object returns
812
- # a hash with the following structure:
813
- #
814
- # * `:route_table` - (Hash)
815
- # * `:route_table_id` - (String)
816
- # * `:vpc_id` - (String)
817
- # * `:route_set` - (Array<Hash>)
818
- # * `:destination_cidr_block` - (String)
819
- # * `:gateway_id` - (String)
820
- # * `:instance_id` - (String)
821
- # * `:instance_owner_id` - (String)
822
- # * `:network_interface_id` - (String)
823
- # * `:state` - (String)
824
- # * `:association_set` - (Array<Hash>)
825
- # * `:route_table_association_id` - (String)
826
- # * `:route_table_id` - (String)
827
- # * `:subnet_id` - (String)
828
- # * `:main` - (Boolean)
829
- # * `:tag_set` - (Array<Hash>)
830
- # * `:key` - (String)
831
- # * `:value` - (String)
832
- # * `:propagating_vgw_set` - (Array<Hash>)
833
- # * `:gateway_id` - (String)
834
-
835
- # @!method create_security_group(options = {})
836
- # Calls the CreateSecurityGroup API operation.
837
- # @param [Hash] options
838
- #
839
- # * `:group_name` - *required* - (String) Name of the security group.
840
- # * `:description` - *required* - (String) Description of the group.
841
- # This is informational only.
842
- # * `:vpc_id` - (String) ID of the VPC.
843
- # @return [Core::Response]
844
- # The #data method of the response object returns
845
- # a hash with the following structure:
846
- #
847
- # * `:group_id` - (String)
848
-
849
- # @!method create_snapshot(options = {})
850
- # Calls the CreateSnapshot API operation.
851
- # @param [Hash] options
852
- #
853
- # * `:volume_id` - *required* - (String) The ID of the volume from
854
- # which to create the snapshot.
855
- # * `:description` - (String) The description for the new snapshot.
856
- # @return [Core::Response]
857
- # The #data method of the response object returns
858
- # a hash with the following structure:
859
- #
860
- # * `:snapshot_id` - (String)
861
- # * `:volume_id` - (String)
862
- # * `:status` - (String)
863
- # * `:start_time` - (Time)
864
- # * `:progress` - (String)
865
- # * `:owner_id` - (String)
866
- # * `:description` - (String)
867
- # * `:volume_size` - (Integer)
868
- # * `:owner_alias` - (String)
869
- # * `:tag_set` - (Array<Hash>)
870
- # * `:key` - (String)
871
- # * `:value` - (String)
872
-
873
- # @!method create_spot_datafeed_subscription(options = {})
874
- # Calls the CreateSpotDatafeedSubscription API operation.
875
- # @param [Hash] options
876
- #
877
- # * `:bucket` - *required* - (String) The Amazon S3 bucket in which to
878
- # store the Spot Instance datafeed.
879
- # * `:prefix` - (String) The prefix that is prepended to datafeed
880
- # files.
881
- # @return [Core::Response]
882
- # The #data method of the response object returns
883
- # a hash with the following structure:
884
- #
885
- # * `:spot_datafeed_subscription` - (Hash)
886
- # * `:owner_id` - (String)
887
- # * `:bucket` - (String)
888
- # * `:prefix` - (String)
889
- # * `:state` - (String)
890
- # * `:fault` - (Hash)
891
- # * `:code` - (String)
892
- # * `:message` - (String)
893
-
894
- # @!method create_subnet(options = {})
895
- # Calls the CreateSubnet API operation.
896
- # @param [Hash] options
897
- #
898
- # * `:vpc_id` - *required* - (String) The ID of the VPC to create the
899
- # subnet in.
900
- # * `:cidr_block` - *required* - (String) The CIDR block the subnet is
901
- # to cover.
902
- # * `:availability_zone` - (String) The Availability Zone to create the
903
- # subnet in.
904
- # @return [Core::Response]
905
- # The #data method of the response object returns
906
- # a hash with the following structure:
907
- #
908
- # * `:subnet` - (Hash)
909
- # * `:subnet_id` - (String)
910
- # * `:state` - (String)
911
- # * `:vpc_id` - (String)
912
- # * `:cidr_block` - (String)
913
- # * `:available_ip_address_count` - (Integer)
914
- # * `:availability_zone` - (String)
915
- # * `:default_for_az` - (Boolean)
916
- # * `:map_public_ip_on_launch` - (Boolean)
917
- # * `:tag_set` - (Array<Hash>)
918
- # * `:key` - (String)
919
- # * `:value` - (String)
920
-
921
- # @!method create_tags(options = {})
922
- # Calls the CreateTags API operation.
923
- # @param [Hash] options
924
- #
925
- # * `:resources` - *required* - (Array<String>) One or more IDs of
926
- # resources to tag. This could be the ID of an AMI, an instance, an
927
- # EBS volume, or snapshot, etc.
928
- # * `:tags` - *required* - (Array<Hash>) The tags to add or overwrite
929
- # for the specified resources. Each tag item consists of a key-value
930
- # pair.
931
- # * `:key` - (String) The tag's key.
932
- # * `:value` - (String) The tag's value.
933
- # @return [Core::Response]
934
-
935
- # @!method create_volume(options = {})
936
- # Calls the CreateVolume API operation.
937
- # @param [Hash] options
938
- #
939
- # * `:size` - (Integer) The size of the volume, in gigabytes. Required
940
- # if you are not creating a volume from a snapshot.
941
- # * `:snapshot_id` - (String) The ID of the snapshot from which to
942
- # create the new volume.
943
- # * `:availability_zone` - *required* - (String) The Availability Zone
944
- # in which to create the new volume.
945
- # * `:volume_type` - (String) Valid values include:
946
- # * `standard`
947
- # * `io1`
948
- # * `:iops` - (Integer)
949
- # @return [Core::Response]
950
- # The #data method of the response object returns
951
- # a hash with the following structure:
952
- #
953
- # * `:volume_id` - (String)
954
- # * `:size` - (Integer)
955
- # * `:snapshot_id` - (String)
956
- # * `:availability_zone` - (String)
957
- # * `:status` - (String)
958
- # * `:create_time` - (Time)
959
- # * `:attachment_set` - (Array<Hash>)
960
- # * `:volume_id` - (String)
961
- # * `:instance_id` - (String)
962
- # * `:device` - (String)
963
- # * `:status` - (String)
964
- # * `:attach_time` - (Time)
965
- # * `:delete_on_termination` - (Boolean)
966
- # * `:tag_set` - (Array<Hash>)
967
- # * `:key` - (String)
968
- # * `:value` - (String)
969
- # * `:volume_type` - (String)
970
- # * `:iops` - (Integer)
971
-
972
- # @!method create_vpc(options = {})
973
- # Calls the CreateVpc API operation.
974
- # @param [Hash] options
975
- #
976
- # * `:cidr_block` - *required* - (String) A valid CIDR block.
977
- # * `:instance_tenancy` - (String) The allowed tenancy of instances
978
- # launched into the VPC. A value of default means instances can be
979
- # launched with any tenancy; a value of dedicated means instances
980
- # must be launched with tenancy as dedicated.
981
- # @return [Core::Response]
982
- # The #data method of the response object returns
983
- # a hash with the following structure:
984
- #
985
- # * `:vpc` - (Hash)
986
- # * `:vpc_id` - (String)
987
- # * `:state` - (String)
988
- # * `:cidr_block` - (String)
989
- # * `:dhcp_options_id` - (String)
990
- # * `:tag_set` - (Array<Hash>)
991
- # * `:key` - (String)
992
- # * `:value` - (String)
993
- # * `:instance_tenancy` - (String)
994
- # * `:is_default` - (Boolean)
995
-
996
- # @!method create_vpn_connection(options = {})
997
- # Calls the CreateVpnConnection API operation.
998
- # @param [Hash] options
999
- #
1000
- # * `:type` - *required* - (String) The type of VPN connection.
1001
- # * `:customer_gateway_id` - *required* - (String) The ID of the
1002
- # customer gateway.
1003
- # * `:vpn_gateway_id` - *required* - (String) The ID of the VPN
1004
- # gateway.
1005
- # * `:options` - (Hash)
1006
- # * `:static_routes_only` - (Boolean)
1007
- # @return [Core::Response]
1008
- # The #data method of the response object returns
1009
- # a hash with the following structure:
1010
- #
1011
- # * `:vpn_connection` - (Hash)
1012
- # * `:vpn_connection_id` - (String)
1013
- # * `:state` - (String)
1014
- # * `:customer_gateway_configuration` - (String)
1015
- # * `:type` - (String)
1016
- # * `:customer_gateway_id` - (String)
1017
- # * `:vpn_gateway_id` - (String)
1018
- # * `:tag_set` - (Array<Hash>)
1019
- # * `:key` - (String)
1020
- # * `:value` - (String)
1021
- # * `:vgw_telemetry` - (Array<Hash>)
1022
- # * `:outside_ip_address` - (String)
1023
- # * `:status` - (String)
1024
- # * `:last_status_change` - (Time)
1025
- # * `:status_message` - (String)
1026
- # * `:accepted_route_count` - (Integer)
1027
- # * `:options` - (Hash)
1028
- # * `:static_routes_only` - (Boolean)
1029
- # * `:routes` - (Array<Hash>)
1030
- # * `:destination_cidr_block` - (String)
1031
- # * `:source` - (String)
1032
- # * `:state` - (String)
1033
-
1034
- # @!method create_vpn_connection_route(options = {})
1035
- # Calls the CreateVpnConnectionRoute API operation.
1036
- # @param [Hash] options
1037
- #
1038
- # * `:vpn_connection_id` - *required* - (String)
1039
- # * `:destination_cidr_block` - *required* - (String)
1040
- # @return [Core::Response]
1041
-
1042
- # @!method create_vpn_gateway(options = {})
1043
- # Calls the CreateVpnGateway API operation.
1044
- # @param [Hash] options
1045
- #
1046
- # * `:type` - *required* - (String) The type of VPN connection this VPN
1047
- # gateway supports.
1048
- # * `:availability_zone` - (String) The Availability Zone in which to
1049
- # create the VPN gateway.
1050
- # @return [Core::Response]
1051
- # The #data method of the response object returns
1052
- # a hash with the following structure:
1053
- #
1054
- # * `:vpn_gateway` - (Hash)
1055
- # * `:vpn_gateway_id` - (String)
1056
- # * `:state` - (String)
1057
- # * `:vpn_type` - (String)
1058
- # * `:availability_zone` - (String)
1059
- # * `:attachments` - (Array<Hash>)
1060
- # * `:vpc_id` - (String)
1061
- # * `:state` - (String)
1062
- # * `:tag_set` - (Array<Hash>)
1063
- # * `:key` - (String)
1064
- # * `:value` - (String)
1065
-
1066
- # @!method deactivate_license(options = {})
1067
- # Calls the DeactivateLicense API operation.
1068
- # @param [Hash] options
1069
- #
1070
- # * `:license_id` - *required* - (String) Specifies the ID for the
1071
- # specific license to deactivate against.
1072
- # * `:capacity` - *required* - (Integer) Specifies the amount of
1073
- # capacity to deactivate against the license.
1074
- # @return [Core::Response]
1075
-
1076
- # @!method delete_customer_gateway(options = {})
1077
- # Calls the DeleteCustomerGateway API operation.
1078
- # @param [Hash] options
1079
- #
1080
- # * `:customer_gateway_id` - *required* - (String) The ID of the
1081
- # customer gateway to delete.
1082
- # @return [Core::Response]
1083
-
1084
- # @!method delete_dhcp_options(options = {})
1085
- # Calls the DeleteDhcpOptions API operation.
1086
- # @param [Hash] options
1087
- #
1088
- # * `:dhcp_options_id` - *required* - (String) The ID of the DHCP
1089
- # options set to delete.
1090
- # @return [Core::Response]
1091
-
1092
- # @!method delete_internet_gateway(options = {})
1093
- # Calls the DeleteInternetGateway API operation.
1094
- # @param [Hash] options
1095
- #
1096
- # * `:internet_gateway_id` - *required* - (String) The ID of the
1097
- # Internet gateway to be deleted.
1098
- # @return [Core::Response]
1099
-
1100
- # @!method delete_key_pair(options = {})
1101
- # Calls the DeleteKeyPair API operation.
1102
- # @param [Hash] options
1103
- #
1104
- # * `:key_name` - *required* - (String) The name of the Amazon EC2 key
1105
- # pair to delete.
1106
- # @return [Core::Response]
1107
-
1108
- # @!method delete_network_acl(options = {})
1109
- # Calls the DeleteNetworkAcl API operation.
1110
- # @param [Hash] options
1111
- #
1112
- # * `:network_acl_id` - *required* - (String) The ID of the network ACL
1113
- # to be deleted.
1114
- # @return [Core::Response]
1115
-
1116
- # @!method delete_network_acl_entry(options = {})
1117
- # Calls the DeleteNetworkAclEntry API operation.
1118
- # @param [Hash] options
1119
- #
1120
- # * `:network_acl_id` - *required* - (String) ID of the network ACL.
1121
- # * `:rule_number` - *required* - (Integer) Rule number for the entry
1122
- # to delete.
1123
- # * `:egress` - *required* - (Boolean) Whether the rule to delete is an
1124
- # egress rule ( `true` ) or ingress rule ( `false` ).
1125
- # @return [Core::Response]
1126
-
1127
- # @!method delete_network_interface(options = {})
1128
- # Calls the DeleteNetworkInterface API operation.
1129
- # @param [Hash] options
1130
- #
1131
- # * `:network_interface_id` - *required* - (String)
1132
- # @return [Core::Response]
1133
-
1134
- # @!method delete_placement_group(options = {})
1135
- # Calls the DeletePlacementGroup API operation.
1136
- # @param [Hash] options
1137
- #
1138
- # * `:group_name` - *required* - (String) The name of the
1139
- # PlacementGroup to delete.
1140
- # @return [Core::Response]
1141
-
1142
- # @!method delete_route(options = {})
1143
- # Calls the DeleteRoute API operation.
1144
- # @param [Hash] options
1145
- #
1146
- # * `:route_table_id` - *required* - (String) The ID of the route table
1147
- # where the route will be deleted.
1148
- # * `:destination_cidr_block` - *required* - (String) The CIDR range
1149
- # for the route you want to delete. The value you specify must
1150
- # exactly match the CIDR for the route you want to delete.
1151
- # @return [Core::Response]
1152
-
1153
- # @!method delete_route_table(options = {})
1154
- # Calls the DeleteRouteTable API operation.
1155
- # @param [Hash] options
1156
- #
1157
- # * `:route_table_id` - *required* - (String) The ID of the route table
1158
- # to be deleted.
1159
- # @return [Core::Response]
1160
-
1161
- # @!method delete_security_group(options = {})
1162
- # Calls the DeleteSecurityGroup API operation.
1163
- # @param [Hash] options
1164
- #
1165
- # * `:group_name` - (String) The name of the Amazon EC2 security group
1166
- # to delete.
1167
- # * `:group_id` - (String) The ID of the Amazon EC2 security group to
1168
- # delete.
1169
- # @return [Core::Response]
1170
-
1171
- # @!method delete_snapshot(options = {})
1172
- # Calls the DeleteSnapshot API operation.
1173
- # @param [Hash] options
1174
- #
1175
- # * `:snapshot_id` - *required* - (String) The ID of the snapshot to
1176
- # delete.
1177
- # @return [Core::Response]
1178
-
1179
- # @!method delete_spot_datafeed_subscription(options = {})
1180
- # Calls the DeleteSpotDatafeedSubscription API operation.
1181
- # @param [Hash] options
1182
- #
1183
- # @return [Core::Response]
1184
-
1185
- # @!method delete_subnet(options = {})
1186
- # Calls the DeleteSubnet API operation.
1187
- # @param [Hash] options
1188
- #
1189
- # * `:subnet_id` - *required* - (String) The ID of the subnet you want
1190
- # to delete.
1191
- # @return [Core::Response]
1192
-
1193
- # @!method delete_tags(options = {})
1194
- # Calls the DeleteTags API operation.
1195
- # @param [Hash] options
1196
- #
1197
- # * `:resources` - *required* - (Array<String>) A list of one or more
1198
- # resource IDs. This could be the ID of an AMI, an instance, an EBS
1199
- # volume, or snapshot, etc.
1200
- # * `:tags` - (Array<Hash>) The tags to delete from the specified
1201
- # resources. Each tag item consists of a key-value pair. If a tag is
1202
- # specified without a value, the tag and all of its values are
1203
- # deleted.
1204
- # * `:key` - (String) The tag's key.
1205
- # * `:value` - (String) The tag's value.
1206
- # @return [Core::Response]
1207
-
1208
- # @!method delete_volume(options = {})
1209
- # Calls the DeleteVolume API operation.
1210
- # @param [Hash] options
1211
- #
1212
- # * `:volume_id` - *required* - (String) The ID of the EBS volume to
1213
- # delete.
1214
- # @return [Core::Response]
1215
-
1216
- # @!method delete_vpc(options = {})
1217
- # Calls the DeleteVpc API operation.
1218
- # @param [Hash] options
1219
- #
1220
- # * `:vpc_id` - *required* - (String) The ID of the VPC you want to
1221
- # delete.
1222
- # @return [Core::Response]
1223
-
1224
- # @!method delete_vpn_connection(options = {})
1225
- # Calls the DeleteVpnConnection API operation.
1226
- # @param [Hash] options
1227
- #
1228
- # * `:vpn_connection_id` - *required* - (String) The ID of the VPN
1229
- # connection to delete
1230
- # @return [Core::Response]
1231
-
1232
- # @!method delete_vpn_connection_route(options = {})
1233
- # Calls the DeleteVpnConnectionRoute API operation.
1234
- # @param [Hash] options
1235
- #
1236
- # * `:vpn_connection_id` - *required* - (String)
1237
- # * `:destination_cidr_block` - *required* - (String)
1238
- # @return [Core::Response]
1239
-
1240
- # @!method delete_vpn_gateway(options = {})
1241
- # Calls the DeleteVpnGateway API operation.
1242
- # @param [Hash] options
1243
- #
1244
- # * `:vpn_gateway_id` - *required* - (String) The ID of the VPN gateway
1245
- # to delete.
1246
- # @return [Core::Response]
1247
-
1248
- # @!method deregister_image(options = {})
1249
- # Calls the DeregisterImage API operation.
1250
- # @param [Hash] options
1251
- #
1252
- # * `:image_id` - *required* - (String) The ID of the AMI to
1253
- # deregister.
1254
- # @return [Core::Response]
1255
-
1256
- # @!method describe_account_attributes(options = {})
1257
- # Calls the DescribeAccountAttributes API operation.
1258
- # @param [Hash] options
1259
- #
1260
- # * `:attribute_names` - (Array<String>)
1261
- # @return [Core::Response]
1262
- # The #data method of the response object returns
1263
- # a hash with the following structure:
1264
- #
1265
- # * `:account_attribute_set` - (Array<Hash>)
1266
- # * `:attribute_name` - (String)
1267
- # * `:attribute_value_set` - (Array<Hash>)
1268
- # * `:attribute_value` - (String)
1269
-
1270
- # @!method describe_addresses(options = {})
1271
- # Calls the DescribeAddresses API operation.
1272
- # @param [Hash] options
1273
- #
1274
- # * `:public_ips` - (Array<String>) The optional list of Elastic IP
1275
- # addresses to describe.
1276
- # * `:filters` - (Array<Hash>) A list of filters used to match
1277
- # properties for Addresses. For a complete reference to the available
1278
- # filter keys for this operation, see the Amazon EC2 API reference.
1279
- # * `:name` - (String) Specifies the name of the filter.
1280
- # * `:values` - (Array<String>) Contains one or more values for the
1281
- # filter.
1282
- # * `:allocation_ids` - (Array<String>)
1283
- # @return [Core::Response]
1284
- # The #data method of the response object returns
1285
- # a hash with the following structure:
1286
- #
1287
- # * `:addresses_set` - (Array<Hash>)
1288
- # * `:instance_id` - (String)
1289
- # * `:public_ip` - (String)
1290
- # * `:allocation_id` - (String)
1291
- # * `:association_id` - (String)
1292
- # * `:domain` - (String)
1293
- # * `:network_interface_id` - (String)
1294
- # * `:network_interface_owner_id` - (String)
1295
- # * `:private_ip_address` - (String)
1296
-
1297
- # @!method describe_availability_zones(options = {})
1298
- # Calls the DescribeAvailabilityZones API operation.
1299
- # @param [Hash] options
1300
- #
1301
- # * `:zone_names` - (Array<String>) A list of the availability zone
1302
- # names to describe.
1303
- # * `:filters` - (Array<Hash>) A list of filters used to match
1304
- # properties for AvailabilityZones. For a complete reference to the
1305
- # available filter keys for this operation, see the Amazon EC2 API
1306
- # reference.
1307
- # * `:name` - (String) Specifies the name of the filter.
1308
- # * `:values` - (Array<String>) Contains one or more values for the
1309
- # filter.
1310
- # @return [Core::Response]
1311
- # The #data method of the response object returns
1312
- # a hash with the following structure:
1313
- #
1314
- # * `:availability_zone_info` - (Array<Hash>)
1315
- # * `:zone_name` - (String)
1316
- # * `:zone_state` - (String)
1317
- # * `:region_name` - (String)
1318
- # * `:message_set` - (Array<Hash>)
1319
- # * `:message` - (String)
1320
-
1321
- # @!method describe_bundle_tasks(options = {})
1322
- # Calls the DescribeBundleTasks API operation.
1323
- # @param [Hash] options
1324
- #
1325
- # * `:bundle_ids` - (Array<String>) The list of bundle task IDs to
1326
- # describe.
1327
- # * `:filters` - (Array<Hash>) A list of filters used to match
1328
- # properties for BundleTasks. For a complete reference to the
1329
- # available filter keys for this operation, see the Amazon EC2 API
1330
- # reference.
1331
- # * `:name` - (String) Specifies the name of the filter.
1332
- # * `:values` - (Array<String>) Contains one or more values for the
1333
- # filter.
1334
- # @return [Core::Response]
1335
- # The #data method of the response object returns
1336
- # a hash with the following structure:
1337
- #
1338
- # * `:bundle_instance_tasks_set` - (Array<Hash>)
1339
- # * `:instance_id` - (String)
1340
- # * `:bundle_id` - (String)
1341
- # * `:state` - (String)
1342
- # * `:start_time` - (Time)
1343
- # * `:update_time` - (Time)
1344
- # * `:storage` - (Hash)
1345
- # * `:s3` - (Hash)
1346
- # * `:bucket` - (String)
1347
- # * `:prefix` - (String)
1348
- # * `:aws_access_key_id` - (String)
1349
- # * `:upload_policy` - (String)
1350
- # * `:upload_policy_signature` - (String)
1351
- # * `:progress` - (String)
1352
- # * `:error` - (Hash)
1353
- # * `:code` - (String)
1354
- # * `:message` - (String)
1355
-
1356
- # @!method describe_conversion_tasks(options = {})
1357
- # Calls the DescribeConversionTasks API operation.
1358
- # @param [Hash] options
1359
- #
1360
- # * `:filters` - (Array<Hash>)
1361
- # * `:name` - (String) Specifies the name of the filter.
1362
- # * `:values` - (Array<String>) Contains one or more values for the
1363
- # filter.
1364
- # * `:conversion_task_ids` - (Array<String>)
1365
- # @return [Core::Response]
1366
- # The #data method of the response object returns
1367
- # a hash with the following structure:
1368
- #
1369
- # * `:conversion_tasks` - (Array<Hash>)
1370
- # * `:conversion_task_id` - (String)
1371
- # * `:expiration_time` - (String)
1372
- # * `:import_instance` - (Hash)
1373
- # * `:volumes` - (Array<Hash>)
1374
- # * `:bytes_converted` - (Integer)
1375
- # * `:availability_zone` - (String)
1376
- # * `:image` - (Hash)
1377
- # * `:format` - (String)
1378
- # * `:size` - (Integer)
1379
- # * `:import_manifest_url` - (String)
1380
- # * `:checksum` - (String)
1381
- # * `:volume` - (Hash)
1382
- # * `:size` - (Integer)
1383
- # * `:id` - (String)
1384
- # * `:status` - (String)
1385
- # * `:status_message` - (String)
1386
- # * `:description` - (String)
1387
- # * `:instance_id` - (String)
1388
- # * `:platform` - (String)
1389
- # * `:description` - (String)
1390
- # * `:import_volume` - (Hash)
1391
- # * `:bytes_converted` - (Integer)
1392
- # * `:availability_zone` - (String)
1393
- # * `:description` - (String)
1394
- # * `:image` - (Hash)
1395
- # * `:format` - (String)
1396
- # * `:size` - (Integer)
1397
- # * `:import_manifest_url` - (String)
1398
- # * `:checksum` - (String)
1399
- # * `:volume` - (Hash)
1400
- # * `:size` - (Integer)
1401
- # * `:id` - (String)
1402
- # * `:state` - (String)
1403
- # * `:status_message` - (String)
1404
- # * `:tag_set` - (Array<Hash>)
1405
- # * `:key` - (String)
1406
- # * `:value` - (String)
1407
-
1408
- # @!method describe_customer_gateways(options = {})
1409
- # Calls the DescribeCustomerGateways API operation.
1410
- # @param [Hash] options
1411
- #
1412
- # * `:customer_gateway_ids` - (Array<String>) A set of one or more
1413
- # customer gateway IDs.
1414
- # * `:filters` - (Array<Hash>) A list of filters used to match
1415
- # properties for Customer Gateways. For a complete reference to the
1416
- # available filter keys for this operation, see the Amazon EC2 API
1417
- # reference.
1418
- # * `:name` - (String) Specifies the name of the filter.
1419
- # * `:values` - (Array<String>) Contains one or more values for the
1420
- # filter.
1421
- # @return [Core::Response]
1422
- # The #data method of the response object returns
1423
- # a hash with the following structure:
1424
- #
1425
- # * `:customer_gateway_set` - (Array<Hash>)
1426
- # * `:customer_gateway_id` - (String)
1427
- # * `:state` - (String)
1428
- # * `:vpn_type` - (String)
1429
- # * `:ip_address` - (String)
1430
- # * `:bgp_asn` - (String)
1431
- # * `:tag_set` - (Array<Hash>)
1432
- # * `:key` - (String)
1433
- # * `:value` - (String)
1434
-
1435
- # @!method describe_dhcp_options(options = {})
1436
- # Calls the DescribeDhcpOptions API operation.
1437
- # @param [Hash] options
1438
- #
1439
- # * `:dhcp_options_ids` - (Array<String>)
1440
- # * `:filters` - (Array<Hash>) A list of filters used to match
1441
- # properties for DhcpOptions. For a complete reference to the
1442
- # available filter keys for this operation, see the Amazon EC2 API
1443
- # reference.
1444
- # * `:name` - (String) Specifies the name of the filter.
1445
- # * `:values` - (Array<String>) Contains one or more values for the
1446
- # filter.
1447
- # @return [Core::Response]
1448
- # The #data method of the response object returns
1449
- # a hash with the following structure:
1450
- #
1451
- # * `:dhcp_options_set` - (Array<Hash>)
1452
- # * `:dhcp_options_id` - (String)
1453
- # * `:dhcp_configuration_set` - (Array<Hash>)
1454
- # * `:key` - (String)
1455
- # * `:value_set` - (Array<String>)
1456
- # * `:tag_set` - (Array<Hash>)
1457
- # * `:key` - (String)
1458
- # * `:value` - (String)
1459
-
1460
- # @!method describe_export_tasks(options = {})
1461
- # Calls the DescribeExportTasks API operation.
1462
- # @param [Hash] options
1463
- #
1464
- # * `:export_task_ids` - (Array<String>)
1465
- # @return [Core::Response]
1466
- # The #data method of the response object returns
1467
- # a hash with the following structure:
1468
- #
1469
- # * `:export_task_set` - (Array<Hash>)
1470
- # * `:export_task_id` - (String)
1471
- # * `:description` - (String)
1472
- # * `:state` - (String)
1473
- # * `:status_message` - (String)
1474
- # * `:instance_export` - (Hash)
1475
- # * `:instance_id` - (String)
1476
- # * `:target_environment` - (String)
1477
- # * `:export_to_s3` - (Hash)
1478
- # * `:disk_image_format` - (String)
1479
- # * `:container_format` - (String)
1480
- # * `:s3_bucket` - (String)
1481
- # * `:s3_key` - (String)
1482
-
1483
- # @!method describe_image_attribute(options = {})
1484
- # Calls the DescribeImageAttribute API operation.
1485
- # @param [Hash] options
1486
- #
1487
- # * `:image_id` - *required* - (String) The ID of the AMI whose
1488
- # attribute is to be described.
1489
- # * `:attribute` - *required* - (String) The name of the attribute to
1490
- # describe. Available attribute names: productCodes, kernel, ramdisk,
1491
- # launchPermisson, blockDeviceMapping
1492
- # @return [Core::Response]
1493
- # The #data method of the response object returns
1494
- # a hash with the following structure:
1495
- #
1496
- # * `:image_id` - (String)
1497
- # * `:launch_permission` - (Array<Hash>)
1498
- # * `:user_id` - (String)
1499
- # * `:group` - (String)
1500
- # * `:product_codes` - (Array<Hash>)
1501
- # * `:product_code` - (String)
1502
- # * `:type` - (String)
1503
- # * `:kernel` - (Hash)
1504
- # * `:value` - (String)
1505
- # * `:ramdisk` - (Hash)
1506
- # * `:value` - (String)
1507
- # * `:description` - (Hash)
1508
- # * `:value` - (String)
1509
- # * `:block_device_mapping` - (Array<Hash>)
1510
- # * `:virtual_name` - (String)
1511
- # * `:device_name` - (String)
1512
- # * `:ebs` - (Hash)
1513
- # * `:snapshot_id` - (String)
1514
- # * `:volume_size` - (Integer)
1515
- # * `:delete_on_termination` - (Boolean)
1516
- # * `:volume_type` - (String)
1517
- # * `:iops` - (Integer)
1518
- # * `:no_device` - (String)
1519
-
1520
- # @!method describe_images(options = {})
1521
- # Calls the DescribeImages API operation.
1522
- # @param [Hash] options
1523
- #
1524
- # * `:image_ids` - (Array<String>) An optional list of the AMI IDs to
1525
- # describe. If not specified, all AMIs will be described.
1526
- # * `:owners` - (Array<String>) The optional list of owners for the
1527
- # described AMIs. The IDs amazon, self, and explicit can be used to
1528
- # include AMIs owned by Amazon, AMIs owned by the user, and AMIs for
1529
- # which the user has explicit launch permissions, respectively.
1530
- # * `:executable_users` - (Array<String>) The optional list of users
1531
- # with explicit launch permissions for the described AMIs. The user
1532
- # ID can be a user's account ID, 'self' to return AMIs for which the
1533
- # sender of the request has explicit launch permissions, or 'all' to
1534
- # return AMIs with public launch permissions.
1535
- # * `:filters` - (Array<Hash>) A list of filters used to match
1536
- # properties for Images. For a complete reference to the available
1537
- # filter keys for this operation, see the Amazon EC2 API reference.
1538
- # * `:name` - (String) Specifies the name of the filter.
1539
- # * `:values` - (Array<String>) Contains one or more values for the
1540
- # filter.
1541
- # @return [Core::Response]
1542
- # The #data method of the response object returns
1543
- # a hash with the following structure:
1544
- #
1545
- # * `:images_set` - (Array<Hash>)
1546
- # * `:image_id` - (String)
1547
- # * `:image_location` - (String)
1548
- # * `:image_state` - (String)
1549
- # * `:image_owner_id` - (String)
1550
- # * `:is_public` - (Boolean)
1551
- # * `:product_codes` - (Array<Hash>)
1552
- # * `:product_code` - (String)
1553
- # * `:type` - (String)
1554
- # * `:architecture` - (String)
1555
- # * `:image_type` - (String)
1556
- # * `:kernel_id` - (String)
1557
- # * `:ramdisk_id` - (String)
1558
- # * `:platform` - (String)
1559
- # * `:state_reason` - (Hash)
1560
- # * `:code` - (String)
1561
- # * `:message` - (String)
1562
- # * `:image_owner_alias` - (String)
1563
- # * `:name` - (String)
1564
- # * `:description` - (String)
1565
- # * `:root_device_type` - (String)
1566
- # * `:root_device_name` - (String)
1567
- # * `:block_device_mapping` - (Array<Hash>)
1568
- # * `:virtual_name` - (String)
1569
- # * `:device_name` - (String)
1570
- # * `:ebs` - (Hash)
1571
- # * `:snapshot_id` - (String)
1572
- # * `:volume_size` - (Integer)
1573
- # * `:delete_on_termination` - (Boolean)
1574
- # * `:volume_type` - (String)
1575
- # * `:iops` - (Integer)
1576
- # * `:no_device` - (String)
1577
- # * `:virtualization_type` - (String)
1578
- # * `:tag_set` - (Array<Hash>)
1579
- # * `:key` - (String)
1580
- # * `:value` - (String)
1581
- # * `:hypervisor` - (String)
1582
-
1583
- # @!method describe_instance_attribute(options = {})
1584
- # Calls the DescribeInstanceAttribute API operation.
1585
- # @param [Hash] options
1586
- #
1587
- # * `:instance_id` - *required* - (String) The ID of the instance whose
1588
- # instance attribute is being described.
1589
- # * `:attribute` - *required* - (String) The name of the attribute to
1590
- # describe. Available attribute names: instanceType, kernel, ramdisk,
1591
- # userData, disableApiTermination, instanceInitiatedShutdownBehavior,
1592
- # rootDeviceName, blockDeviceMapping Valid values include:
1593
- # * `instanceType`
1594
- # * `kernel`
1595
- # * `ramdisk`
1596
- # * `userData`
1597
- # * `disableApiTermination`
1598
- # * `instanceInitiatedShutdownBehavior`
1599
- # * `rootDeviceName`
1600
- # * `blockDeviceMapping`
1601
- # * `productCodes`
1602
- # * `sourceDestCheck`
1603
- # * `groupSet`
1604
- # * `ebsOptimized`
1605
- # @return [Core::Response]
1606
- # The #data method of the response object returns
1607
- # a hash with the following structure:
1608
- #
1609
- # * `:instance_id` - (String)
1610
- # * `:instance_type` - (Hash)
1611
- # * `:value` - (String)
1612
- # * `:kernel` - (Hash)
1613
- # * `:value` - (String)
1614
- # * `:ramdisk` - (Hash)
1615
- # * `:value` - (String)
1616
- # * `:user_data` - (Hash)
1617
- # * `:value` - (String)
1618
- # * `:disable_api_termination` - (Hash)
1619
- # * `:value` - (Boolean)
1620
- # * `:instance_initiated_shutdown_behavior` - (Hash)
1621
- # * `:value` - (String)
1622
- # * `:root_device_name` - (Hash)
1623
- # * `:value` - (String)
1624
- # * `:block_device_mapping` - (Array<Hash>)
1625
- # * `:device_name` - (String)
1626
- # * `:ebs` - (Hash)
1627
- # * `:volume_id` - (String)
1628
- # * `:status` - (String)
1629
- # * `:attach_time` - (Time)
1630
- # * `:delete_on_termination` - (Boolean)
1631
- # * `:product_codes` - (Array<Hash>)
1632
- # * `:product_code` - (String)
1633
- # * `:type` - (String)
1634
- # * `:ebs_optimized` - (Hash)
1635
- # * `:value` - (Boolean)
1636
-
1637
- # @!method describe_instance_status(options = {})
1638
- # Calls the DescribeInstanceStatus API operation.
1639
- # @param [Hash] options
1640
- #
1641
- # * `:instance_ids` - (Array<String>) The list of instance IDs. If not
1642
- # specified, all instances are described.
1643
- # * `:filters` - (Array<Hash>) The list of filters to limit returned
1644
- # results.
1645
- # * `:name` - (String) Specifies the name of the filter.
1646
- # * `:values` - (Array<String>) Contains one or more values for the
1647
- # filter.
1648
- # * `:next_token` - (String) A string specifying the next paginated set
1649
- # of results to return.
1650
- # * `:max_results` - (Integer) The maximum number of paginated instance
1651
- # items per response.
1652
- # * `:include_all_instances` - (Boolean)
1653
- # @return [Core::Response]
1654
- # The #data method of the response object returns
1655
- # a hash with the following structure:
1656
- #
1657
- # * `:instance_status_set` - (Array<Hash>)
1658
- # * `:instance_id` - (String)
1659
- # * `:availability_zone` - (String)
1660
- # * `:events_set` - (Array<Hash>)
1661
- # * `:code` - (String)
1662
- # * `:description` - (String)
1663
- # * `:not_before` - (Time)
1664
- # * `:not_after` - (Time)
1665
- # * `:instance_state` - (Hash)
1666
- # * `:code` - (Integer)
1667
- # * `:name` - (String)
1668
- # * `:system_status` - (Hash)
1669
- # * `:status` - (String)
1670
- # * `:details` - (Array<Hash>)
1671
- # * `:name` - (String)
1672
- # * `:status` - (String)
1673
- # * `:impaired_since` - (Time)
1674
- # * `:instance_status` - (Hash)
1675
- # * `:status` - (String)
1676
- # * `:details` - (Array<Hash>)
1677
- # * `:name` - (String)
1678
- # * `:status` - (String)
1679
- # * `:impaired_since` - (Time)
1680
- # * `:next_token` - (String)
1681
-
1682
- # @!method describe_instances(options = {})
1683
- # Calls the DescribeInstances API operation.
1684
- # @param [Hash] options
1685
- #
1686
- # * `:instance_ids` - (Array<String>) An optional list of the instances
1687
- # to describe.
1688
- # * `:filters` - (Array<Hash>) A list of filters used to match
1689
- # properties for Instances. For a complete reference to the available
1690
- # filter keys for this operation, see the Amazon EC2 API reference.
1691
- # * `:name` - (String) Specifies the name of the filter.
1692
- # * `:values` - (Array<String>) Contains one or more values for the
1693
- # filter.
1694
- # @return [Core::Response]
1695
- # The #data method of the response object returns
1696
- # a hash with the following structure:
1697
- #
1698
- # * `:reservation_set` - (Array<Hash>)
1699
- # * `:reservation_id` - (String)
1700
- # * `:owner_id` - (String)
1701
- # * `:requester_id` - (String)
1702
- # * `:group_set` - (Array<Hash>)
1703
- # * `:group_name` - (String)
1704
- # * `:group_id` - (String)
1705
- # * `:instances_set` - (Array<Hash>)
1706
- # * `:instance_id` - (String)
1707
- # * `:image_id` - (String)
1708
- # * `:instance_state` - (Hash)
1709
- # * `:code` - (Integer)
1710
- # * `:name` - (String)
1711
- # * `:private_dns_name` - (String)
1712
- # * `:dns_name` - (String)
1713
- # * `:reason` - (String)
1714
- # * `:key_name` - (String)
1715
- # * `:ami_launch_index` - (Integer)
1716
- # * `:product_codes` - (Array<Hash>)
1717
- # * `:product_code` - (String)
1718
- # * `:type` - (String)
1719
- # * `:instance_type` - (String)
1720
- # * `:launch_time` - (Time)
1721
- # * `:placement` - (Hash)
1722
- # * `:availability_zone` - (String)
1723
- # * `:group_name` - (String)
1724
- # * `:tenancy` - (String)
1725
- # * `:kernel_id` - (String)
1726
- # * `:ramdisk_id` - (String)
1727
- # * `:platform` - (String)
1728
- # * `:monitoring` - (Hash)
1729
- # * `:state` - (String)
1730
- # * `:subnet_id` - (String)
1731
- # * `:vpc_id` - (String)
1732
- # * `:private_ip_address` - (String)
1733
- # * `:ip_address` - (String)
1734
- # * `:state_reason` - (Hash)
1735
- # * `:code` - (String)
1736
- # * `:message` - (String)
1737
- # * `:architecture` - (String)
1738
- # * `:root_device_type` - (String)
1739
- # * `:root_device_name` - (String)
1740
- # * `:block_device_mapping` - (Array<Hash>)
1741
- # * `:device_name` - (String)
1742
- # * `:ebs` - (Hash)
1743
- # * `:volume_id` - (String)
1744
- # * `:status` - (String)
1745
- # * `:attach_time` - (Time)
1746
- # * `:delete_on_termination` - (Boolean)
1747
- # * `:virtualization_type` - (String)
1748
- # * `:instance_lifecycle` - (String)
1749
- # * `:spot_instance_request_id` - (String)
1750
- # * `:license` - (Hash)
1751
- # * `:pool` - (String)
1752
- # * `:client_token` - (String)
1753
- # * `:tag_set` - (Array<Hash>)
1754
- # * `:key` - (String)
1755
- # * `:value` - (String)
1756
- # * `:group_set` - (Array<Hash>)
1757
- # * `:group_name` - (String)
1758
- # * `:group_id` - (String)
1759
- # * `:source_dest_check` - (Boolean)
1760
- # * `:hypervisor` - (String)
1761
- # * `:network_interface_set` - (Array<Hash>)
1762
- # * `:network_interface_id` - (String)
1763
- # * `:subnet_id` - (String)
1764
- # * `:vpc_id` - (String)
1765
- # * `:description` - (String)
1766
- # * `:owner_id` - (String)
1767
- # * `:status` - (String)
1768
- # * `:private_ip_address` - (String)
1769
- # * `:private_dns_name` - (String)
1770
- # * `:source_dest_check` - (Boolean)
1771
- # * `:group_set` - (Array<Hash>)
1772
- # * `:group_name` - (String)
1773
- # * `:group_id` - (String)
1774
- # * `:attachment` - (Hash)
1775
- # * `:attachment_id` - (String)
1776
- # * `:device_index` - (Integer)
1777
- # * `:status` - (String)
1778
- # * `:attach_time` - (Time)
1779
- # * `:delete_on_termination` - (Boolean)
1780
- # * `:association` - (Hash)
1781
- # * `:public_ip` - (String)
1782
- # * `:public_dns_name` - (String)
1783
- # * `:ip_owner_id` - (String)
1784
- # * `:private_ip_addresses_set` - (Array<Hash>)
1785
- # * `:private_ip_address` - (String)
1786
- # * `:private_dns_name` - (String)
1787
- # * `:primary` - (Boolean)
1788
- # * `:association` - (Hash)
1789
- # * `:public_ip` - (String)
1790
- # * `:public_dns_name` - (String)
1791
- # * `:ip_owner_id` - (String)
1792
- # * `:iam_instance_profile` - (Hash)
1793
- # * `:arn` - (String)
1794
- # * `:id` - (String)
1795
- # * `:ebs_optimized` - (Boolean)
1796
-
1797
- # @!method describe_internet_gateways(options = {})
1798
- # Calls the DescribeInternetGateways API operation.
1799
- # @param [Hash] options
1800
- #
1801
- # * `:internet_gateway_ids` - (Array<String>) One or more Internet
1802
- # gateway IDs.
1803
- # * `:filters` - (Array<Hash>) A list of filters used to match
1804
- # properties for Internet Gateways. For a complete reference to the
1805
- # available filter keys for this operation, see the Amazon EC2 API
1806
- # reference.
1807
- # * `:name` - (String) Specifies the name of the filter.
1808
- # * `:values` - (Array<String>) Contains one or more values for the
1809
- # filter.
1810
- # @return [Core::Response]
1811
- # The #data method of the response object returns
1812
- # a hash with the following structure:
1813
- #
1814
- # * `:internet_gateway_set` - (Array<Hash>)
1815
- # * `:internet_gateway_id` - (String)
1816
- # * `:attachment_set` - (Array<Hash>)
1817
- # * `:vpc_id` - (String)
1818
- # * `:state` - (String)
1819
- # * `:tag_set` - (Array<Hash>)
1820
- # * `:key` - (String)
1821
- # * `:value` - (String)
1822
-
1823
- # @!method describe_key_pairs(options = {})
1824
- # Calls the DescribeKeyPairs API operation.
1825
- # @param [Hash] options
1826
- #
1827
- # * `:key_names` - (Array<String>) The optional list of key pair names
1828
- # to describe.
1829
- # * `:filters` - (Array<Hash>) A list of filters used to match
1830
- # properties for KeyPairs. For a complete reference to the available
1831
- # filter keys for this operation, see the Amazon EC2 API reference.
1832
- # * `:name` - (String) Specifies the name of the filter.
1833
- # * `:values` - (Array<String>) Contains one or more values for the
1834
- # filter.
1835
- # @return [Core::Response]
1836
- # The #data method of the response object returns
1837
- # a hash with the following structure:
1838
- #
1839
- # * `:key_set` - (Array<Hash>)
1840
- # * `:key_name` - (String)
1841
- # * `:key_fingerprint` - (String)
1842
-
1843
- # @!method describe_licenses(options = {})
1844
- # Calls the DescribeLicenses API operation.
1845
- # @param [Hash] options
1846
- #
1847
- # * `:license_ids` - (Array<String>) Specifies the license registration
1848
- # for which details are to be returned.
1849
- # * `:filters` - (Array<Hash>) A list of filters used to match
1850
- # properties for Licenses. For a complete reference to the available
1851
- # filter keys for this operation, see the Amazon EC2 API reference.
1852
- # * `:name` - (String) Specifies the name of the filter.
1853
- # * `:values` - (Array<String>) Contains one or more values for the
1854
- # filter.
1855
- # @return [Core::Response]
1856
- # The #data method of the response object returns
1857
- # a hash with the following structure:
1858
- #
1859
- # * `:license_set` - (Array<Hash>)
1860
- # * `:license_id` - (String)
1861
- # * `:type` - (String)
1862
- # * `:pool` - (String)
1863
- # * `:capacity_set` - (Array<Hash>)
1864
- # * `:capacity` - (Integer)
1865
- # * `:instance_capacity` - (Integer)
1866
- # * `:state` - (String)
1867
- # * `:earliest_allowed_deactivation_time` - (Time)
1868
- # * `:tag_set` - (Array<Hash>)
1869
- # * `:key` - (String)
1870
- # * `:value` - (String)
1871
-
1872
- # @!method describe_network_acls(options = {})
1873
- # Calls the DescribeNetworkAcls API operation.
1874
- # @param [Hash] options
1875
- #
1876
- # * `:network_acl_ids` - (Array<String>) One or more network ACL IDs.
1877
- # * `:filters` - (Array<Hash>) A list of filters used to match
1878
- # properties for Network ACLs. For a complete reference to the
1879
- # available filter keys for this operation, see the Amazon EC2 API
1880
- # reference.
1881
- # * `:name` - (String) Specifies the name of the filter.
1882
- # * `:values` - (Array<String>) Contains one or more values for the
1883
- # filter.
1884
- # @return [Core::Response]
1885
- # The #data method of the response object returns
1886
- # a hash with the following structure:
1887
- #
1888
- # * `:network_acl_set` - (Array<Hash>)
1889
- # * `:network_acl_id` - (String)
1890
- # * `:vpc_id` - (String)
1891
- # * `:default` - (Boolean)
1892
- # * `:entry_set` - (Array<Hash>)
1893
- # * `:rule_number` - (Integer)
1894
- # * `:protocol` - (String)
1895
- # * `:rule_action` - (String)
1896
- # * `:egress` - (Boolean)
1897
- # * `:cidr_block` - (String)
1898
- # * `:icmp_type_code` - (Hash)
1899
- # * `:type` - (Integer)
1900
- # * `:code` - (Integer)
1901
- # * `:port_range` - (Hash)
1902
- # * `:from` - (Integer)
1903
- # * `:to` - (Integer)
1904
- # * `:association_set` - (Array<Hash>)
1905
- # * `:network_acl_association_id` - (String)
1906
- # * `:network_acl_id` - (String)
1907
- # * `:subnet_id` - (String)
1908
- # * `:tag_set` - (Array<Hash>)
1909
- # * `:key` - (String)
1910
- # * `:value` - (String)
1911
-
1912
- # @!method describe_network_interface_attribute(options = {})
1913
- # Calls the DescribeNetworkInterfaceAttribute API operation.
1914
- # @param [Hash] options
1915
- #
1916
- # * `:network_interface_id` - *required* - (String)
1917
- # * `:description` - (String)
1918
- # * `:source_dest_check` - (String)
1919
- # * `:groups` - (String)
1920
- # * `:attachment` - (String)
1921
- # @return [Core::Response]
1922
- # The #data method of the response object returns
1923
- # a hash with the following structure:
1924
- #
1925
- # * `:network_interface_id` - (String)
1926
- # * `:description` - (Hash)
1927
- # * `:value` - (String)
1928
- # * `:source_dest_check` - (Hash)
1929
- # * `:value` - (Boolean)
1930
- # * `:group_set` - (Array<Hash>)
1931
- # * `:group_name` - (String)
1932
- # * `:group_id` - (String)
1933
- # * `:attachment` - (Hash)
1934
- # * `:attachment_id` - (String)
1935
- # * `:instance_id` - (String)
1936
- # * `:instance_owner_id` - (String)
1937
- # * `:device_index` - (Integer)
1938
- # * `:status` - (String)
1939
- # * `:attach_time` - (Time)
1940
- # * `:delete_on_termination` - (Boolean)
1941
-
1942
- # @!method describe_network_interfaces(options = {})
1943
- # Calls the DescribeNetworkInterfaces API operation.
1944
- # @param [Hash] options
1945
- #
1946
- # * `:network_interface_ids` - (Array<String>)
1947
- # * `:filters` - (Array<Hash>)
1948
- # * `:name` - (String) Specifies the name of the filter.
1949
- # * `:values` - (Array<String>) Contains one or more values for the
1950
- # filter.
1951
- # @return [Core::Response]
1952
- # The #data method of the response object returns
1953
- # a hash with the following structure:
1954
- #
1955
- # * `:network_interface_set` - (Array<Hash>)
1956
- # * `:network_interface_id` - (String)
1957
- # * `:subnet_id` - (String)
1958
- # * `:vpc_id` - (String)
1959
- # * `:availability_zone` - (String)
1960
- # * `:description` - (String)
1961
- # * `:owner_id` - (String)
1962
- # * `:requester_id` - (String)
1963
- # * `:requester_managed` - (Boolean)
1964
- # * `:status` - (String)
1965
- # * `:mac_address` - (String)
1966
- # * `:private_ip_address` - (String)
1967
- # * `:private_dns_name` - (String)
1968
- # * `:source_dest_check` - (Boolean)
1969
- # * `:groups` - (Array<Hash>)
1970
- # * `:group_name` - (String)
1971
- # * `:group_id` - (String)
1972
- # * `:attachment` - (Hash)
1973
- # * `:attachment_id` - (String)
1974
- # * `:instance_id` - (String)
1975
- # * `:instance_owner_id` - (String)
1976
- # * `:device_index` - (Integer)
1977
- # * `:status` - (String)
1978
- # * `:attach_time` - (Time)
1979
- # * `:delete_on_termination` - (Boolean)
1980
- # * `:association` - (Hash)
1981
- # * `:public_ip` - (String)
1982
- # * `:ip_owner_id` - (String)
1983
- # * `:allocation_id` - (String)
1984
- # * `:association_id` - (String)
1985
- # * `:tag_set` - (Array<Hash>)
1986
- # * `:key` - (String)
1987
- # * `:value` - (String)
1988
- # * `:private_ip_addresses_set` - (Array<Hash>)
1989
- # * `:private_ip_address` - (String)
1990
- # * `:private_dns_name` - (String)
1991
- # * `:primary` - (Boolean)
1992
- # * `:association` - (Hash)
1993
- # * `:public_ip` - (String)
1994
- # * `:ip_owner_id` - (String)
1995
- # * `:allocation_id` - (String)
1996
- # * `:association_id` - (String)
1997
-
1998
- # @!method describe_placement_groups(options = {})
1999
- # Calls the DescribePlacementGroups API operation.
2000
- # @param [Hash] options
2001
- #
2002
- # * `:group_names` - (Array<String>) The name of the PlacementGroup.
2003
- # * `:filters` - (Array<Hash>) A list of filters used to match
2004
- # properties for Placement Groups. For a complete reference to the
2005
- # available filter keys for this operation, see the Amazon EC2 API
2006
- # reference.
2007
- # * `:name` - (String) Specifies the name of the filter.
2008
- # * `:values` - (Array<String>) Contains one or more values for the
2009
- # filter.
2010
- # @return [Core::Response]
2011
- # The #data method of the response object returns
2012
- # a hash with the following structure:
2013
- #
2014
- # * `:placement_group_set` - (Array<Hash>)
2015
- # * `:group_name` - (String)
2016
- # * `:strategy` - (String)
2017
- # * `:state` - (String)
2018
-
2019
- # @!method describe_regions(options = {})
2020
- # Calls the DescribeRegions API operation.
2021
- # @param [Hash] options
2022
- #
2023
- # * `:region_names` - (Array<String>) The optional list of regions to
2024
- # describe.
2025
- # * `:filters` - (Array<Hash>) A list of filters used to match
2026
- # properties for Regions. For a complete reference to the available
2027
- # filter keys for this operation, see the Amazon EC2 API reference.
2028
- # * `:name` - (String) Specifies the name of the filter.
2029
- # * `:values` - (Array<String>) Contains one or more values for the
2030
- # filter.
2031
- # @return [Core::Response]
2032
- # The #data method of the response object returns
2033
- # a hash with the following structure:
2034
- #
2035
- # * `:region_info` - (Array<Hash>)
2036
- # * `:region_name` - (String)
2037
- # * `:region_endpoint` - (String)
2038
-
2039
- # @!method describe_reserved_instances(options = {})
2040
- # Calls the DescribeReservedInstances API operation.
2041
- # @param [Hash] options
2042
- #
2043
- # * `:reserved_instances_ids` - (Array<String>) The optional list of
2044
- # Reserved Instance IDs to describe.
2045
- # * `:filters` - (Array<Hash>) A list of filters used to match
2046
- # properties for ReservedInstances. For a complete reference to the
2047
- # available filter keys for this operation, see the Amazon EC2 API
2048
- # reference.
2049
- # * `:name` - (String) Specifies the name of the filter.
2050
- # * `:values` - (Array<String>) Contains one or more values for the
2051
- # filter.
2052
- # * `:offering_type` - (String) The Reserved Instance offering type.
2053
- # @return [Core::Response]
2054
- # The #data method of the response object returns
2055
- # a hash with the following structure:
2056
- #
2057
- # * `:reserved_instances_set` - (Array<Hash>)
2058
- # * `:reserved_instances_id` - (String)
2059
- # * `:instance_type` - (String)
2060
- # * `:availability_zone` - (String)
2061
- # * `:start` - (Time)
2062
- # * `:duration` - (Integer)
2063
- # * `:usage_price` - (Numeric)
2064
- # * `:fixed_price` - (Numeric)
2065
- # * `:instance_count` - (Integer)
2066
- # * `:product_description` - (String)
2067
- # * `:state` - (String)
2068
- # * `:tag_set` - (Array<Hash>)
2069
- # * `:key` - (String)
2070
- # * `:value` - (String)
2071
- # * `:instance_tenancy` - (String)
2072
- # * `:currency_code` - (String)
2073
- # * `:offering_type` - (String)
2074
- # * `:recurring_charges` - (Array<Hash>)
2075
- # * `:frequency` - (String)
2076
- # * `:amount` - (Numeric)
2077
-
2078
- # @!method describe_reserved_instances_listings(options = {})
2079
- # Calls the DescribeReservedInstancesListings API operation.
2080
- # @param [Hash] options
2081
- #
2082
- # * `:reserved_instances_id` - (String)
2083
- # * `:reserved_instances_listing_id` - (String)
2084
- # * `:filters` - (Array<Hash>)
2085
- # * `:name` - (String) Specifies the name of the filter.
2086
- # * `:values` - (Array<String>) Contains one or more values for the
2087
- # filter.
2088
- # @return [Core::Response]
2089
- # The #data method of the response object returns
2090
- # a hash with the following structure:
2091
- #
2092
- # * `:reserved_instances_listings_set` - (Array<Hash>)
2093
- # * `:reserved_instances_listing_id` - (String)
2094
- # * `:reserved_instances_id` - (String)
2095
- # * `:create_date` - (Time)
2096
- # * `:update_date` - (Time)
2097
- # * `:status` - (String)
2098
- # * `:status_message` - (String)
2099
- # * `:instance_counts` - (Array<Hash>)
2100
- # * `:state` - (String)
2101
- # * `:instance_count` - (Integer)
2102
- # * `:price_schedules` - (Array<Hash>)
2103
- # * `:term` - (Integer)
2104
- # * `:price` - (Numeric)
2105
- # * `:currency_code` - (String)
2106
- # * `:active` - (Boolean)
2107
- # * `:tag_set` - (Array<Hash>)
2108
- # * `:key` - (String)
2109
- # * `:value` - (String)
2110
- # * `:client_token` - (String)
2111
-
2112
- # @!method describe_reserved_instances_offerings(options = {})
2113
- # Calls the DescribeReservedInstancesOfferings API operation.
2114
- # @param [Hash] options
2115
- #
2116
- # * `:reserved_instances_offering_ids` - (Array<String>) An optional
2117
- # list of the unique IDs of the Reserved Instance offerings to
2118
- # describe.
2119
- # * `:instance_type` - (String) The instance type on which the Reserved
2120
- # Instance can be used. Valid values include:
2121
- # * `t1.micro`
2122
- # * `m1.small`
2123
- # * `m1.medium`
2124
- # * `m1.large`
2125
- # * `m1.xlarge`
2126
- # * `m2.xlarge`
2127
- # * `m2.2xlarge`
2128
- # * `m2.4xlarge`
2129
- # * `m3.xlarge`
2130
- # * `m3.2xlarge`
2131
- # * `c1.medium`
2132
- # * `c1.xlarge`
2133
- # * `hi1.4xlarge`
2134
- # * `hs1.8xlarge`
2135
- # * `cc1.4xlarge`
2136
- # * `cc2.8xlarge`
2137
- # * `cg1.4xlarge`
2138
- # * `:availability_zone` - (String) The Availability Zone in which the
2139
- # Reserved Instance can be used.
2140
- # * `:product_description` - (String) The Reserved Instance product
2141
- # description.
2142
- # * `:filters` - (Array<Hash>) A list of filters used to match
2143
- # properties for ReservedInstancesOfferings. For a complete reference
2144
- # to the available filter keys for this operation, see the Amazon EC2
2145
- # API reference.
2146
- # * `:name` - (String) Specifies the name of the filter.
2147
- # * `:values` - (Array<String>) Contains one or more values for the
2148
- # filter.
2149
- # * `:instance_tenancy` - (String) The tenancy of the Reserved Instance
2150
- # offering. A Reserved Instance with tenancy of dedicated will run on
2151
- # single-tenant hardware and can only be launched within a VPC.
2152
- # * `:offering_type` - (String) The Reserved Instance offering type.
2153
- # * `:next_token` - (String)
2154
- # * `:max_results` - (Integer)
2155
- # @return [Core::Response]
2156
- # The #data method of the response object returns
2157
- # a hash with the following structure:
2158
- #
2159
- # * `:reserved_instances_offerings_set` - (Array<Hash>)
2160
- # * `:reserved_instances_offering_id` - (String)
2161
- # * `:instance_type` - (String)
2162
- # * `:availability_zone` - (String)
2163
- # * `:duration` - (Integer)
2164
- # * `:usage_price` - (Numeric)
2165
- # * `:fixed_price` - (Numeric)
2166
- # * `:product_description` - (String)
2167
- # * `:instance_tenancy` - (String)
2168
- # * `:currency_code` - (String)
2169
- # * `:offering_type` - (String)
2170
- # * `:recurring_charges` - (Array<Hash>)
2171
- # * `:frequency` - (String)
2172
- # * `:amount` - (Numeric)
2173
- # * `:marketplace` - (Boolean)
2174
- # * `:pricing_details_set` - (Array<Hash>)
2175
- # * `:price` - (Numeric)
2176
- # * `:count` - (Integer)
2177
- # * `:next_token` - (String)
2178
-
2179
- # @!method describe_route_tables(options = {})
2180
- # Calls the DescribeRouteTables API operation.
2181
- # @param [Hash] options
2182
- #
2183
- # * `:route_table_ids` - (Array<String>) One or more route table IDs.
2184
- # * `:filters` - (Array<Hash>) A list of filters used to match
2185
- # properties for Route Tables. For a complete reference to the
2186
- # available filter keys for this operation, see the Amazon EC2 API
2187
- # reference.
2188
- # * `:name` - (String) Specifies the name of the filter.
2189
- # * `:values` - (Array<String>) Contains one or more values for the
2190
- # filter.
2191
- # @return [Core::Response]
2192
- # The #data method of the response object returns
2193
- # a hash with the following structure:
2194
- #
2195
- # * `:route_table_set` - (Array<Hash>)
2196
- # * `:route_table_id` - (String)
2197
- # * `:vpc_id` - (String)
2198
- # * `:route_set` - (Array<Hash>)
2199
- # * `:destination_cidr_block` - (String)
2200
- # * `:gateway_id` - (String)
2201
- # * `:instance_id` - (String)
2202
- # * `:instance_owner_id` - (String)
2203
- # * `:network_interface_id` - (String)
2204
- # * `:state` - (String)
2205
- # * `:association_set` - (Array<Hash>)
2206
- # * `:route_table_association_id` - (String)
2207
- # * `:route_table_id` - (String)
2208
- # * `:subnet_id` - (String)
2209
- # * `:main` - (Boolean)
2210
- # * `:tag_set` - (Array<Hash>)
2211
- # * `:key` - (String)
2212
- # * `:value` - (String)
2213
- # * `:propagating_vgw_set` - (Array<Hash>)
2214
- # * `:gateway_id` - (String)
2215
-
2216
- # @!method describe_security_groups(options = {})
2217
- # Calls the DescribeSecurityGroups API operation.
2218
- # @param [Hash] options
2219
- #
2220
- # * `:group_names` - (Array<String>) The optional list of Amazon EC2
2221
- # security groups to describe.
2222
- # * `:group_ids` - (Array<String>)
2223
- # * `:filters` - (Array<Hash>) A list of filters used to match
2224
- # properties for SecurityGroups. For a complete reference to the
2225
- # available filter keys for this operation, see the Amazon EC2 API
2226
- # reference.
2227
- # * `:name` - (String) Specifies the name of the filter.
2228
- # * `:values` - (Array<String>) Contains one or more values for the
2229
- # filter.
2230
- # @return [Core::Response]
2231
- # The #data method of the response object returns
2232
- # a hash with the following structure:
2233
- #
2234
- # * `:security_group_info` - (Array<Hash>)
2235
- # * `:owner_id` - (String)
2236
- # * `:group_name` - (String)
2237
- # * `:group_id` - (String)
2238
- # * `:group_description` - (String)
2239
- # * `:ip_permissions` - (Array<Hash>)
2240
- # * `:ip_protocol` - (String)
2241
- # * `:from_port` - (Integer)
2242
- # * `:to_port` - (Integer)
2243
- # * `:groups` - (Array<Hash>)
2244
- # * `:user_id` - (String)
2245
- # * `:group_name` - (String)
2246
- # * `:group_id` - (String)
2247
- # * `:ip_ranges` - (Array<Hash>)
2248
- # * `:cidr_ip` - (String)
2249
- # * `:ip_permissions_egress` - (Array<Hash>)
2250
- # * `:ip_protocol` - (String)
2251
- # * `:from_port` - (Integer)
2252
- # * `:to_port` - (Integer)
2253
- # * `:groups` - (Array<Hash>)
2254
- # * `:user_id` - (String)
2255
- # * `:group_name` - (String)
2256
- # * `:group_id` - (String)
2257
- # * `:ip_ranges` - (Array<Hash>)
2258
- # * `:cidr_ip` - (String)
2259
- # * `:vpc_id` - (String)
2260
- # * `:tag_set` - (Array<Hash>)
2261
- # * `:key` - (String)
2262
- # * `:value` - (String)
2263
-
2264
- # @!method describe_snapshot_attribute(options = {})
2265
- # Calls the DescribeSnapshotAttribute API operation.
2266
- # @param [Hash] options
2267
- #
2268
- # * `:snapshot_id` - *required* - (String) The ID of the EBS snapshot
2269
- # whose attribute is being described.
2270
- # * `:attribute` - *required* - (String) The name of the EBS attribute
2271
- # to describe. Available attribute names: createVolumePermission
2272
- # Valid values include:
2273
- # * `productCodes`
2274
- # * `createVolumePermission`
2275
- # @return [Core::Response]
2276
- # The #data method of the response object returns
2277
- # a hash with the following structure:
2278
- #
2279
- # * `:snapshot_id` - (String)
2280
- # * `:create_volume_permission` - (Array<Hash>)
2281
- # * `:user_id` - (String)
2282
- # * `:group` - (String)
2283
- # * `:product_codes` - (Array<Hash>)
2284
- # * `:product_code` - (String)
2285
- # * `:type` - (String)
2286
-
2287
- # @!method describe_snapshots(options = {})
2288
- # Calls the DescribeSnapshots API operation.
2289
- # @param [Hash] options
2290
- #
2291
- # * `:snapshot_ids` - (Array<String>) The optional list of EBS snapshot
2292
- # IDs to describe.
2293
- # * `:owner_ids` - (Array<String>) The optional list of EBS snapshot
2294
- # owners.
2295
- # * `:restorable_by_user_ids` - (Array<String>) The optional list of
2296
- # users who have permission to create volumes from the described EBS
2297
- # snapshots.
2298
- # * `:filters` - (Array<Hash>) A list of filters used to match
2299
- # properties for Snapshots. For a complete reference to the available
2300
- # filter keys for this operation, see the Amazon EC2 API reference.
2301
- # * `:name` - (String) Specifies the name of the filter.
2302
- # * `:values` - (Array<String>) Contains one or more values for the
2303
- # filter.
2304
- # @return [Core::Response]
2305
- # The #data method of the response object returns
2306
- # a hash with the following structure:
2307
- #
2308
- # * `:snapshot_set` - (Array<Hash>)
2309
- # * `:snapshot_id` - (String)
2310
- # * `:volume_id` - (String)
2311
- # * `:status` - (String)
2312
- # * `:start_time` - (Time)
2313
- # * `:progress` - (String)
2314
- # * `:owner_id` - (String)
2315
- # * `:description` - (String)
2316
- # * `:volume_size` - (Integer)
2317
- # * `:owner_alias` - (String)
2318
- # * `:tag_set` - (Array<Hash>)
2319
- # * `:key` - (String)
2320
- # * `:value` - (String)
2321
-
2322
- # @!method describe_spot_datafeed_subscription(options = {})
2323
- # Calls the DescribeSpotDatafeedSubscription API operation.
2324
- # @param [Hash] options
2325
- #
2326
- # @return [Core::Response]
2327
- # The #data method of the response object returns
2328
- # a hash with the following structure:
2329
- #
2330
- # * `:spot_datafeed_subscription` - (Hash)
2331
- # * `:owner_id` - (String)
2332
- # * `:bucket` - (String)
2333
- # * `:prefix` - (String)
2334
- # * `:state` - (String)
2335
- # * `:fault` - (Hash)
2336
- # * `:code` - (String)
2337
- # * `:message` - (String)
2338
-
2339
- # @!method describe_spot_instance_requests(options = {})
2340
- # Calls the DescribeSpotInstanceRequests API operation.
2341
- # @param [Hash] options
2342
- #
2343
- # * `:spot_instance_request_ids` - (Array<String>) The ID of the
2344
- # request.
2345
- # * `:filters` - (Array<Hash>) A list of filters used to match
2346
- # properties for SpotInstances. For a complete reference to the
2347
- # available filter keys for this operation, see the Amazon EC2 API
2348
- # reference.
2349
- # * `:name` - (String) Specifies the name of the filter.
2350
- # * `:values` - (Array<String>) Contains one or more values for the
2351
- # filter.
2352
- # @return [Core::Response]
2353
- # The #data method of the response object returns
2354
- # a hash with the following structure:
2355
- #
2356
- # * `:spot_instance_request_set` - (Array<Hash>)
2357
- # * `:spot_instance_request_id` - (String)
2358
- # * `:spot_price` - (String)
2359
- # * `:type` - (String)
2360
- # * `:state` - (String)
2361
- # * `:fault` - (Hash)
2362
- # * `:code` - (String)
2363
- # * `:message` - (String)
2364
- # * `:status` - (Hash)
2365
- # * `:code` - (String)
2366
- # * `:update_time` - (Time)
2367
- # * `:message` - (String)
2368
- # * `:valid_from` - (Time)
2369
- # * `:valid_until` - (Time)
2370
- # * `:launch_group` - (String)
2371
- # * `:availability_zone_group` - (String)
2372
- # * `:launch_specification` - (Hash)
2373
- # * `:image_id` - (String)
2374
- # * `:key_name` - (String)
2375
- # * `:group_set` - (Array<Hash>)
2376
- # * `:group_name` - (String)
2377
- # * `:group_id` - (String)
2378
- # * `:user_data` - (String)
2379
- # * `:addressing_type` - (String)
2380
- # * `:instance_type` - (String)
2381
- # * `:placement` - (Hash)
2382
- # * `:availability_zone` - (String)
2383
- # * `:group_name` - (String)
2384
- # * `:kernel_id` - (String)
2385
- # * `:ramdisk_id` - (String)
2386
- # * `:block_device_mapping` - (Array<Hash>)
2387
- # * `:virtual_name` - (String)
2388
- # * `:device_name` - (String)
2389
- # * `:ebs` - (Hash)
2390
- # * `:snapshot_id` - (String)
2391
- # * `:volume_size` - (Integer)
2392
- # * `:delete_on_termination` - (Boolean)
2393
- # * `:volume_type` - (String)
2394
- # * `:iops` - (Integer)
2395
- # * `:no_device` - (String)
2396
- # * `:monitoring_enabled` - (Boolean)
2397
- # * `:subnet_id` - (String)
2398
- # * `:network_interface_set` - (Array<Hash>)
2399
- # * `:network_interface_id` - (String)
2400
- # * `:device_index` - (Integer)
2401
- # * `:subnet_id` - (String)
2402
- # * `:description` - (String)
2403
- # * `:private_ip_address` - (String)
2404
- # * `:security_group_id` - (Array<String>)
2405
- # * `:delete_on_termination` - (Boolean)
2406
- # * `:private_ip_addresses_set` - (Array<Hash>)
2407
- # * `:private_ip_address` - (String)
2408
- # * `:primary` - (Boolean)
2409
- # * `:secondary_private_ip_address_count` - (Integer)
2410
- # * `:iam_instance_profile` - (Hash)
2411
- # * `:arn` - (String)
2412
- # * `:name` - (String)
2413
- # * `:ebs_optimized` - (Boolean)
2414
- # * `:instance_id` - (String)
2415
- # * `:create_time` - (Time)
2416
- # * `:product_description` - (String)
2417
- # * `:tag_set` - (Array<Hash>)
2418
- # * `:key` - (String)
2419
- # * `:value` - (String)
2420
- # * `:launched_availability_zone` - (String)
2421
-
2422
- # @!method describe_spot_price_history(options = {})
2423
- # Calls the DescribeSpotPriceHistory API operation.
2424
- # @param [Hash] options
2425
- #
2426
- # * `:start_time` - (String<ISO8601 datetime>) The start date and time
2427
- # of the Spot Instance price history data.
2428
- # * `:end_time` - (String<ISO8601 datetime>) The end date and time of
2429
- # the Spot Instance price history data.
2430
- # * `:instance_types` - (Array<String>) Specifies the instance type to
2431
- # return.
2432
- # * `:product_descriptions` - (Array<String>) The description of the
2433
- # AMI.
2434
- # * `:filters` - (Array<Hash>) A list of filters used to match
2435
- # properties for SpotPriceHistory. For a complete reference to the
2436
- # available filter keys for this operation, see the Amazon EC2 API
2437
- # reference.
2438
- # * `:name` - (String) Specifies the name of the filter.
2439
- # * `:values` - (Array<String>) Contains one or more values for the
2440
- # filter.
2441
- # * `:availability_zone` - (String) Filters the results by availability
2442
- # zone (ex: 'us-east-1a').
2443
- # * `:max_results` - (Integer) Specifies the number of rows to return.
2444
- # * `:next_token` - (String) Specifies the next set of rows to return.
2445
- # @return [Core::Response]
2446
- # The #data method of the response object returns
2447
- # a hash with the following structure:
2448
- #
2449
- # * `:spot_price_history_set` - (Array<Hash>)
2450
- # * `:instance_type` - (String)
2451
- # * `:product_description` - (String)
2452
- # * `:spot_price` - (String)
2453
- # * `:timestamp` - (Time)
2454
- # * `:availability_zone` - (String)
2455
- # * `:next_token` - (String)
2456
-
2457
- # @!method describe_subnets(options = {})
2458
- # Calls the DescribeSubnets API operation.
2459
- # @param [Hash] options
2460
- #
2461
- # * `:subnet_ids` - (Array<String>) A set of one or more subnet IDs.
2462
- # * `:filters` - (Array<Hash>) A list of filters used to match
2463
- # properties for Subnets. For a complete reference to the available
2464
- # filter keys for this operation, see the Amazon EC2 API reference.
2465
- # * `:name` - (String) Specifies the name of the filter.
2466
- # * `:values` - (Array<String>) Contains one or more values for the
2467
- # filter.
2468
- # @return [Core::Response]
2469
- # The #data method of the response object returns
2470
- # a hash with the following structure:
2471
- #
2472
- # * `:subnet_set` - (Array<Hash>)
2473
- # * `:subnet_id` - (String)
2474
- # * `:state` - (String)
2475
- # * `:vpc_id` - (String)
2476
- # * `:cidr_block` - (String)
2477
- # * `:available_ip_address_count` - (Integer)
2478
- # * `:availability_zone` - (String)
2479
- # * `:default_for_az` - (Boolean)
2480
- # * `:map_public_ip_on_launch` - (Boolean)
2481
- # * `:tag_set` - (Array<Hash>)
2482
- # * `:key` - (String)
2483
- # * `:value` - (String)
2484
-
2485
- # @!method describe_tags(options = {})
2486
- # Calls the DescribeTags API operation.
2487
- # @param [Hash] options
2488
- #
2489
- # * `:filters` - (Array<Hash>) A list of filters used to match
2490
- # properties for tags.
2491
- # * `:name` - (String) Specifies the name of the filter.
2492
- # * `:values` - (Array<String>) Contains one or more values for the
2493
- # filter.
2494
- # @return [Core::Response]
2495
- # The #data method of the response object returns
2496
- # a hash with the following structure:
2497
- #
2498
- # * `:tag_set` - (Array<Hash>)
2499
- # * `:resource_id` - (String)
2500
- # * `:resource_type` - (String)
2501
- # * `:key` - (String)
2502
- # * `:value` - (String)
2503
-
2504
- # @!method describe_volume_attribute(options = {})
2505
- # Calls the DescribeVolumeAttribute API operation.
2506
- # @param [Hash] options
2507
- #
2508
- # * `:volume_id` - *required* - (String)
2509
- # * `:attribute` - (String) Valid values include:
2510
- # * `autoEnableIO`
2511
- # * `productCodes`
2512
- # @return [Core::Response]
2513
- # The #data method of the response object returns
2514
- # a hash with the following structure:
2515
- #
2516
- # * `:volume_id` - (String)
2517
- # * `:auto_enable_io` - (Hash)
2518
- # * `:value` - (Boolean)
2519
- # * `:product_codes` - (Array<Hash>)
2520
- # * `:product_code` - (String)
2521
- # * `:type` - (String)
2522
-
2523
- # @!method describe_volume_status(options = {})
2524
- # Calls the DescribeVolumeStatus API operation.
2525
- # @param [Hash] options
2526
- #
2527
- # * `:volume_ids` - (Array<String>)
2528
- # * `:filters` - (Array<Hash>)
2529
- # * `:name` - (String) Specifies the name of the filter.
2530
- # * `:values` - (Array<String>) Contains one or more values for the
2531
- # filter.
2532
- # * `:next_token` - (String)
2533
- # * `:max_results` - (Integer)
2534
- # @return [Core::Response]
2535
- # The #data method of the response object returns
2536
- # a hash with the following structure:
2537
- #
2538
- # * `:volume_status_set` - (Array<Hash>)
2539
- # * `:volume_id` - (String)
2540
- # * `:availability_zone` - (String)
2541
- # * `:volume_status` - (Hash)
2542
- # * `:status` - (String)
2543
- # * `:details` - (Array<Hash>)
2544
- # * `:name` - (String)
2545
- # * `:status` - (String)
2546
- # * `:events_set` - (Array<Hash>)
2547
- # * `:event_type` - (String)
2548
- # * `:description` - (String)
2549
- # * `:not_before` - (Time)
2550
- # * `:not_after` - (Time)
2551
- # * `:event_id` - (String)
2552
- # * `:actions_set` - (Array<Hash>)
2553
- # * `:code` - (String)
2554
- # * `:description` - (String)
2555
- # * `:event_type` - (String)
2556
- # * `:event_id` - (String)
2557
- # * `:next_token` - (String)
2558
-
2559
- # @!method describe_volumes(options = {})
2560
- # Calls the DescribeVolumes API operation.
2561
- # @param [Hash] options
2562
- #
2563
- # * `:volume_ids` - (Array<String>) The optional list of EBS volumes to
2564
- # describe.
2565
- # * `:filters` - (Array<Hash>) A list of filters used to match
2566
- # properties for Volumes. For a complete reference to the available
2567
- # filter keys for this operation, see the Amazon EC2 API reference.
2568
- # * `:name` - (String) Specifies the name of the filter.
2569
- # * `:values` - (Array<String>) Contains one or more values for the
2570
- # filter.
2571
- # @return [Core::Response]
2572
- # The #data method of the response object returns
2573
- # a hash with the following structure:
2574
- #
2575
- # * `:volume_set` - (Array<Hash>)
2576
- # * `:volume_id` - (String)
2577
- # * `:size` - (Integer)
2578
- # * `:snapshot_id` - (String)
2579
- # * `:availability_zone` - (String)
2580
- # * `:status` - (String)
2581
- # * `:create_time` - (Time)
2582
- # * `:attachment_set` - (Array<Hash>)
2583
- # * `:volume_id` - (String)
2584
- # * `:instance_id` - (String)
2585
- # * `:device` - (String)
2586
- # * `:status` - (String)
2587
- # * `:attach_time` - (Time)
2588
- # * `:delete_on_termination` - (Boolean)
2589
- # * `:tag_set` - (Array<Hash>)
2590
- # * `:key` - (String)
2591
- # * `:value` - (String)
2592
- # * `:volume_type` - (String)
2593
- # * `:iops` - (Integer)
2594
-
2595
- # @!method describe_vpc_attribute(options = {})
2596
- # Calls the DescribeVpcAttribute API operation.
2597
- # @param [Hash] options
2598
- #
2599
- # * `:vpc_id` - *required* - (String)
2600
- # * `:attribute` - (String) Valid values include:
2601
- # * `enableDnsSupport`
2602
- # * `enableDnsHostnames`
2603
- # @return [Core::Response]
2604
- # The #data method of the response object returns
2605
- # a hash with the following structure:
2606
- #
2607
- # * `:vpc_id` - (String)
2608
- # * `:enable_dns_support` - (Hash)
2609
- # * `:value` - (Boolean)
2610
- # * `:enable_dns_hostnames` - (Hash)
2611
- # * `:value` - (Boolean)
2612
-
2613
- # @!method describe_vpcs(options = {})
2614
- # Calls the DescribeVpcs API operation.
2615
- # @param [Hash] options
2616
- #
2617
- # * `:vpc_ids` - (Array<String>) The ID of a VPC you want information
2618
- # about.
2619
- # * `:filters` - (Array<Hash>) A list of filters used to match
2620
- # properties for VPCs. For a complete reference to the available
2621
- # filter keys for this operation, see the Amazon EC2 API reference.
2622
- # * `:name` - (String) Specifies the name of the filter.
2623
- # * `:values` - (Array<String>) Contains one or more values for the
2624
- # filter.
2625
- # @return [Core::Response]
2626
- # The #data method of the response object returns
2627
- # a hash with the following structure:
2628
- #
2629
- # * `:vpc_set` - (Array<Hash>)
2630
- # * `:vpc_id` - (String)
2631
- # * `:state` - (String)
2632
- # * `:cidr_block` - (String)
2633
- # * `:dhcp_options_id` - (String)
2634
- # * `:tag_set` - (Array<Hash>)
2635
- # * `:key` - (String)
2636
- # * `:value` - (String)
2637
- # * `:instance_tenancy` - (String)
2638
- # * `:is_default` - (Boolean)
2639
-
2640
- # @!method describe_vpn_connections(options = {})
2641
- # Calls the DescribeVpnConnections API operation.
2642
- # @param [Hash] options
2643
- #
2644
- # * `:vpn_connection_ids` - (Array<String>) A VPN connection ID. More
2645
- # than one may be specified per request.
2646
- # * `:filters` - (Array<Hash>) A list of filters used to match
2647
- # properties for VPN Connections. For a complete reference to the
2648
- # available filter keys for this operation, see the Amazon EC2 API
2649
- # reference.
2650
- # * `:name` - (String) Specifies the name of the filter.
2651
- # * `:values` - (Array<String>) Contains one or more values for the
2652
- # filter.
2653
- # @return [Core::Response]
2654
- # The #data method of the response object returns
2655
- # a hash with the following structure:
2656
- #
2657
- # * `:vpn_connection_set` - (Array<Hash>)
2658
- # * `:vpn_connection_id` - (String)
2659
- # * `:state` - (String)
2660
- # * `:customer_gateway_configuration` - (String)
2661
- # * `:vpn_type` - (String)
2662
- # * `:customer_gateway_id` - (String)
2663
- # * `:vpn_gateway_id` - (String)
2664
- # * `:tag_set` - (Array<Hash>)
2665
- # * `:key` - (String)
2666
- # * `:value` - (String)
2667
- # * `:vgw_telemetry` - (Array<Hash>)
2668
- # * `:outside_ip_address` - (String)
2669
- # * `:status` - (String)
2670
- # * `:last_status_change` - (Time)
2671
- # * `:status_message` - (String)
2672
- # * `:accepted_route_count` - (Integer)
2673
- # * `:options` - (Hash)
2674
- # * `:static_routes_only` - (Boolean)
2675
- # * `:routes` - (Array<Hash>)
2676
- # * `:destination_cidr_block` - (String)
2677
- # * `:source` - (String)
2678
- # * `:state` - (String)
2679
-
2680
- # @!method describe_vpn_gateways(options = {})
2681
- # Calls the DescribeVpnGateways API operation.
2682
- # @param [Hash] options
2683
- #
2684
- # * `:vpn_gateway_ids` - (Array<String>) A list of filters used to
2685
- # match properties for VPN Gateways. For a complete reference to the
2686
- # available filter keys for this operation, see the Amazon EC2 API
2687
- # reference.
2688
- # * `:filters` - (Array<Hash>) A list of filters used to match
2689
- # properties for VPN Gateways. For a complete reference to the
2690
- # available filter keys for this operation, see the Amazon EC2 API
2691
- # reference.
2692
- # * `:name` - (String) Specifies the name of the filter.
2693
- # * `:values` - (Array<String>) Contains one or more values for the
2694
- # filter.
2695
- # @return [Core::Response]
2696
- # The #data method of the response object returns
2697
- # a hash with the following structure:
2698
- #
2699
- # * `:vpn_gateway_set` - (Array<Hash>)
2700
- # * `:vpn_gateway_id` - (String)
2701
- # * `:state` - (String)
2702
- # * `:vpn_type` - (String)
2703
- # * `:availability_zone` - (String)
2704
- # * `:attachments` - (Array<Hash>)
2705
- # * `:vpc_id` - (String)
2706
- # * `:state` - (String)
2707
- # * `:tag_set` - (Array<Hash>)
2708
- # * `:key` - (String)
2709
- # * `:value` - (String)
2710
-
2711
- # @!method detach_internet_gateway(options = {})
2712
- # Calls the DetachInternetGateway API operation.
2713
- # @param [Hash] options
2714
- #
2715
- # * `:internet_gateway_id` - *required* - (String) The ID of the
2716
- # Internet gateway to detach.
2717
- # * `:vpc_id` - *required* - (String) The ID of the VPC.
2718
- # @return [Core::Response]
2719
-
2720
- # @!method detach_network_interface(options = {})
2721
- # Calls the DetachNetworkInterface API operation.
2722
- # @param [Hash] options
2723
- #
2724
- # * `:attachment_id` - *required* - (String)
2725
- # * `:force` - (Boolean)
2726
- # @return [Core::Response]
2727
-
2728
- # @!method detach_volume(options = {})
2729
- # Calls the DetachVolume API operation.
2730
- # @param [Hash] options
2731
- #
2732
- # * `:volume_id` - *required* - (String) The ID of the volume to
2733
- # detach.
2734
- # * `:instance_id` - (String) The ID of the instance from which to
2735
- # detach the the specified volume.
2736
- # * `:device` - (String) The device name to which the volume is
2737
- # attached on the specified instance.
2738
- # * `:force` - (Boolean) Forces detachment if the previous detachment
2739
- # attempt did not occur cleanly (logging into an instance, unmounting
2740
- # the volume, and detaching normally). This option can lead to data
2741
- # loss or a corrupted file system. Use this option only as a last
2742
- # resort to detach a volume from a failed instance. The instance will
2743
- # not have an opportunity to flush file system caches nor file system
2744
- # meta data. If you use this option, you must perform file system
2745
- # check and repair procedures.
2746
- # @return [Core::Response]
2747
- # The #data method of the response object returns
2748
- # a hash with the following structure:
2749
- #
2750
- # * `:volume_id` - (String)
2751
- # * `:instance_id` - (String)
2752
- # * `:device` - (String)
2753
- # * `:status` - (String)
2754
- # * `:attach_time` - (Time)
2755
- # * `:delete_on_termination` - (Boolean)
2756
-
2757
- # @!method detach_vpn_gateway(options = {})
2758
- # Calls the DetachVpnGateway API operation.
2759
- # @param [Hash] options
2760
- #
2761
- # * `:vpn_gateway_id` - *required* - (String) The ID of the VPN gateway
2762
- # to detach from the VPC.
2763
- # * `:vpc_id` - *required* - (String) The ID of the VPC to detach the
2764
- # VPN gateway from.
2765
- # @return [Core::Response]
2766
-
2767
- # @!method disable_vgw_route_propagation(options = {})
2768
- # Calls the DisableVgwRoutePropagation API operation.
2769
- # @param [Hash] options
2770
- #
2771
- # * `:route_table_id` - *required* - (String)
2772
- # * `:gateway_id` - *required* - (String)
2773
- # @return [Core::Response]
2774
-
2775
- # @!method disassociate_address(options = {})
2776
- # Calls the DisassociateAddress API operation.
2777
- # @param [Hash] options
2778
- #
2779
- # * `:public_ip` - (String) The elastic IP address that you are
2780
- # disassociating from the instance.
2781
- # * `:association_id` - (String) Association ID corresponding to the
2782
- # VPC elastic IP address you want to disassociate.
2783
- # @return [Core::Response]
2784
-
2785
- # @!method disassociate_route_table(options = {})
2786
- # Calls the DisassociateRouteTable API operation.
2787
- # @param [Hash] options
2788
- #
2789
- # * `:association_id` - *required* - (String) The association ID
2790
- # representing the current association between the route table and
2791
- # subnet.
2792
- # @return [Core::Response]
2793
-
2794
- # @!method enable_vgw_route_propagation(options = {})
2795
- # Calls the EnableVgwRoutePropagation API operation.
2796
- # @param [Hash] options
2797
- #
2798
- # * `:route_table_id` - *required* - (String)
2799
- # * `:gateway_id` - *required* - (String)
2800
- # @return [Core::Response]
2801
-
2802
- # @!method enable_volume_io(options = {})
2803
- # Calls the EnableVolumeIO API operation.
2804
- # @param [Hash] options
2805
- #
2806
- # * `:volume_id` - *required* - (String)
2807
- # @return [Core::Response]
2808
-
2809
- # @!method get_console_output(options = {})
2810
- # Calls the GetConsoleOutput API operation.
2811
- # @param [Hash] options
2812
- #
2813
- # * `:instance_id` - *required* - (String) The ID of the instance for
2814
- # which you want console output.
2815
- # @return [Core::Response]
2816
- # The #data method of the response object returns
2817
- # a hash with the following structure:
2818
- #
2819
- # * `:instance_id` - (String)
2820
- # * `:timestamp` - (Time)
2821
- # * `:output` - (String)
2822
-
2823
- # @!method get_password_data(options = {})
2824
- # Calls the GetPasswordData API operation.
2825
- # @param [Hash] options
2826
- #
2827
- # * `:instance_id` - *required* - (String) The ID of the instance for
2828
- # which you want the Windows administrator password.
2829
- # @return [Core::Response]
2830
- # The #data method of the response object returns
2831
- # a hash with the following structure:
2832
- #
2833
- # * `:instance_id` - (String)
2834
- # * `:timestamp` - (Time)
2835
- # * `:password_data` - (String)
2836
-
2837
- # @!method import_instance(options = {})
2838
- # Calls the ImportInstance API operation.
2839
- # @param [Hash] options
2840
- #
2841
- # * `:description` - (String)
2842
- # * `:launch_specification` - (Hash)
2843
- # * `:architecture` - (String)
2844
- # * `:security_groups` - (Array<String>)
2845
- # * `:additional_info` - (String)
2846
- # * `:user_data` - (String)
2847
- # * `:instance_type` - (String) Valid values include:
2848
- # * `t1.micro`
2849
- # * `m1.small`
2850
- # * `m1.medium`
2851
- # * `m1.large`
2852
- # * `m1.xlarge`
2853
- # * `m2.xlarge`
2854
- # * `m2.2xlarge`
2855
- # * `m2.4xlarge`
2856
- # * `m3.xlarge`
2857
- # * `m3.2xlarge`
2858
- # * `c1.medium`
2859
- # * `c1.xlarge`
2860
- # * `hi1.4xlarge`
2861
- # * `hs1.8xlarge`
2862
- # * `cc1.4xlarge`
2863
- # * `cc2.8xlarge`
2864
- # * `cg1.4xlarge`
2865
- # * `:placement` - (Hash)
2866
- # * `:availability_zone` - (String) The availability zone in which
2867
- # an Amazon EC2 instance runs.
2868
- # * `:group_name` - (String) The name of the PlacementGroup in
2869
- # which an Amazon EC2 instance runs. Placement groups are
2870
- # primarily used for launching High Performance Computing
2871
- # instances in the same group to ensure fast connection speeds.
2872
- # * `:tenancy` - (String) The allowed tenancy of instances launched
2873
- # into the VPC. A value of default means instances can be
2874
- # launched with any tenancy; a value of dedicated means all
2875
- # instances launched into the VPC will be launched as dedicated
2876
- # tenancy regardless of the tenancy assigned to the instance at
2877
- # launch.
2878
- # * `:block_device_mappings` - (Array<Hash>)
2879
- # * `:virtual_name` - (String) Specifies the virtual device name.
2880
- # * `:device_name` - (String) Specifies the device name (e.g.,
2881
- # /dev/sdh).
2882
- # * `:ebs` - (Hash) Specifies parameters used to automatically
2883
- # setup Amazon EBS volumes when the instance is launched.
2884
- # * `:snapshot_id` - (String) The ID of the snapshot from which
2885
- # the volume will be created.
2886
- # * `:volume_size` - (Integer) The size of the volume, in
2887
- # gigabytes.
2888
- # * `:delete_on_termination` - (Boolean) Specifies whether the
2889
- # Amazon EBS volume is deleted on instance termination.
2890
- # * `:volume_type` - (String) Valid values include:
2891
- # * `standard`
2892
- # * `io1`
2893
- # * `:iops` - (Integer)
2894
- # * `:no_device` - (String) Specifies the device name to suppress
2895
- # during instance launch.
2896
- # * `:monitoring` - (Boolean)
2897
- # * `:subnet_id` - (String)
2898
- # * `:disable_api_termination` - (Boolean)
2899
- # * `:instance_initiated_shutdown_behavior` - (String)
2900
- # * `:private_ip_address` - (String)
2901
- # * `:disk_images` - (Array<Hash>)
2902
- # * `:image` - (Hash)
2903
- # * `:format` - *required* - (String)
2904
- # * `:bytes` - *required* - (Integer)
2905
- # * `:import_manifest_url` - *required* - (String)
2906
- # * `:description` - (String)
2907
- # * `:volume` - (Hash)
2908
- # * `:size` - *required* - (Integer)
2909
- # * `:platform` - *required* - (String)
2910
- # @return [Core::Response]
2911
- # The #data method of the response object returns
2912
- # a hash with the following structure:
2913
- #
2914
- # * `:conversion_task` - (Hash)
2915
- # * `:conversion_task_id` - (String)
2916
- # * `:expiration_time` - (String)
2917
- # * `:import_instance` - (Hash)
2918
- # * `:volumes` - (Array<Hash>)
2919
- # * `:bytes_converted` - (Integer)
2920
- # * `:availability_zone` - (String)
2921
- # * `:image` - (Hash)
2922
- # * `:format` - (String)
2923
- # * `:size` - (Integer)
2924
- # * `:import_manifest_url` - (String)
2925
- # * `:checksum` - (String)
2926
- # * `:volume` - (Hash)
2927
- # * `:size` - (Integer)
2928
- # * `:id` - (String)
2929
- # * `:status` - (String)
2930
- # * `:status_message` - (String)
2931
- # * `:description` - (String)
2932
- # * `:instance_id` - (String)
2933
- # * `:platform` - (String)
2934
- # * `:description` - (String)
2935
- # * `:import_volume` - (Hash)
2936
- # * `:bytes_converted` - (Integer)
2937
- # * `:availability_zone` - (String)
2938
- # * `:description` - (String)
2939
- # * `:image` - (Hash)
2940
- # * `:format` - (String)
2941
- # * `:size` - (Integer)
2942
- # * `:import_manifest_url` - (String)
2943
- # * `:checksum` - (String)
2944
- # * `:volume` - (Hash)
2945
- # * `:size` - (Integer)
2946
- # * `:id` - (String)
2947
- # * `:state` - (String)
2948
- # * `:status_message` - (String)
2949
- # * `:tag_set` - (Array<Hash>)
2950
- # * `:key` - (String)
2951
- # * `:value` - (String)
2952
-
2953
- # @!method import_key_pair(options = {})
2954
- # Calls the ImportKeyPair API operation.
2955
- # @param [Hash] options
2956
- #
2957
- # * `:key_name` - *required* - (String) The unique name for the key
2958
- # pair.
2959
- # * `:public_key_material` - *required* - (String) The public key
2960
- # portion of the key pair being imported.
2961
- # @return [Core::Response]
2962
- # The #data method of the response object returns
2963
- # a hash with the following structure:
2964
- #
2965
- # * `:key_name` - (String)
2966
- # * `:key_fingerprint` - (String)
2967
-
2968
- # @!method import_volume(options = {})
2969
- # Calls the ImportVolume API operation.
2970
- # @param [Hash] options
2971
- #
2972
- # * `:availability_zone` - (String)
2973
- # * `:image` - (Hash)
2974
- # * `:format` - *required* - (String)
2975
- # * `:bytes` - *required* - (Integer)
2976
- # * `:import_manifest_url` - *required* - (String)
2977
- # * `:description` - (String)
2978
- # * `:volume` - (Hash)
2979
- # * `:size` - *required* - (Integer)
2980
- # @return [Core::Response]
2981
- # The #data method of the response object returns
2982
- # a hash with the following structure:
2983
- #
2984
- # * `:conversion_task` - (Hash)
2985
- # * `:conversion_task_id` - (String)
2986
- # * `:expiration_time` - (String)
2987
- # * `:import_instance` - (Hash)
2988
- # * `:volumes` - (Array<Hash>)
2989
- # * `:bytes_converted` - (Integer)
2990
- # * `:availability_zone` - (String)
2991
- # * `:image` - (Hash)
2992
- # * `:format` - (String)
2993
- # * `:size` - (Integer)
2994
- # * `:import_manifest_url` - (String)
2995
- # * `:checksum` - (String)
2996
- # * `:volume` - (Hash)
2997
- # * `:size` - (Integer)
2998
- # * `:id` - (String)
2999
- # * `:status` - (String)
3000
- # * `:status_message` - (String)
3001
- # * `:description` - (String)
3002
- # * `:instance_id` - (String)
3003
- # * `:platform` - (String)
3004
- # * `:description` - (String)
3005
- # * `:import_volume` - (Hash)
3006
- # * `:bytes_converted` - (Integer)
3007
- # * `:availability_zone` - (String)
3008
- # * `:description` - (String)
3009
- # * `:image` - (Hash)
3010
- # * `:format` - (String)
3011
- # * `:size` - (Integer)
3012
- # * `:import_manifest_url` - (String)
3013
- # * `:checksum` - (String)
3014
- # * `:volume` - (Hash)
3015
- # * `:size` - (Integer)
3016
- # * `:id` - (String)
3017
- # * `:state` - (String)
3018
- # * `:status_message` - (String)
3019
- # * `:tag_set` - (Array<Hash>)
3020
- # * `:key` - (String)
3021
- # * `:value` - (String)
3022
-
3023
- # @!method modify_image_attribute(options = {})
3024
- # Calls the ModifyImageAttribute API operation.
3025
- # @param [Hash] options
3026
- #
3027
- # * `:image_id` - *required* - (String) The ID of the AMI whose
3028
- # attribute you want to modify.
3029
- # * `:attribute` - (String) The name of the AMI attribute you want to
3030
- # modify. Available attributes: launchPermission, productCodes
3031
- # * `:operation_type` - (String) The type of operation being requested.
3032
- # Available operation types: add, remove
3033
- # * `:user_ids` - (Array<String>) The AWS user ID being added to or
3034
- # removed from the list of users with launch permissions for this
3035
- # AMI. Only valid when the launchPermission attribute is being
3036
- # modified.
3037
- # * `:user_groups` - (Array<String>) The user group being added to or
3038
- # removed from the list of user groups with launch permissions for
3039
- # this AMI. Only valid when the launchPermission attribute is being
3040
- # modified. Available user groups: all
3041
- # * `:product_codes` - (Array<String>) The list of product codes being
3042
- # added to or removed from the specified AMI. Only valid when the
3043
- # productCodes attribute is being modified.
3044
- # * `:value` - (String) The value of the attribute being modified. Only
3045
- # valid when the description attribute is being modified.
3046
- # * `:launch_permission` - (Hash)
3047
- # * `:add` - (Array<Hash>)
3048
- # * `:user_id` - (String) The AWS user ID of the user involved in
3049
- # this launch permission.
3050
- # * `:group` - (String) The AWS group of the user involved in this
3051
- # launch permission. Available groups: all
3052
- # * `:remove` - (Array<Hash>)
3053
- # * `:user_id` - (String) The AWS user ID of the user involved in
3054
- # this launch permission.
3055
- # * `:group` - (String) The AWS group of the user involved in this
3056
- # launch permission. Available groups: all
3057
- # * `:description` - (Hash)
3058
- # * `:value` - (String) String value
3059
- # @return [Core::Response]
3060
-
3061
- # @!method modify_instance_attribute(options = {})
3062
- # Calls the ModifyInstanceAttribute API operation.
3063
- # @param [Hash] options
3064
- #
3065
- # * `:instance_id` - *required* - (String) The ID of the instance whose
3066
- # attribute is being modified.
3067
- # * `:attribute` - (String) The name of the attribute being modified.
3068
- # Available attribute names: instanceType, kernel, ramdisk, userData,
3069
- # disableApiTermination, instanceInitiatedShutdownBehavior,
3070
- # rootDevice, blockDeviceMapping Valid values include:
3071
- # * `instanceType`
3072
- # * `kernel`
3073
- # * `ramdisk`
3074
- # * `userData`
3075
- # * `disableApiTermination`
3076
- # * `instanceInitiatedShutdownBehavior`
3077
- # * `rootDeviceName`
3078
- # * `blockDeviceMapping`
3079
- # * `productCodes`
3080
- # * `sourceDestCheck`
3081
- # * `groupSet`
3082
- # * `ebsOptimized`
3083
- # * `:value` - (String) The new value of the instance attribute being
3084
- # modified. Only valid when kernel, ramdisk, userData,
3085
- # disableApiTermination or instanceInitiateShutdownBehavior is
3086
- # specified as the attribute being modified.
3087
- # * `:block_device_mappings` - (Array<Hash>) The new block device
3088
- # mappings for the instance whose attributes are being modified. Only
3089
- # valid when blockDeviceMapping is specified as the attribute being
3090
- # modified.
3091
- # * `:device_name` - (String) The device name (e.g., /dev/sdh) at
3092
- # which the block device is exposed on the instance.
3093
- # * `:ebs` - (Hash) The EBS instance block device specification
3094
- # describing the EBS block device to map to the specified device
3095
- # name on a running instance.
3096
- # * `:volume_id` - (String) The ID of the EBS volume that should be
3097
- # mounted as a block device on an Amazon EC2 instance.
3098
- # * `:delete_on_termination` - (Boolean) Specifies whether the
3099
- # Amazon EBS volume is deleted on instance termination.
3100
- # * `:virtual_name` - (String) The virtual device name.
3101
- # * `:no_device` - (String) When set to the empty string, specifies
3102
- # that the device name in this object should not be mapped to any
3103
- # real device.
3104
- # * `:source_dest_check` - (Hash)
3105
- # * `:value` - (Boolean) Boolean value
3106
- # * `:disable_api_termination` - (Hash)
3107
- # * `:value` - (Boolean) Boolean value
3108
- # * `:instance_type` - (Hash)
3109
- # * `:value` - (String) String value
3110
- # * `:kernel` - (Hash)
3111
- # * `:value` - (String) String value
3112
- # * `:ramdisk` - (Hash)
3113
- # * `:value` - (String) String value
3114
- # * `:user_data` - (Hash)
3115
- # * `:value` - (String) String value
3116
- # * `:instance_initiated_shutdown_behavior` - (Hash)
3117
- # * `:value` - (String) String value
3118
- # * `:groups` - (Array<String>)
3119
- # * `:ebs_optimized` - (Hash)
3120
- # * `:value` - (Boolean) Boolean value
3121
- # @return [Core::Response]
3122
-
3123
- # @!method modify_network_interface_attribute(options = {})
3124
- # Calls the ModifyNetworkInterfaceAttribute API operation.
3125
- # @param [Hash] options
3126
- #
3127
- # * `:network_interface_id` - *required* - (String)
3128
- # * `:description` - (Hash)
3129
- # * `:value` - (String) String value
3130
- # * `:source_dest_check` - (Hash)
3131
- # * `:value` - (Boolean) Boolean value
3132
- # * `:groups` - (Array<String>)
3133
- # * `:attachment` - (Hash)
3134
- # * `:attachment_id` - (String)
3135
- # * `:delete_on_termination` - (Boolean)
3136
- # @return [Core::Response]
3137
-
3138
- # @!method modify_snapshot_attribute(options = {})
3139
- # Calls the ModifySnapshotAttribute API operation.
3140
- # @param [Hash] options
3141
- #
3142
- # * `:snapshot_id` - *required* - (String) The ID of the EBS snapshot
3143
- # whose attributes are being modified.
3144
- # * `:attribute` - (String) The name of the attribute being modified.
3145
- # Available attribute names: createVolumePermission Valid values
3146
- # include:
3147
- # * `productCodes`
3148
- # * `createVolumePermission`
3149
- # * `:operation_type` - (String) The operation to perform on the
3150
- # attribute. Available operation names: add, remove
3151
- # * `:user_ids` - (Array<String>) The AWS user IDs to add to or remove
3152
- # from the list of users that have permission to create EBS volumes
3153
- # from the specified snapshot. Currently supports "all". Only valid
3154
- # when the createVolumePermission attribute is being modified.
3155
- # * `:group_names` - (Array<String>) The AWS group names to add to or
3156
- # remove from the list of groups that have permission to create EBS
3157
- # volumes from the specified snapshot. Currently supports "all". Only
3158
- # valid when the createVolumePermission attribute is being modified.
3159
- # * `:create_volume_permission` - (Hash)
3160
- # * `:add` - (Array<Hash>)
3161
- # * `:user_id` - (String) The user ID of the user that can create
3162
- # volumes from the snapshot.
3163
- # * `:group` - (String) The group that is allowed to create volumes
3164
- # from the snapshot (currently supports "all").
3165
- # * `:remove` - (Array<Hash>)
3166
- # * `:user_id` - (String) The user ID of the user that can create
3167
- # volumes from the snapshot.
3168
- # * `:group` - (String) The group that is allowed to create volumes
3169
- # from the snapshot (currently supports "all").
3170
- # @return [Core::Response]
3171
-
3172
- # @!method modify_volume_attribute(options = {})
3173
- # Calls the ModifyVolumeAttribute API operation.
3174
- # @param [Hash] options
3175
- #
3176
- # * `:volume_id` - *required* - (String)
3177
- # * `:auto_enable_io` - (Boolean)
3178
- # @return [Core::Response]
3179
-
3180
- # @!method modify_vpc_attribute(options = {})
3181
- # Calls the ModifyVpcAttribute API operation.
3182
- # @param [Hash] options
3183
- #
3184
- # * `:vpc_id` - *required* - (String)
3185
- # * `:enable_dns_support` - (Hash)
3186
- # * `:value` - (Boolean) Boolean value
3187
- # * `:enable_dns_hostnames` - (Hash)
3188
- # * `:value` - (Boolean) Boolean value
3189
- # @return [Core::Response]
3190
-
3191
- # @!method monitor_instances(options = {})
3192
- # Calls the MonitorInstances API operation.
3193
- # @param [Hash] options
3194
- #
3195
- # * `:instance_ids` - *required* - (Array<String>) The list of Amazon
3196
- # EC2 instances on which to enable monitoring.
3197
- # @return [Core::Response]
3198
- # The #data method of the response object returns
3199
- # a hash with the following structure:
3200
- #
3201
- # * `:instances_set` - (Array<Hash>)
3202
- # * `:instance_id` - (String)
3203
- # * `:monitoring` - (Hash)
3204
- # * `:state` - (String)
3205
-
3206
- # @!method purchase_reserved_instances_offering(options = {})
3207
- # Calls the PurchaseReservedInstancesOffering API operation.
3208
- # @param [Hash] options
3209
- #
3210
- # * `:reserved_instances_offering_id` - *required* - (String) The
3211
- # unique ID of the Reserved Instances offering being purchased.
3212
- # * `:instance_count` - *required* - (Integer) The number of Reserved
3213
- # Instances to purchase.
3214
- # * `:limit_price` - (Hash)
3215
- # * `:amount` - (Float)
3216
- # * `:currency_code` - (String)
3217
- # @return [Core::Response]
3218
- # The #data method of the response object returns
3219
- # a hash with the following structure:
3220
- #
3221
- # * `:reserved_instances_id` - (String)
3222
-
3223
- # @!method reboot_instances(options = {})
3224
- # Calls the RebootInstances API operation.
3225
- # @param [Hash] options
3226
- #
3227
- # * `:instance_ids` - *required* - (Array<String>) The list of
3228
- # instances to terminate.
3229
- # @return [Core::Response]
3230
-
3231
- # @!method register_image(options = {})
3232
- # Calls the RegisterImage API operation.
3233
- # @param [Hash] options
3234
- #
3235
- # * `:image_location` - (String) The full path to your AMI manifest in
3236
- # Amazon S3 storage.
3237
- # * `:name` - (String) The name to give the new Amazon Machine Image.
3238
- # Constraints: 3-128 alphanumeric characters, parenthesis (()),
3239
- # commas (,), slashes (/), dashes (-), or underscores(_)
3240
- # * `:description` - (String) The description describing the new AMI.
3241
- # * `:architecture` - (String) The architecture of the image. Valid
3242
- # Values: i386, x86_64
3243
- # * `:kernel_id` - (String) The optional ID of a specific kernel to
3244
- # register with the new AMI.
3245
- # * `:ramdisk_id` - (String) The optional ID of a specific ramdisk to
3246
- # register with the new AMI. Some kernels require additional drivers
3247
- # at launch. Check the kernel requirements for information on whether
3248
- # you need to specify a RAM disk.
3249
- # * `:root_device_name` - (String) The root device name (e.g.,
3250
- # /dev/sda1).
3251
- # * `:block_device_mappings` - (Array<Hash>) The block device mappings
3252
- # for the new AMI, which specify how different block devices (ex: EBS
3253
- # volumes and ephemeral drives) will be exposed on instances launched
3254
- # from the new image.
3255
- # * `:virtual_name` - (String) Specifies the virtual device name.
3256
- # * `:device_name` - (String) Specifies the device name (e.g.,
3257
- # /dev/sdh).
3258
- # * `:ebs` - (Hash) Specifies parameters used to automatically setup
3259
- # Amazon EBS volumes when the instance is launched.
3260
- # * `:snapshot_id` - (String) The ID of the snapshot from which the
3261
- # volume will be created.
3262
- # * `:volume_size` - (Integer) The size of the volume, in
3263
- # gigabytes.
3264
- # * `:delete_on_termination` - (Boolean) Specifies whether the
3265
- # Amazon EBS volume is deleted on instance termination.
3266
- # * `:volume_type` - (String) Valid values include:
3267
- # * `standard`
3268
- # * `io1`
3269
- # * `:iops` - (Integer)
3270
- # * `:no_device` - (String) Specifies the device name to suppress
3271
- # during instance launch.
3272
- # @return [Core::Response]
3273
- # The #data method of the response object returns
3274
- # a hash with the following structure:
3275
- #
3276
- # * `:image_id` - (String)
3277
-
3278
- # @!method release_address(options = {})
3279
- # Calls the ReleaseAddress API operation.
3280
- # @param [Hash] options
3281
- #
3282
- # * `:public_ip` - (String) The elastic IP address that you are
3283
- # releasing from your account.
3284
- # * `:allocation_id` - (String) The allocation ID that AWS provided
3285
- # when you allocated the address for use with Amazon VPC.
3286
- # @return [Core::Response]
3287
-
3288
- # @!method replace_network_acl_association(options = {})
3289
- # Calls the ReplaceNetworkAclAssociation API operation.
3290
- # @param [Hash] options
3291
- #
3292
- # * `:association_id` - *required* - (String) The ID representing the
3293
- # current association between the original network ACL and the
3294
- # subnet.
3295
- # * `:network_acl_id` - *required* - (String) The ID of the new ACL to
3296
- # associate with the subnet.
3297
- # @return [Core::Response]
3298
- # The #data method of the response object returns
3299
- # a hash with the following structure:
3300
- #
3301
- # * `:new_association_id` - (String)
3302
-
3303
- # @!method replace_network_acl_entry(options = {})
3304
- # Calls the ReplaceNetworkAclEntry API operation.
3305
- # @param [Hash] options
3306
- #
3307
- # * `:network_acl_id` - *required* - (String) ID of the ACL where the
3308
- # entry will be replaced.
3309
- # * `:rule_number` - *required* - (Integer) Rule number of the entry to
3310
- # replace.
3311
- # * `:protocol` - *required* - (String) IP protocol the rule applies
3312
- # to. Valid Values: tcp, udp, icmp or an IP protocol number.
3313
- # * `:rule_action` - *required* - (String) Whether to allow or deny
3314
- # traffic that matches the rule. Valid values include:
3315
- # * `allow`
3316
- # * `deny`
3317
- # * `:egress` - *required* - (Boolean) Whether this rule applies to
3318
- # egress traffic from the subnet ( `true` ) or ingress traffic (
3319
- # `false` ).
3320
- # * `:cidr_block` - *required* - (String) The CIDR range to allow or
3321
- # deny, in CIDR notation (e.g., 172.16.0.0/24).
3322
- # * `:icmp_type_code` - (Hash) ICMP values.
3323
- # * `:type` - (Integer) For the ICMP protocol, the ICMP type. A value
3324
- # of -1 is a wildcard meaning all types. Required if specifying
3325
- # icmp for the protocol.
3326
- # * `:code` - (Integer) For the ICMP protocol, the ICMP code. A value
3327
- # of -1 is a wildcard meaning all codes. Required if specifying
3328
- # icmp for the protocol.
3329
- # * `:port_range` - (Hash) Port ranges.
3330
- # * `:from` - (Integer) The first port in the range. Required if
3331
- # specifying tcp or udp for the protocol.
3332
- # * `:to` - (Integer) The last port in the range. Required if
3333
- # specifying tcp or udp for the protocol.
3334
- # @return [Core::Response]
3335
-
3336
- # @!method replace_route(options = {})
3337
- # Calls the ReplaceRoute API operation.
3338
- # @param [Hash] options
3339
- #
3340
- # * `:route_table_id` - *required* - (String) The ID of the route table
3341
- # where the route will be replaced.
3342
- # * `:destination_cidr_block` - *required* - (String) The CIDR address
3343
- # block used for the destination match. For example: 0.0.0.0/0. The
3344
- # value you provide must match the CIDR of an existing route in the
3345
- # table.
3346
- # * `:gateway_id` - (String) The ID of a VPN or Internet gateway
3347
- # attached to your VPC.
3348
- # * `:instance_id` - (String) The ID of a NAT instance in your VPC.
3349
- # * `:network_interface_id` - (String)
3350
- # @return [Core::Response]
3351
-
3352
- # @!method replace_route_table_association(options = {})
3353
- # Calls the ReplaceRouteTableAssociation API operation.
3354
- # @param [Hash] options
3355
- #
3356
- # * `:association_id` - *required* - (String) The ID representing the
3357
- # current association between the original route table and the
3358
- # subnet.
3359
- # * `:route_table_id` - *required* - (String) The ID of the new route
3360
- # table to associate with the subnet.
3361
- # @return [Core::Response]
3362
- # The #data method of the response object returns
3363
- # a hash with the following structure:
3364
- #
3365
- # * `:new_association_id` - (String)
3366
-
3367
- # @!method report_instance_status(options = {})
3368
- # Calls the ReportInstanceStatus API operation.
3369
- # @param [Hash] options
3370
- #
3371
- # * `:instances` - (Array<String>)
3372
- # * `:status` - (String)
3373
- # * `:start_time` - (String<ISO8601 datetime>)
3374
- # * `:end_time` - (String<ISO8601 datetime>)
3375
- # * `:reason_codes` - (Array<String>)
3376
- # * `:description` - (String)
3377
- # @return [Core::Response]
3378
-
3379
- # @!method request_spot_instances(options = {})
3380
- # Calls the RequestSpotInstances API operation.
3381
- # @param [Hash] options
3382
- #
3383
- # * `:spot_price` - *required* - (String) Specifies the maximum hourly
3384
- # price for any Spot Instance launched to fulfill the request.
3385
- # * `:instance_count` - (Integer) Specifies the maximum number of Spot
3386
- # Instances to launch.
3387
- # * `:type` - (String) Specifies the Spot Instance type. Valid values
3388
- # include:
3389
- # * `one-time`
3390
- # * `persistent`
3391
- # * `:valid_from` - (String<ISO8601 datetime>) Defines the start date
3392
- # of the request. If this is a one-time request, the request becomes
3393
- # active at this date and time and remains active until all instances
3394
- # launch, the request expires, or the request is canceled. If the
3395
- # request is persistent, the request becomes active at this date and
3396
- # time and remains active until it expires or is canceled.
3397
- # * `:valid_until` - (String<ISO8601 datetime>) End date of the
3398
- # request. If this is a one-time request, the request remains active
3399
- # until all instances launch, the request is canceled, or this date
3400
- # is reached. If the request is persistent, it remains active until
3401
- # it is canceled or this date and time is reached.
3402
- # * `:launch_group` - (String) Specifies the instance launch group.
3403
- # Launch groups are Spot Instances that launch and terminate
3404
- # together.
3405
- # * `:availability_zone_group` - (String) Specifies the Availability
3406
- # Zone group. When specifying the same Availability Zone group for
3407
- # all Spot Instance requests, all Spot Instances are launched in the
3408
- # same Availability Zone.
3409
- # * `:launch_specification` - (Hash) Specifies additional launch
3410
- # instance information.
3411
- # * `:image_id` - (String) The AMI ID.
3412
- # * `:key_name` - (String) The name of the key pair.
3413
- # * `:user_data` - (String) Optional data, specific to a user's
3414
- # application, to provide in the launch request. All instances that
3415
- # collectively comprise the launch request have access to this
3416
- # data. User data is never returned through API responses.
3417
- # * `:addressing_type` - (String) Deprecated.
3418
- # * `:instance_type` - (String) Specifies the instance type. Valid
3419
- # values include:
3420
- # * `t1.micro`
3421
- # * `m1.small`
3422
- # * `m1.medium`
3423
- # * `m1.large`
3424
- # * `m1.xlarge`
3425
- # * `m2.xlarge`
3426
- # * `m2.2xlarge`
3427
- # * `m2.4xlarge`
3428
- # * `m3.xlarge`
3429
- # * `m3.2xlarge`
3430
- # * `c1.medium`
3431
- # * `c1.xlarge`
3432
- # * `hi1.4xlarge`
3433
- # * `hs1.8xlarge`
3434
- # * `cc1.4xlarge`
3435
- # * `cc2.8xlarge`
3436
- # * `cg1.4xlarge`
3437
- # * `:placement` - (Hash) Defines a placement item.
3438
- # * `:availability_zone` - (String) The availability zone in which
3439
- # an Amazon EC2 instance runs.
3440
- # * `:group_name` - (String) The name of the PlacementGroup in
3441
- # which an Amazon EC2 instance runs. Placement groups are
3442
- # primarily used for launching High Performance Computing
3443
- # instances in the same group to ensure fast connection speeds.
3444
- # * `:kernel_id` - (String) Specifies the ID of the kernel to select.
3445
- # * `:ramdisk_id` - (String) Specifies the ID of the RAM disk to
3446
- # select. Some kernels require additional drivers at launch. Check
3447
- # the kernel requirements for information on whether or not you
3448
- # need to specify a RAM disk and search for the kernel ID.
3449
- # * `:block_device_mappings` - (Array<Hash>) Specifies how block
3450
- # devices are exposed to the instance. Each mapping is made up of a
3451
- # virtualName and a deviceName.
3452
- # * `:virtual_name` - (String) Specifies the virtual device name.
3453
- # * `:device_name` - (String) Specifies the device name (e.g.,
3454
- # /dev/sdh).
3455
- # * `:ebs` - (Hash) Specifies parameters used to automatically
3456
- # setup Amazon EBS volumes when the instance is launched.
3457
- # * `:snapshot_id` - (String) The ID of the snapshot from which
3458
- # the volume will be created.
3459
- # * `:volume_size` - (Integer) The size of the volume, in
3460
- # gigabytes.
3461
- # * `:delete_on_termination` - (Boolean) Specifies whether the
3462
- # Amazon EBS volume is deleted on instance termination.
3463
- # * `:volume_type` - (String) Valid values include:
3464
- # * `standard`
3465
- # * `io1`
3466
- # * `:iops` - (Integer)
3467
- # * `:no_device` - (String) Specifies the device name to suppress
3468
- # during instance launch.
3469
- # * `:monitoring_enabled` - (Boolean) Enables monitoring for the
3470
- # instance.
3471
- # * `:subnet_id` - (String) Specifies the Amazon VPC subnet ID within
3472
- # which to launch the instance(s) for Amazon Virtual Private Cloud.
3473
- # * `:network_interfaces` - (Array<Hash>)
3474
- # * `:network_interface_id` - (String)
3475
- # * `:device_index` - (Integer)
3476
- # * `:subnet_id` - (String)
3477
- # * `:description` - (String)
3478
- # * `:private_ip_address` - (String)
3479
- # * `:groups` - (Array<String>)
3480
- # * `:delete_on_termination` - (Boolean)
3481
- # * `:private_ip_addresses` - (Array<Hash>)
3482
- # * `:private_ip_address` - *required* - (String)
3483
- # * `:primary` - (Boolean)
3484
- # * `:secondary_private_ip_address_count` - (Integer)
3485
- # * `:iam_instance_profile` - (Hash)
3486
- # * `:arn` - (String)
3487
- # * `:name` - (String)
3488
- # * `:ebs_optimized` - (Boolean)
3489
- # * `:security_groups` - (Array<String>)
3490
- # * `:security_group_ids` - (Array<String>)
3491
- # @return [Core::Response]
3492
- # The #data method of the response object returns
3493
- # a hash with the following structure:
3494
- #
3495
- # * `:spot_instance_request_set` - (Array<Hash>)
3496
- # * `:spot_instance_request_id` - (String)
3497
- # * `:spot_price` - (String)
3498
- # * `:type` - (String)
3499
- # * `:state` - (String)
3500
- # * `:fault` - (Hash)
3501
- # * `:code` - (String)
3502
- # * `:message` - (String)
3503
- # * `:status` - (Hash)
3504
- # * `:code` - (String)
3505
- # * `:update_time` - (Time)
3506
- # * `:message` - (String)
3507
- # * `:valid_from` - (Time)
3508
- # * `:valid_until` - (Time)
3509
- # * `:launch_group` - (String)
3510
- # * `:availability_zone_group` - (String)
3511
- # * `:launch_specification` - (Hash)
3512
- # * `:image_id` - (String)
3513
- # * `:key_name` - (String)
3514
- # * `:group_set` - (Array<Hash>)
3515
- # * `:group_name` - (String)
3516
- # * `:group_id` - (String)
3517
- # * `:user_data` - (String)
3518
- # * `:addressing_type` - (String)
3519
- # * `:instance_type` - (String)
3520
- # * `:placement` - (Hash)
3521
- # * `:availability_zone` - (String)
3522
- # * `:group_name` - (String)
3523
- # * `:kernel_id` - (String)
3524
- # * `:ramdisk_id` - (String)
3525
- # * `:block_device_mapping` - (Array<Hash>)
3526
- # * `:virtual_name` - (String)
3527
- # * `:device_name` - (String)
3528
- # * `:ebs` - (Hash)
3529
- # * `:snapshot_id` - (String)
3530
- # * `:volume_size` - (Integer)
3531
- # * `:delete_on_termination` - (Boolean)
3532
- # * `:volume_type` - (String)
3533
- # * `:iops` - (Integer)
3534
- # * `:no_device` - (String)
3535
- # * `:monitoring_enabled` - (Boolean)
3536
- # * `:subnet_id` - (String)
3537
- # * `:network_interface_set` - (Array<Hash>)
3538
- # * `:network_interface_id` - (String)
3539
- # * `:device_index` - (Integer)
3540
- # * `:subnet_id` - (String)
3541
- # * `:description` - (String)
3542
- # * `:private_ip_address` - (String)
3543
- # * `:security_group_id` - (Array<String>)
3544
- # * `:delete_on_termination` - (Boolean)
3545
- # * `:private_ip_addresses_set` - (Array<Hash>)
3546
- # * `:private_ip_address` - (String)
3547
- # * `:primary` - (Boolean)
3548
- # * `:secondary_private_ip_address_count` - (Integer)
3549
- # * `:iam_instance_profile` - (Hash)
3550
- # * `:arn` - (String)
3551
- # * `:name` - (String)
3552
- # * `:ebs_optimized` - (Boolean)
3553
- # * `:instance_id` - (String)
3554
- # * `:create_time` - (Time)
3555
- # * `:product_description` - (String)
3556
- # * `:tag_set` - (Array<Hash>)
3557
- # * `:key` - (String)
3558
- # * `:value` - (String)
3559
- # * `:launched_availability_zone` - (String)
3560
-
3561
- # @!method reset_image_attribute(options = {})
3562
- # Calls the ResetImageAttribute API operation.
3563
- # @param [Hash] options
3564
- #
3565
- # * `:image_id` - *required* - (String) The ID of the AMI whose
3566
- # attribute is being reset.
3567
- # * `:attribute` - *required* - (String) The name of the attribute
3568
- # being reset. Available attribute names: launchPermission
3569
- # @return [Core::Response]
3570
-
3571
- # @!method reset_instance_attribute(options = {})
3572
- # Calls the ResetInstanceAttribute API operation.
3573
- # @param [Hash] options
3574
- #
3575
- # * `:instance_id` - *required* - (String) The ID of the Amazon EC2
3576
- # instance whose attribute is being reset.
3577
- # * `:attribute` - *required* - (String) The name of the attribute
3578
- # being reset. Available attribute names: kernel, ramdisk Valid
3579
- # values include:
3580
- # * `instanceType`
3581
- # * `kernel`
3582
- # * `ramdisk`
3583
- # * `userData`
3584
- # * `disableApiTermination`
3585
- # * `instanceInitiatedShutdownBehavior`
3586
- # * `rootDeviceName`
3587
- # * `blockDeviceMapping`
3588
- # * `productCodes`
3589
- # * `sourceDestCheck`
3590
- # * `groupSet`
3591
- # * `ebsOptimized`
3592
- # @return [Core::Response]
3593
-
3594
- # @!method reset_network_interface_attribute(options = {})
3595
- # Calls the ResetNetworkInterfaceAttribute API operation.
3596
- # @param [Hash] options
3597
- #
3598
- # * `:network_interface_id` - *required* - (String)
3599
- # * `:source_dest_check` - (String)
3600
- # @return [Core::Response]
3601
-
3602
- # @!method reset_snapshot_attribute(options = {})
3603
- # Calls the ResetSnapshotAttribute API operation.
3604
- # @param [Hash] options
3605
- #
3606
- # * `:snapshot_id` - *required* - (String) The ID of the snapshot whose
3607
- # attribute is being reset.
3608
- # * `:attribute` - *required* - (String) The name of the attribute
3609
- # being reset. Available attribute names: createVolumePermission
3610
- # Valid values include:
3611
- # * `productCodes`
3612
- # * `createVolumePermission`
3613
- # @return [Core::Response]
3614
-
3615
- # @!method revoke_security_group_egress(options = {})
3616
- # Calls the RevokeSecurityGroupEgress API operation.
3617
- # @param [Hash] options
3618
- #
3619
- # * `:group_id` - *required* - (String) ID of the VPC security group to
3620
- # modify.
3621
- # * `:source_security_group_name` - (String) Deprecated.
3622
- # * `:source_security_group_owner_id` - (String) Deprecated.
3623
- # * `:ip_protocol` - (String) Deprecated.
3624
- # * `:from_port` - (Integer) Deprecated.
3625
- # * `:to_port` - (Integer) Deprecated.
3626
- # * `:cidr_ip` - (String) Deprecated.
3627
- # * `:ip_permissions` - (Array<Hash>) List of IP permissions to
3628
- # authorize on the specified security group. Specifying permissions
3629
- # through IP permissions is the preferred way of authorizing
3630
- # permissions since it offers more flexibility and control.
3631
- # * `:ip_protocol` - (String) The IP protocol of this permission.
3632
- # Valid protocol values: tcp, udp, icmp
3633
- # * `:from_port` - (Integer) Start of port range for the TCP and UDP
3634
- # protocols, or an ICMP type number. An ICMP type number of -1
3635
- # indicates a wildcard (i.e., any ICMP type number).
3636
- # * `:to_port` - (Integer) End of port range for the TCP and UDP
3637
- # protocols, or an ICMP code. An ICMP code of -1 indicates a
3638
- # wildcard (i.e., any ICMP code).
3639
- # * `:user_id_group_pairs` - (Array<Hash>) The list of AWS user IDs
3640
- # and groups included in this permission.
3641
- # * `:user_id` - (String) The AWS user ID of an account.
3642
- # * `:group_name` - (String) Name of the security group in the
3643
- # specified AWS account. Cannot be used when specifying a CIDR IP
3644
- # address range.
3645
- # * `:group_id` - (String) ID of the security group in the
3646
- # specified AWS account. Cannot be used when specifying a CIDR IP
3647
- # address range.
3648
- # * `:ip_ranges` - (Array<Hash>) The list of CIDR IP ranges included
3649
- # in this permission.
3650
- # * `:cidr_ip` - (String) The list of CIDR IP ranges.
3651
- # @return [Core::Response]
3652
-
3653
- # @!method revoke_security_group_ingress(options = {})
3654
- # Calls the RevokeSecurityGroupIngress API operation.
3655
- # @param [Hash] options
3656
- #
3657
- # * `:group_name` - (String) Name of the standard (EC2) security group
3658
- # to modify. The group must belong to your account. Can be used
3659
- # instead of GroupID for standard (EC2) security groups.
3660
- # * `:group_id` - (String) ID of the standard (EC2) or VPC security
3661
- # group to modify. The group must belong to your account. Required
3662
- # for VPC security groups; can be used instead of GroupName for
3663
- # standard (EC2) security groups.
3664
- # * `:source_security_group_name` - (String) Deprecated
3665
- # * `:source_security_group_owner_id` - (String) Deprecated
3666
- # * `:ip_protocol` - (String) Deprecated
3667
- # * `:from_port` - (Integer) Deprecated
3668
- # * `:to_port` - (Integer) Deprecated
3669
- # * `:cidr_ip` - (String) Deprecated
3670
- # * `:ip_permissions` - (Array<Hash>) List of IP permissions to revoke
3671
- # on the specified security group. For an IP permission to be
3672
- # removed, it must exactly match one of the IP permissions you
3673
- # specify in this list. Specifying permissions through IP permissions
3674
- # is the preferred way of revoking permissions since it offers more
3675
- # flexibility and control.
3676
- # * `:ip_protocol` - (String) The IP protocol of this permission.
3677
- # Valid protocol values: tcp, udp, icmp
3678
- # * `:from_port` - (Integer) Start of port range for the TCP and UDP
3679
- # protocols, or an ICMP type number. An ICMP type number of -1
3680
- # indicates a wildcard (i.e., any ICMP type number).
3681
- # * `:to_port` - (Integer) End of port range for the TCP and UDP
3682
- # protocols, or an ICMP code. An ICMP code of -1 indicates a
3683
- # wildcard (i.e., any ICMP code).
3684
- # * `:user_id_group_pairs` - (Array<Hash>) The list of AWS user IDs
3685
- # and groups included in this permission.
3686
- # * `:user_id` - (String) The AWS user ID of an account.
3687
- # * `:group_name` - (String) Name of the security group in the
3688
- # specified AWS account. Cannot be used when specifying a CIDR IP
3689
- # address range.
3690
- # * `:group_id` - (String) ID of the security group in the
3691
- # specified AWS account. Cannot be used when specifying a CIDR IP
3692
- # address range.
3693
- # * `:ip_ranges` - (Array<Hash>) The list of CIDR IP ranges included
3694
- # in this permission.
3695
- # * `:cidr_ip` - (String) The list of CIDR IP ranges.
3696
- # @return [Core::Response]
3697
-
3698
- # @!method run_instances(options = {})
3699
- # Calls the RunInstances API operation.
3700
- # @param [Hash] options
3701
- #
3702
- # * `:image_id` - *required* - (String) Unique ID of a machine image,
3703
- # returned by a call to DescribeImages.
3704
- # * `:min_count` - *required* - (Integer) Minimum number of instances
3705
- # to launch. If the value is more than Amazon EC2 can launch, no
3706
- # instances are launched at all.
3707
- # * `:max_count` - *required* - (Integer) Maximum number of instances
3708
- # to launch. If the value is more than Amazon EC2 can launch, the
3709
- # largest possible number above minCount will be launched instead.
3710
- # Between 1 and the maximum number allowed for your account (default:
3711
- # 20).
3712
- # * `:key_name` - (String) The name of the key pair.
3713
- # * `:security_groups` - (Array<String>) The names of the security
3714
- # groups into which the instances will be launched.
3715
- # * `:security_group_ids` - (Array<String>)
3716
- # * `:user_data` - (String) Specifies additional information to make
3717
- # available to the instance(s).
3718
- # * `:instance_type` - (String) Specifies the instance type for the
3719
- # launched instances. Valid values include:
3720
- # * `t1.micro`
3721
- # * `m1.small`
3722
- # * `m1.medium`
3723
- # * `m1.large`
3724
- # * `m1.xlarge`
3725
- # * `m2.xlarge`
3726
- # * `m2.2xlarge`
3727
- # * `m2.4xlarge`
3728
- # * `m3.xlarge`
3729
- # * `m3.2xlarge`
3730
- # * `c1.medium`
3731
- # * `c1.xlarge`
3732
- # * `hi1.4xlarge`
3733
- # * `hs1.8xlarge`
3734
- # * `cc1.4xlarge`
3735
- # * `cc2.8xlarge`
3736
- # * `cg1.4xlarge`
3737
- # * `:placement` - (Hash) Specifies the placement constraints
3738
- # (Availability Zones) for launching the instances.
3739
- # * `:availability_zone` - (String) The availability zone in which an
3740
- # Amazon EC2 instance runs.
3741
- # * `:group_name` - (String) The name of the PlacementGroup in which
3742
- # an Amazon EC2 instance runs. Placement groups are primarily used
3743
- # for launching High Performance Computing instances in the same
3744
- # group to ensure fast connection speeds.
3745
- # * `:tenancy` - (String) The allowed tenancy of instances launched
3746
- # into the VPC. A value of default means instances can be launched
3747
- # with any tenancy; a value of dedicated means all instances
3748
- # launched into the VPC will be launched as dedicated tenancy
3749
- # regardless of the tenancy assigned to the instance at launch.
3750
- # * `:kernel_id` - (String) The ID of the kernel with which to launch
3751
- # the instance.
3752
- # * `:ramdisk_id` - (String) The ID of the RAM disk with which to
3753
- # launch the instance. Some kernels require additional drivers at
3754
- # launch. Check the kernel requirements for information on whether
3755
- # you need to specify a RAM disk. To find kernel requirements, go to
3756
- # the Resource Center and search for the kernel ID.
3757
- # * `:block_device_mappings` - (Array<Hash>) Specifies how block
3758
- # devices are exposed to the instance. Each mapping is made up of a
3759
- # virtualName and a deviceName.
3760
- # * `:virtual_name` - (String) Specifies the virtual device name.
3761
- # * `:device_name` - (String) Specifies the device name (e.g.,
3762
- # /dev/sdh).
3763
- # * `:ebs` - (Hash) Specifies parameters used to automatically setup
3764
- # Amazon EBS volumes when the instance is launched.
3765
- # * `:snapshot_id` - (String) The ID of the snapshot from which the
3766
- # volume will be created.
3767
- # * `:volume_size` - (Integer) The size of the volume, in
3768
- # gigabytes.
3769
- # * `:delete_on_termination` - (Boolean) Specifies whether the
3770
- # Amazon EBS volume is deleted on instance termination.
3771
- # * `:volume_type` - (String) Valid values include:
3772
- # * `standard`
3773
- # * `io1`
3774
- # * `:iops` - (Integer)
3775
- # * `:no_device` - (String) Specifies the device name to suppress
3776
- # during instance launch.
3777
- # * `:monitoring` - (Hash) Enables monitoring for the instance.
3778
- # * `:enabled` - *required* - (Boolean)
3779
- # * `:subnet_id` - (String) Specifies the subnet ID within which to
3780
- # launch the instance(s) for Amazon Virtual Private Cloud.
3781
- # * `:disable_api_termination` - (Boolean) Specifies whether the
3782
- # instance can be terminated using the APIs. You must modify this
3783
- # attribute before you can terminate any "locked" instances from the
3784
- # APIs.
3785
- # * `:instance_initiated_shutdown_behavior` - (String) Specifies
3786
- # whether the instance's Amazon EBS volumes are stopped or terminated
3787
- # when the instance is shut down.
3788
- # * `:license` - (Hash) Specifies active licenses in use and attached
3789
- # to an Amazon EC2 instance.
3790
- # * `:pool` - (String) The license pool from which to take a license
3791
- # when starting Amazon EC2 instances in the associated RunInstances
3792
- # request.
3793
- # * `:private_ip_address` - (String) If you're using Amazon Virtual
3794
- # Private Cloud, you can optionally use this parameter to assign the
3795
- # instance a specific available IP address from the subnet.
3796
- # * `:client_token` - (String) Unique, case-sensitive identifier you
3797
- # provide to ensure idempotency of the request. For more information,
3798
- # go to How to Ensure Idempotency in the Amazon Elastic Compute Cloud
3799
- # User Guide.
3800
- # * `:additional_info` - (String)
3801
- # * `:network_interfaces` - (Array<Hash>)
3802
- # * `:network_interface_id` - (String)
3803
- # * `:device_index` - (Integer)
3804
- # * `:subnet_id` - (String)
3805
- # * `:description` - (String)
3806
- # * `:private_ip_address` - (String)
3807
- # * `:groups` - (Array<String>)
3808
- # * `:delete_on_termination` - (Boolean)
3809
- # * `:private_ip_addresses` - (Array<Hash>)
3810
- # * `:private_ip_address` - *required* - (String)
3811
- # * `:primary` - (Boolean)
3812
- # * `:secondary_private_ip_address_count` - (Integer)
3813
- # * `:iam_instance_profile` - (Hash)
3814
- # * `:arn` - (String)
3815
- # * `:name` - (String)
3816
- # * `:ebs_optimized` - (Boolean)
3817
- # @return [Core::Response]
3818
- # The #data method of the response object returns
3819
- # a hash with the following structure:
3820
- #
3821
- # * `:reservation_id` - (String)
3822
- # * `:owner_id` - (String)
3823
- # * `:requester_id` - (String)
3824
- # * `:group_set` - (Array<Hash>)
3825
- # * `:group_name` - (String)
3826
- # * `:group_id` - (String)
3827
- # * `:instances_set` - (Array<Hash>)
3828
- # * `:instance_id` - (String)
3829
- # * `:image_id` - (String)
3830
- # * `:instance_state` - (Hash)
3831
- # * `:code` - (Integer)
3832
- # * `:name` - (String)
3833
- # * `:private_dns_name` - (String)
3834
- # * `:dns_name` - (String)
3835
- # * `:reason` - (String)
3836
- # * `:key_name` - (String)
3837
- # * `:ami_launch_index` - (Integer)
3838
- # * `:product_codes` - (Array<Hash>)
3839
- # * `:product_code` - (String)
3840
- # * `:type` - (String)
3841
- # * `:instance_type` - (String)
3842
- # * `:launch_time` - (Time)
3843
- # * `:placement` - (Hash)
3844
- # * `:availability_zone` - (String)
3845
- # * `:group_name` - (String)
3846
- # * `:tenancy` - (String)
3847
- # * `:kernel_id` - (String)
3848
- # * `:ramdisk_id` - (String)
3849
- # * `:platform` - (String)
3850
- # * `:monitoring` - (Hash)
3851
- # * `:state` - (String)
3852
- # * `:subnet_id` - (String)
3853
- # * `:vpc_id` - (String)
3854
- # * `:private_ip_address` - (String)
3855
- # * `:ip_address` - (String)
3856
- # * `:state_reason` - (Hash)
3857
- # * `:code` - (String)
3858
- # * `:message` - (String)
3859
- # * `:architecture` - (String)
3860
- # * `:root_device_type` - (String)
3861
- # * `:root_device_name` - (String)
3862
- # * `:block_device_mapping` - (Array<Hash>)
3863
- # * `:device_name` - (String)
3864
- # * `:ebs` - (Hash)
3865
- # * `:volume_id` - (String)
3866
- # * `:status` - (String)
3867
- # * `:attach_time` - (Time)
3868
- # * `:delete_on_termination` - (Boolean)
3869
- # * `:virtualization_type` - (String)
3870
- # * `:instance_lifecycle` - (String)
3871
- # * `:spot_instance_request_id` - (String)
3872
- # * `:license` - (Hash)
3873
- # * `:pool` - (String)
3874
- # * `:client_token` - (String)
3875
- # * `:tag_set` - (Array<Hash>)
3876
- # * `:key` - (String)
3877
- # * `:value` - (String)
3878
- # * `:group_set` - (Array<Hash>)
3879
- # * `:group_name` - (String)
3880
- # * `:group_id` - (String)
3881
- # * `:source_dest_check` - (Boolean)
3882
- # * `:hypervisor` - (String)
3883
- # * `:network_interface_set` - (Array<Hash>)
3884
- # * `:network_interface_id` - (String)
3885
- # * `:subnet_id` - (String)
3886
- # * `:vpc_id` - (String)
3887
- # * `:description` - (String)
3888
- # * `:owner_id` - (String)
3889
- # * `:status` - (String)
3890
- # * `:private_ip_address` - (String)
3891
- # * `:private_dns_name` - (String)
3892
- # * `:source_dest_check` - (Boolean)
3893
- # * `:group_set` - (Array<Hash>)
3894
- # * `:group_name` - (String)
3895
- # * `:group_id` - (String)
3896
- # * `:attachment` - (Hash)
3897
- # * `:attachment_id` - (String)
3898
- # * `:device_index` - (Integer)
3899
- # * `:status` - (String)
3900
- # * `:attach_time` - (Time)
3901
- # * `:delete_on_termination` - (Boolean)
3902
- # * `:association` - (Hash)
3903
- # * `:public_ip` - (String)
3904
- # * `:public_dns_name` - (String)
3905
- # * `:ip_owner_id` - (String)
3906
- # * `:private_ip_addresses_set` - (Array<Hash>)
3907
- # * `:private_ip_address` - (String)
3908
- # * `:private_dns_name` - (String)
3909
- # * `:primary` - (Boolean)
3910
- # * `:association` - (Hash)
3911
- # * `:public_ip` - (String)
3912
- # * `:public_dns_name` - (String)
3913
- # * `:ip_owner_id` - (String)
3914
- # * `:iam_instance_profile` - (Hash)
3915
- # * `:arn` - (String)
3916
- # * `:id` - (String)
3917
- # * `:ebs_optimized` - (Boolean)
3918
-
3919
- # @!method start_instances(options = {})
3920
- # Calls the StartInstances API operation.
3921
- # @param [Hash] options
3922
- #
3923
- # * `:instance_ids` - *required* - (Array<String>) The list of Amazon
3924
- # EC2 instances to start.
3925
- # * `:additional_info` - (String)
3926
- # @return [Core::Response]
3927
- # The #data method of the response object returns
3928
- # a hash with the following structure:
3929
- #
3930
- # * `:instances_set` - (Array<Hash>)
3931
- # * `:instance_id` - (String)
3932
- # * `:current_state` - (Hash)
3933
- # * `:code` - (Integer)
3934
- # * `:name` - (String)
3935
- # * `:previous_state` - (Hash)
3936
- # * `:code` - (Integer)
3937
- # * `:name` - (String)
3938
-
3939
- # @!method stop_instances(options = {})
3940
- # Calls the StopInstances API operation.
3941
- # @param [Hash] options
3942
- #
3943
- # * `:instance_ids` - *required* - (Array<String>) The list of Amazon
3944
- # EC2 instances to stop.
3945
- # * `:force` - (Boolean) Forces the instance to stop. The instance will
3946
- # not have an opportunity to flush file system caches nor file system
3947
- # meta data. If you use this option, you must perform file system
3948
- # check and repair procedures. This option is not recommended for
3949
- # Windows instances.
3950
- # @return [Core::Response]
3951
- # The #data method of the response object returns
3952
- # a hash with the following structure:
3953
- #
3954
- # * `:instances_set` - (Array<Hash>)
3955
- # * `:instance_id` - (String)
3956
- # * `:current_state` - (Hash)
3957
- # * `:code` - (Integer)
3958
- # * `:name` - (String)
3959
- # * `:previous_state` - (Hash)
3960
- # * `:code` - (Integer)
3961
- # * `:name` - (String)
3962
-
3963
- # @!method terminate_instances(options = {})
3964
- # Calls the TerminateInstances API operation.
3965
- # @param [Hash] options
3966
- #
3967
- # * `:instance_ids` - *required* - (Array<String>) The list of
3968
- # instances to terminate.
3969
- # @return [Core::Response]
3970
- # The #data method of the response object returns
3971
- # a hash with the following structure:
3972
- #
3973
- # * `:instances_set` - (Array<Hash>)
3974
- # * `:instance_id` - (String)
3975
- # * `:current_state` - (Hash)
3976
- # * `:code` - (Integer)
3977
- # * `:name` - (String)
3978
- # * `:previous_state` - (Hash)
3979
- # * `:code` - (Integer)
3980
- # * `:name` - (String)
3981
-
3982
- # @!method unassign_private_ip_addresses(options = {})
3983
- # Calls the UnassignPrivateIpAddresses API operation.
3984
- # @param [Hash] options
3985
- #
3986
- # * `:network_interface_id` - *required* - (String)
3987
- # * `:private_ip_addresses` - *required* - (Array<String>)
3988
- # @return [Core::Response]
3989
-
3990
- # @!method unmonitor_instances(options = {})
3991
- # Calls the UnmonitorInstances API operation.
3992
- # @param [Hash] options
3993
- #
3994
- # * `:instance_ids` - *required* - (Array<String>) The list of Amazon
3995
- # EC2 instances on which to disable monitoring.
3996
- # @return [Core::Response]
3997
- # The #data method of the response object returns
3998
- # a hash with the following structure:
3999
- #
4000
- # * `:instances_set` - (Array<Hash>)
4001
- # * `:instance_id` - (String)
4002
- # * `:monitoring` - (Hash)
4003
- # * `:state` - (String)
4004
-
4005
- # end client methods #
4006
-
4007
65
  define_client_methods('2013-02-01')
4008
66
 
4009
67
  end