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