aws-sdk 1.4.1 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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/elb/errors.rb
CHANGED
|
@@ -13,15 +13,11 @@
|
|
|
13
13
|
|
|
14
14
|
module AWS
|
|
15
15
|
class ELB
|
|
16
|
-
|
|
17
|
-
# @private
|
|
18
16
|
module Errors
|
|
19
17
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
include Core::LazyErrorClasses
|
|
18
|
+
extend Core::LazyErrorClasses
|
|
23
19
|
|
|
24
|
-
def self.error_class
|
|
20
|
+
def self.error_class code
|
|
25
21
|
super(code.sub(/^ElasticLoadBalancing\./, ''))
|
|
26
22
|
end
|
|
27
23
|
|
|
@@ -99,8 +99,8 @@ module AWS
|
|
|
99
99
|
# load_balancer.instances['i-123456'].elb_health
|
|
100
100
|
# # => { :state => ..., :reason_code => ..., :description => ... }
|
|
101
101
|
#
|
|
102
|
-
# @param [String,EC2::Instance]
|
|
103
|
-
# health information for.
|
|
102
|
+
# @param [String,EC2::Instance] instances A list of instances to
|
|
103
|
+
# receive health information for.
|
|
104
104
|
#
|
|
105
105
|
# @return [Array<Hash>] Returns an array of hashes. Each hash represents
|
|
106
106
|
# the health of a single instance. Each hash includes the following
|
data/lib/aws/elb/request.rb
CHANGED
data/lib/aws/errors.rb
CHANGED
|
@@ -12,34 +12,58 @@
|
|
|
12
12
|
# language governing permissions and limitations under the License.
|
|
13
13
|
|
|
14
14
|
module AWS
|
|
15
|
+
|
|
16
|
+
# = Errors
|
|
17
|
+
#
|
|
18
|
+
# There are two basic types of errors:
|
|
19
|
+
#
|
|
20
|
+
# * {ClientError}
|
|
21
|
+
# * {ServerError}
|
|
22
|
+
#
|
|
23
|
+
# == Client Errors
|
|
24
|
+
#
|
|
25
|
+
# Errors in the three and four hundreds are client errors ({ClientError}).
|
|
26
|
+
# A client error should not be resent without changes. The body of the
|
|
27
|
+
# http response (the error #message) should give more information about
|
|
28
|
+
# the nature of the problem.
|
|
29
|
+
#
|
|
30
|
+
# == Server Errors
|
|
31
|
+
#
|
|
32
|
+
# A 500 level error typically indicates the service is having an issue.
|
|
33
|
+
#
|
|
34
|
+
# Requests that generate service errors are automatically retried with
|
|
35
|
+
# an exponential backoff. If the service still fails to respond with
|
|
36
|
+
# a 200 after 3 retries the error is raised.
|
|
37
|
+
#
|
|
15
38
|
module Errors
|
|
16
39
|
|
|
17
|
-
# Base class for
|
|
18
|
-
#
|
|
19
|
-
# * {ClientError}
|
|
20
|
-
# * {ServerError}
|
|
21
|
-
#
|
|
22
|
-
# When interacting with Amazon AWS services, you will sometimes
|
|
23
|
-
# receive a non-200 level response. These http responses are treated
|
|
24
|
-
# as errors.
|
|
25
|
-
#
|
|
26
|
-
# == Client Errors
|
|
27
|
-
#
|
|
28
|
-
# Errors in the three and four hundreds are client errors ({ClientError}).
|
|
29
|
-
# A client error should not be resent without changes. The body of the
|
|
30
|
-
# http response (the error #message) should give more information about
|
|
31
|
-
# the nature of the problem.
|
|
32
|
-
#
|
|
33
|
-
# == Server Errors
|
|
34
|
-
#
|
|
35
|
-
# A 500 level error typically indicates the service is having an issue.
|
|
36
|
-
#
|
|
37
|
-
# Requests that generate service errors are automatically retried with
|
|
38
|
-
# an exponential backoff. If the service still fails to respond with
|
|
39
|
-
# a 200 after 3 retries the error is raised.
|
|
40
|
-
#
|
|
40
|
+
# Base class for all errors returned by the service.
|
|
41
41
|
class Base < StandardError
|
|
42
42
|
|
|
43
|
+
# @overload new(error_message)
|
|
44
|
+
# @param [String] error_message The body of the error message
|
|
45
|
+
#
|
|
46
|
+
# @overload new(http_request, http_response, code = nil, message = nil)
|
|
47
|
+
# @param [Http::Request] http_request
|
|
48
|
+
# @param [Http::Response] http_response
|
|
49
|
+
# @param [String] code (nil)
|
|
50
|
+
# @param [String] message (nil)
|
|
51
|
+
#
|
|
52
|
+
def initialize req = nil, resp = nil, code = nil, message = nil
|
|
53
|
+
if req.is_a?(String) or req.nil?
|
|
54
|
+
super(req)
|
|
55
|
+
else
|
|
56
|
+
@http_request = req
|
|
57
|
+
@http_response = resp
|
|
58
|
+
@code = code
|
|
59
|
+
include_error_type
|
|
60
|
+
super(message || http_response.body)
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# @return [String] The response code given by the service.
|
|
65
|
+
attr_reader :code
|
|
66
|
+
|
|
43
67
|
# @return [Http::Request] The low level http request that caused the
|
|
44
68
|
# error to be raised.
|
|
45
69
|
attr_reader :http_request
|
|
@@ -48,15 +72,23 @@ module AWS
|
|
|
48
72
|
# that wrapped the service error.
|
|
49
73
|
attr_reader :http_response
|
|
50
74
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
75
|
+
protected
|
|
76
|
+
|
|
77
|
+
# Extends the error object with {ServerError} or {ClientError}.
|
|
78
|
+
# This indicates if the request should be retried (server errors)
|
|
79
|
+
# or not (client errors).
|
|
80
|
+
def include_error_type
|
|
81
|
+
if http_response.status >= 500
|
|
82
|
+
extend ServerError
|
|
83
|
+
else
|
|
84
|
+
extend ClientError
|
|
85
|
+
end
|
|
56
86
|
end
|
|
57
87
|
|
|
58
88
|
end
|
|
59
89
|
|
|
90
|
+
# Provides the ability to instantiate instances of {ServerError} and
|
|
91
|
+
# {ClientError}.
|
|
60
92
|
# @private
|
|
61
93
|
module ExceptionMixinClassMethods
|
|
62
94
|
def new(*args)
|
|
@@ -86,50 +118,5 @@ module AWS
|
|
|
86
118
|
extend ExceptionMixinClassMethods
|
|
87
119
|
end
|
|
88
120
|
|
|
89
|
-
# @private
|
|
90
|
-
module ModeledError
|
|
91
|
-
|
|
92
|
-
# @return [String] The error message given by the AWS service.
|
|
93
|
-
attr_accessor :message
|
|
94
|
-
|
|
95
|
-
# @return [Integer] The HTTP status code returned by the AWS service.
|
|
96
|
-
attr_reader :code
|
|
97
|
-
|
|
98
|
-
def initialize(req = nil, resp = nil)
|
|
99
|
-
if req.kind_of?(String)
|
|
100
|
-
# makes it easier to test handling of modeled exceptions
|
|
101
|
-
super(nil, nil, req)
|
|
102
|
-
@message = req
|
|
103
|
-
elsif req and resp
|
|
104
|
-
parse_body(resp.body)
|
|
105
|
-
super(req, resp, self.message)
|
|
106
|
-
include_error_type
|
|
107
|
-
else
|
|
108
|
-
super()
|
|
109
|
-
end
|
|
110
|
-
end
|
|
111
|
-
|
|
112
|
-
def include_error_type
|
|
113
|
-
if http_response.status >= 500
|
|
114
|
-
extend ServerError
|
|
115
|
-
else
|
|
116
|
-
extend ClientError
|
|
117
|
-
end
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
def parse_body(body)
|
|
121
|
-
error_grammar.parse(body, :context => self)
|
|
122
|
-
end
|
|
123
|
-
|
|
124
|
-
def extract_message(body)
|
|
125
|
-
error_grammar.parse(body).message
|
|
126
|
-
end
|
|
127
|
-
|
|
128
|
-
def error_grammar
|
|
129
|
-
self.class::BASE_ERROR_GRAMMAR
|
|
130
|
-
end
|
|
131
|
-
|
|
132
|
-
end
|
|
133
|
-
|
|
134
121
|
end
|
|
135
122
|
end
|
data/lib/aws/iam.rb
CHANGED
|
@@ -334,9 +334,8 @@ module AWS
|
|
|
334
334
|
#
|
|
335
335
|
# @return [Hash]
|
|
336
336
|
def account_summary
|
|
337
|
-
client.get_account_summary.summary_map.inject({}) do |h,
|
|
338
|
-
h
|
|
339
|
-
h
|
|
337
|
+
client.get_account_summary.data[:summary_map].inject({}) do |h,(k,v)|
|
|
338
|
+
h.merge(Core::Inflection.ruby_name(k).to_sym => v)
|
|
340
339
|
end
|
|
341
340
|
end
|
|
342
341
|
|
data/lib/aws/iam/client.rb
CHANGED
|
@@ -14,18 +14,12 @@
|
|
|
14
14
|
module AWS
|
|
15
15
|
class IAM
|
|
16
16
|
|
|
17
|
-
#
|
|
17
|
+
# Client class for AWS Identity and Access Management (IAM).
|
|
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 = '2010-05-08'
|
|
27
|
-
|
|
28
|
-
|
|
21
|
+
|
|
22
|
+
extend Core::Client::QueryXML
|
|
29
23
|
|
|
30
24
|
# @private
|
|
31
25
|
CACHEABLE_REQUESTS = Set[
|
|
@@ -38,7 +32,1181 @@ module AWS
|
|
|
38
32
|
:get_group_policy
|
|
39
33
|
]
|
|
40
34
|
|
|
41
|
-
|
|
35
|
+
## client methods ##
|
|
36
|
+
|
|
37
|
+
# Calls the AddUserToGroup API operation.
|
|
38
|
+
# @method add_user_to_group(options = {})
|
|
39
|
+
#
|
|
40
|
+
# === Options:
|
|
41
|
+
#
|
|
42
|
+
# * +:group_name+ - *required* - (String) Name of the group to update.
|
|
43
|
+
# * +:user_name+ - *required* - (String) Name of the user to add.
|
|
44
|
+
#
|
|
45
|
+
# === Response Structure:
|
|
46
|
+
#
|
|
47
|
+
# This method returns no response data.
|
|
48
|
+
#
|
|
49
|
+
# @return [Core::Response]
|
|
50
|
+
#
|
|
51
|
+
define_client_method :add_user_to_group, 'AddUserToGroup'
|
|
52
|
+
|
|
53
|
+
# Calls the ChangePassword API operation.
|
|
54
|
+
# @method change_password(options = {})
|
|
55
|
+
#
|
|
56
|
+
# === Options:
|
|
57
|
+
#
|
|
58
|
+
# * +:old_password+ - *required* - (String)
|
|
59
|
+
# * +:new_password+ - *required* - (String)
|
|
60
|
+
#
|
|
61
|
+
# === Response Structure:
|
|
62
|
+
#
|
|
63
|
+
# This method returns no response data.
|
|
64
|
+
#
|
|
65
|
+
# @return [Core::Response]
|
|
66
|
+
#
|
|
67
|
+
define_client_method :change_password, 'ChangePassword'
|
|
68
|
+
|
|
69
|
+
# Calls the CreateAccessKey API operation.
|
|
70
|
+
# @method create_access_key(options = {})
|
|
71
|
+
#
|
|
72
|
+
# === Options:
|
|
73
|
+
#
|
|
74
|
+
# * +:user_name+ - (String) The user name that the new key will belong
|
|
75
|
+
# to.
|
|
76
|
+
#
|
|
77
|
+
# === Response Structure:
|
|
78
|
+
#
|
|
79
|
+
# * +:access_key+ - (Hash)
|
|
80
|
+
# * +:user_name+ - (String)
|
|
81
|
+
# * +:access_key_id+ - (String)
|
|
82
|
+
# * +:status+ - (String)
|
|
83
|
+
# * +:secret_access_key+ - (String)
|
|
84
|
+
# * +:create_date+ - (Time)
|
|
85
|
+
#
|
|
86
|
+
# @return [Core::Response]
|
|
87
|
+
#
|
|
88
|
+
define_client_method :create_access_key, 'CreateAccessKey'
|
|
89
|
+
|
|
90
|
+
# Calls the CreateAccountAlias API operation.
|
|
91
|
+
# @method create_account_alias(options = {})
|
|
92
|
+
#
|
|
93
|
+
# === Options:
|
|
94
|
+
#
|
|
95
|
+
# * +:account_alias+ - *required* - (String) Name of the account alias to
|
|
96
|
+
# create.
|
|
97
|
+
#
|
|
98
|
+
# === Response Structure:
|
|
99
|
+
#
|
|
100
|
+
# This method returns no response data.
|
|
101
|
+
#
|
|
102
|
+
# @return [Core::Response]
|
|
103
|
+
#
|
|
104
|
+
define_client_method :create_account_alias, 'CreateAccountAlias'
|
|
105
|
+
|
|
106
|
+
# Calls the CreateGroup API operation.
|
|
107
|
+
# @method create_group(options = {})
|
|
108
|
+
#
|
|
109
|
+
# === Options:
|
|
110
|
+
#
|
|
111
|
+
# * +:path+ - (String) The path to the group. For more information about
|
|
112
|
+
# paths, see Identifiers for IAM Entities in Using AWS Identity and
|
|
113
|
+
# Access Management. This parameter is optional. If it is not included,
|
|
114
|
+
# it defaults to a slash (/).
|
|
115
|
+
# * +:group_name+ - *required* - (String) Name of the group to create. Do
|
|
116
|
+
# not include the path in this value.
|
|
117
|
+
#
|
|
118
|
+
# === Response Structure:
|
|
119
|
+
#
|
|
120
|
+
# * +:group+ - (Hash)
|
|
121
|
+
# * +:path+ - (String)
|
|
122
|
+
# * +:group_name+ - (String)
|
|
123
|
+
# * +:group_id+ - (String)
|
|
124
|
+
# * +:arn+ - (String)
|
|
125
|
+
# * +:create_date+ - (Time)
|
|
126
|
+
#
|
|
127
|
+
# @return [Core::Response]
|
|
128
|
+
#
|
|
129
|
+
define_client_method :create_group, 'CreateGroup'
|
|
130
|
+
|
|
131
|
+
# Calls the CreateLoginProfile API operation.
|
|
132
|
+
# @method create_login_profile(options = {})
|
|
133
|
+
#
|
|
134
|
+
# === Options:
|
|
135
|
+
#
|
|
136
|
+
# * +:user_name+ - *required* - (String) Name of the user to create a
|
|
137
|
+
# password for.
|
|
138
|
+
# * +:password+ - *required* - (String) The new password for the user
|
|
139
|
+
# name.
|
|
140
|
+
#
|
|
141
|
+
# === Response Structure:
|
|
142
|
+
#
|
|
143
|
+
# * +:login_profile+ - (Hash)
|
|
144
|
+
# * +:user_name+ - (String)
|
|
145
|
+
# * +:create_date+ - (Time)
|
|
146
|
+
#
|
|
147
|
+
# @return [Core::Response]
|
|
148
|
+
#
|
|
149
|
+
define_client_method :create_login_profile, 'CreateLoginProfile'
|
|
150
|
+
|
|
151
|
+
# Calls the CreateUser API operation.
|
|
152
|
+
# @method create_user(options = {})
|
|
153
|
+
#
|
|
154
|
+
# === Options:
|
|
155
|
+
#
|
|
156
|
+
# * +:path+ - (String) The path for the user name. For more information
|
|
157
|
+
# about paths, see Identifiers for IAM Entities in Using AWS Identity
|
|
158
|
+
# and Access Management. This parameter is optional. If it is not
|
|
159
|
+
# included, it defaults to a slash (/).
|
|
160
|
+
# * +:user_name+ - *required* - (String) Name of the user to create.
|
|
161
|
+
#
|
|
162
|
+
# === Response Structure:
|
|
163
|
+
#
|
|
164
|
+
# * +:user+ - (Hash)
|
|
165
|
+
# * +:path+ - (String)
|
|
166
|
+
# * +:user_name+ - (String)
|
|
167
|
+
# * +:user_id+ - (String)
|
|
168
|
+
# * +:arn+ - (String)
|
|
169
|
+
# * +:create_date+ - (Time)
|
|
170
|
+
#
|
|
171
|
+
# @return [Core::Response]
|
|
172
|
+
#
|
|
173
|
+
define_client_method :create_user, 'CreateUser'
|
|
174
|
+
|
|
175
|
+
# Calls the CreateVirtualMFADevice API operation.
|
|
176
|
+
# @method create_virtual_mfa_device(options = {})
|
|
177
|
+
#
|
|
178
|
+
# === Options:
|
|
179
|
+
#
|
|
180
|
+
# * +:path+ - (String) The path for the virtual MFA device. For more
|
|
181
|
+
# information about paths, see Identifiers for IAM Entities in Using
|
|
182
|
+
# AWS Identity and Access Management. This parameter is optional. If it
|
|
183
|
+
# is not included, it defaults to a slash (/).
|
|
184
|
+
# * +:virtual_mfa_device_name+ - *required* - (String) The name of the
|
|
185
|
+
# virtual MFA device. Use with path to uniquely identify a virtual MFA
|
|
186
|
+
# device.
|
|
187
|
+
#
|
|
188
|
+
# === Response Structure:
|
|
189
|
+
#
|
|
190
|
+
# * +:virtual_mfa_device+ - (Hash)
|
|
191
|
+
# * +:serial_number+ - (String)
|
|
192
|
+
# * +:base_32_string_seed+ - (String)
|
|
193
|
+
# * +:qr_code_png+ - (String)
|
|
194
|
+
# * +:user+ - (Hash)
|
|
195
|
+
# * +:path+ - (String)
|
|
196
|
+
# * +:user_name+ - (String)
|
|
197
|
+
# * +:user_id+ - (String)
|
|
198
|
+
# * +:arn+ - (String)
|
|
199
|
+
# * +:create_date+ - (Time)
|
|
200
|
+
# * +:enable_date+ - (Time)
|
|
201
|
+
#
|
|
202
|
+
# @return [Core::Response]
|
|
203
|
+
#
|
|
204
|
+
define_client_method :create_virtual_mfa_device, 'CreateVirtualMFADevice'
|
|
205
|
+
|
|
206
|
+
# Calls the DeactivateMFADevice API operation.
|
|
207
|
+
# @method deactivate_mfa_device(options = {})
|
|
208
|
+
#
|
|
209
|
+
# === Options:
|
|
210
|
+
#
|
|
211
|
+
# * +:user_name+ - *required* - (String) Name of the user whose MFA
|
|
212
|
+
# device you want to deactivate.
|
|
213
|
+
# * +:serial_number+ - *required* - (String) The serial number that
|
|
214
|
+
# uniquely identifies the MFA device. For virtual MFA devices, the
|
|
215
|
+
# serial number is the device ARN.
|
|
216
|
+
#
|
|
217
|
+
# === Response Structure:
|
|
218
|
+
#
|
|
219
|
+
# This method returns no response data.
|
|
220
|
+
#
|
|
221
|
+
# @return [Core::Response]
|
|
222
|
+
#
|
|
223
|
+
define_client_method :deactivate_mfa_device, 'DeactivateMFADevice'
|
|
224
|
+
|
|
225
|
+
# Calls the DeleteAccessKey API operation.
|
|
226
|
+
# @method delete_access_key(options = {})
|
|
227
|
+
#
|
|
228
|
+
# === Options:
|
|
229
|
+
#
|
|
230
|
+
# * +:user_name+ - (String) Name of the user whose key you want to
|
|
231
|
+
# delete.
|
|
232
|
+
# * +:access_key_id+ - *required* - (String) The Access Key ID for the
|
|
233
|
+
# Access Key ID and Secret Access Key you want to delete.
|
|
234
|
+
#
|
|
235
|
+
# === Response Structure:
|
|
236
|
+
#
|
|
237
|
+
# This method returns no response data.
|
|
238
|
+
#
|
|
239
|
+
# @return [Core::Response]
|
|
240
|
+
#
|
|
241
|
+
define_client_method :delete_access_key, 'DeleteAccessKey'
|
|
242
|
+
|
|
243
|
+
# Calls the DeleteAccountAlias API operation.
|
|
244
|
+
# @method delete_account_alias(options = {})
|
|
245
|
+
#
|
|
246
|
+
# === Options:
|
|
247
|
+
#
|
|
248
|
+
# * +:account_alias+ - *required* - (String) Name of the account alias to
|
|
249
|
+
# delete.
|
|
250
|
+
#
|
|
251
|
+
# === Response Structure:
|
|
252
|
+
#
|
|
253
|
+
# This method returns no response data.
|
|
254
|
+
#
|
|
255
|
+
# @return [Core::Response]
|
|
256
|
+
#
|
|
257
|
+
define_client_method :delete_account_alias, 'DeleteAccountAlias'
|
|
258
|
+
|
|
259
|
+
# Calls the DeleteAccountPasswordPolicy API operation.
|
|
260
|
+
# @method delete_account_password_policy(options = {})
|
|
261
|
+
#
|
|
262
|
+
# === Options:
|
|
263
|
+
#
|
|
264
|
+
# This method accepts no options.
|
|
265
|
+
#
|
|
266
|
+
# === Response Structure:
|
|
267
|
+
#
|
|
268
|
+
# This method returns no response data.
|
|
269
|
+
#
|
|
270
|
+
# @return [Core::Response]
|
|
271
|
+
#
|
|
272
|
+
define_client_method :delete_account_password_policy, 'DeleteAccountPasswordPolicy'
|
|
273
|
+
|
|
274
|
+
# Calls the DeleteGroup API operation.
|
|
275
|
+
# @method delete_group(options = {})
|
|
276
|
+
#
|
|
277
|
+
# === Options:
|
|
278
|
+
#
|
|
279
|
+
# * +:group_name+ - *required* - (String) Name of the group to delete.
|
|
280
|
+
#
|
|
281
|
+
# === Response Structure:
|
|
282
|
+
#
|
|
283
|
+
# This method returns no response data.
|
|
284
|
+
#
|
|
285
|
+
# @return [Core::Response]
|
|
286
|
+
#
|
|
287
|
+
define_client_method :delete_group, 'DeleteGroup'
|
|
288
|
+
|
|
289
|
+
# Calls the DeleteGroupPolicy API operation.
|
|
290
|
+
# @method delete_group_policy(options = {})
|
|
291
|
+
#
|
|
292
|
+
# === Options:
|
|
293
|
+
#
|
|
294
|
+
# * +:group_name+ - *required* - (String) Name of the group the policy is
|
|
295
|
+
# associated with.
|
|
296
|
+
# * +:policy_name+ - *required* - (String) Name of the policy document to
|
|
297
|
+
# delete.
|
|
298
|
+
#
|
|
299
|
+
# === Response Structure:
|
|
300
|
+
#
|
|
301
|
+
# This method returns no response data.
|
|
302
|
+
#
|
|
303
|
+
# @return [Core::Response]
|
|
304
|
+
#
|
|
305
|
+
define_client_method :delete_group_policy, 'DeleteGroupPolicy'
|
|
306
|
+
|
|
307
|
+
# Calls the DeleteLoginProfile API operation.
|
|
308
|
+
# @method delete_login_profile(options = {})
|
|
309
|
+
#
|
|
310
|
+
# === Options:
|
|
311
|
+
#
|
|
312
|
+
# * +:user_name+ - *required* - (String) Name of the user whose password
|
|
313
|
+
# you want to delete.
|
|
314
|
+
#
|
|
315
|
+
# === Response Structure:
|
|
316
|
+
#
|
|
317
|
+
# This method returns no response data.
|
|
318
|
+
#
|
|
319
|
+
# @return [Core::Response]
|
|
320
|
+
#
|
|
321
|
+
define_client_method :delete_login_profile, 'DeleteLoginProfile'
|
|
322
|
+
|
|
323
|
+
# Calls the DeleteServerCertificate API operation.
|
|
324
|
+
# @method delete_server_certificate(options = {})
|
|
325
|
+
#
|
|
326
|
+
# === Options:
|
|
327
|
+
#
|
|
328
|
+
# * +:server_certificate_name+ - *required* - (String) The name of the
|
|
329
|
+
# server certificate you want to delete.
|
|
330
|
+
#
|
|
331
|
+
# === Response Structure:
|
|
332
|
+
#
|
|
333
|
+
# This method returns no response data.
|
|
334
|
+
#
|
|
335
|
+
# @return [Core::Response]
|
|
336
|
+
#
|
|
337
|
+
define_client_method :delete_server_certificate, 'DeleteServerCertificate'
|
|
338
|
+
|
|
339
|
+
# Calls the DeleteSigningCertificate API operation.
|
|
340
|
+
# @method delete_signing_certificate(options = {})
|
|
341
|
+
#
|
|
342
|
+
# === Options:
|
|
343
|
+
#
|
|
344
|
+
# * +:user_name+ - (String) Name of the user the signing certificate
|
|
345
|
+
# belongs to.
|
|
346
|
+
# * +:certificate_id+ - *required* - (String) ID of the signing
|
|
347
|
+
# certificate to delete.
|
|
348
|
+
#
|
|
349
|
+
# === Response Structure:
|
|
350
|
+
#
|
|
351
|
+
# This method returns no response data.
|
|
352
|
+
#
|
|
353
|
+
# @return [Core::Response]
|
|
354
|
+
#
|
|
355
|
+
define_client_method :delete_signing_certificate, 'DeleteSigningCertificate'
|
|
356
|
+
|
|
357
|
+
# Calls the DeleteUser API operation.
|
|
358
|
+
# @method delete_user(options = {})
|
|
359
|
+
#
|
|
360
|
+
# === Options:
|
|
361
|
+
#
|
|
362
|
+
# * +:user_name+ - *required* - (String) Name of the user to delete.
|
|
363
|
+
#
|
|
364
|
+
# === Response Structure:
|
|
365
|
+
#
|
|
366
|
+
# This method returns no response data.
|
|
367
|
+
#
|
|
368
|
+
# @return [Core::Response]
|
|
369
|
+
#
|
|
370
|
+
define_client_method :delete_user, 'DeleteUser'
|
|
371
|
+
|
|
372
|
+
# Calls the DeleteUserPolicy API operation.
|
|
373
|
+
# @method delete_user_policy(options = {})
|
|
374
|
+
#
|
|
375
|
+
# === Options:
|
|
376
|
+
#
|
|
377
|
+
# * +:user_name+ - *required* - (String) Name of the user the policy is
|
|
378
|
+
# associated with.
|
|
379
|
+
# * +:policy_name+ - *required* - (String) Name of the policy document to
|
|
380
|
+
# delete.
|
|
381
|
+
#
|
|
382
|
+
# === Response Structure:
|
|
383
|
+
#
|
|
384
|
+
# This method returns no response data.
|
|
385
|
+
#
|
|
386
|
+
# @return [Core::Response]
|
|
387
|
+
#
|
|
388
|
+
define_client_method :delete_user_policy, 'DeleteUserPolicy'
|
|
389
|
+
|
|
390
|
+
# Calls the DeleteVirtualMFADevice API operation.
|
|
391
|
+
# @method delete_virtual_mfa_device(options = {})
|
|
392
|
+
#
|
|
393
|
+
# === Options:
|
|
394
|
+
#
|
|
395
|
+
# * +:serial_number+ - *required* - (String) The serial number that
|
|
396
|
+
# uniquely identifies the MFA device. For virtual MFA devices, the
|
|
397
|
+
# serial number is the same as the ARN.
|
|
398
|
+
#
|
|
399
|
+
# === Response Structure:
|
|
400
|
+
#
|
|
401
|
+
# This method returns no response data.
|
|
402
|
+
#
|
|
403
|
+
# @return [Core::Response]
|
|
404
|
+
#
|
|
405
|
+
define_client_method :delete_virtual_mfa_device, 'DeleteVirtualMFADevice'
|
|
406
|
+
|
|
407
|
+
# Calls the EnableMFADevice API operation.
|
|
408
|
+
# @method enable_mfa_device(options = {})
|
|
409
|
+
#
|
|
410
|
+
# === Options:
|
|
411
|
+
#
|
|
412
|
+
# * +:user_name+ - *required* - (String) Name of the user for whom you
|
|
413
|
+
# want to enable the MFA device.
|
|
414
|
+
# * +:serial_number+ - *required* - (String) The serial number that
|
|
415
|
+
# uniquely identifies the MFA device. For virtual MFA devices, the
|
|
416
|
+
# serial number is the device ARN.
|
|
417
|
+
# * +:authentication_code_1+ - *required* - (String) An authentication
|
|
418
|
+
# code emitted by the device.
|
|
419
|
+
# * +:authentication_code_2+ - *required* - (String) A subsequent
|
|
420
|
+
# authentication code emitted by the device.
|
|
421
|
+
#
|
|
422
|
+
# === Response Structure:
|
|
423
|
+
#
|
|
424
|
+
# This method returns no response data.
|
|
425
|
+
#
|
|
426
|
+
# @return [Core::Response]
|
|
427
|
+
#
|
|
428
|
+
define_client_method :enable_mfa_device, 'EnableMFADevice'
|
|
429
|
+
|
|
430
|
+
# Calls the GetAccountPasswordPolicy API operation.
|
|
431
|
+
# @method get_account_password_policy(options = {})
|
|
432
|
+
#
|
|
433
|
+
# === Options:
|
|
434
|
+
#
|
|
435
|
+
# This method accepts no options.
|
|
436
|
+
#
|
|
437
|
+
# === Response Structure:
|
|
438
|
+
#
|
|
439
|
+
# * +:password_policy+ - (Hash)
|
|
440
|
+
# * +:minimum_password_length+ - (Integer)
|
|
441
|
+
# * +:require_symbols+ - (Boolean)
|
|
442
|
+
# * +:require_numbers+ - (Boolean)
|
|
443
|
+
# * +:require_uppercase_characters+ - (Boolean)
|
|
444
|
+
# * +:require_lowercase_characters+ - (Boolean)
|
|
445
|
+
#
|
|
446
|
+
# @return [Core::Response]
|
|
447
|
+
#
|
|
448
|
+
define_client_method :get_account_password_policy, 'GetAccountPasswordPolicy'
|
|
449
|
+
|
|
450
|
+
# Calls the GetAccountSummary API operation.
|
|
451
|
+
# @method get_account_summary(options = {})
|
|
452
|
+
#
|
|
453
|
+
# === Options:
|
|
454
|
+
#
|
|
455
|
+
# This method accepts no options.
|
|
456
|
+
#
|
|
457
|
+
# === Response Structure:
|
|
458
|
+
#
|
|
459
|
+
# * +:summary_map+ - (Hash<String,Integer>)
|
|
460
|
+
#
|
|
461
|
+
# @return [Core::Response]
|
|
462
|
+
#
|
|
463
|
+
define_client_method :get_account_summary, 'GetAccountSummary'
|
|
464
|
+
|
|
465
|
+
# Calls the GetGroup API operation.
|
|
466
|
+
# @method get_group(options = {})
|
|
467
|
+
#
|
|
468
|
+
# === Options:
|
|
469
|
+
#
|
|
470
|
+
# * +:group_name+ - *required* - (String) Name of the group.
|
|
471
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
472
|
+
# in a subsequent request after you've received a response where the
|
|
473
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
474
|
+
# the response you just received.
|
|
475
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
476
|
+
# indicate the maximum number of user names you want in the response.
|
|
477
|
+
# If there are additional user names beyond the maximum you specify,
|
|
478
|
+
# the IsTruncated response element is +true+ .
|
|
479
|
+
#
|
|
480
|
+
# === Response Structure:
|
|
481
|
+
#
|
|
482
|
+
# * +:group+ - (Hash)
|
|
483
|
+
# * +:path+ - (String)
|
|
484
|
+
# * +:group_name+ - (String)
|
|
485
|
+
# * +:group_id+ - (String)
|
|
486
|
+
# * +:arn+ - (String)
|
|
487
|
+
# * +:create_date+ - (Time)
|
|
488
|
+
# * +:users+ - (Array<Hash>)
|
|
489
|
+
# * +:path+ - (String)
|
|
490
|
+
# * +:user_name+ - (String)
|
|
491
|
+
# * +:user_id+ - (String)
|
|
492
|
+
# * +:arn+ - (String)
|
|
493
|
+
# * +:create_date+ - (Time)
|
|
494
|
+
# * +:is_truncated+ - (Boolean)
|
|
495
|
+
# * +:marker+ - (String)
|
|
496
|
+
#
|
|
497
|
+
# @return [Core::Response]
|
|
498
|
+
#
|
|
499
|
+
define_client_method :get_group, 'GetGroup'
|
|
500
|
+
|
|
501
|
+
# Calls the GetGroupPolicy API operation.
|
|
502
|
+
# @method get_group_policy(options = {})
|
|
503
|
+
#
|
|
504
|
+
# === Options:
|
|
505
|
+
#
|
|
506
|
+
# * +:group_name+ - *required* - (String) Name of the group the policy is
|
|
507
|
+
# associated with.
|
|
508
|
+
# * +:policy_name+ - *required* - (String) Name of the policy document to
|
|
509
|
+
# get.
|
|
510
|
+
#
|
|
511
|
+
# === Response Structure:
|
|
512
|
+
#
|
|
513
|
+
# * +:group_name+ - (String)
|
|
514
|
+
# * +:policy_name+ - (String)
|
|
515
|
+
# * +:policy_document+ - (String)
|
|
516
|
+
#
|
|
517
|
+
# @return [Core::Response]
|
|
518
|
+
#
|
|
519
|
+
define_client_method :get_group_policy, 'GetGroupPolicy'
|
|
520
|
+
|
|
521
|
+
# Calls the GetLoginProfile API operation.
|
|
522
|
+
# @method get_login_profile(options = {})
|
|
523
|
+
#
|
|
524
|
+
# === Options:
|
|
525
|
+
#
|
|
526
|
+
# * +:user_name+ - *required* - (String) Name of the user whose password
|
|
527
|
+
# you want to retrieve.
|
|
528
|
+
#
|
|
529
|
+
# === Response Structure:
|
|
530
|
+
#
|
|
531
|
+
# * +:login_profile+ - (Hash)
|
|
532
|
+
# * +:user_name+ - (String)
|
|
533
|
+
# * +:create_date+ - (Time)
|
|
534
|
+
#
|
|
535
|
+
# @return [Core::Response]
|
|
536
|
+
#
|
|
537
|
+
define_client_method :get_login_profile, 'GetLoginProfile'
|
|
538
|
+
|
|
539
|
+
# Calls the GetServerCertificate API operation.
|
|
540
|
+
# @method get_server_certificate(options = {})
|
|
541
|
+
#
|
|
542
|
+
# === Options:
|
|
543
|
+
#
|
|
544
|
+
# * +:server_certificate_name+ - *required* - (String) The name of the
|
|
545
|
+
# server certificate you want to retrieve information about.
|
|
546
|
+
#
|
|
547
|
+
# === Response Structure:
|
|
548
|
+
#
|
|
549
|
+
# * +:server_certificate+ - (Hash)
|
|
550
|
+
# * +:server_certificate_metadata+ - (Hash)
|
|
551
|
+
# * +:path+ - (String)
|
|
552
|
+
# * +:server_certificate_name+ - (String)
|
|
553
|
+
# * +:server_certificate_id+ - (String)
|
|
554
|
+
# * +:arn+ - (String)
|
|
555
|
+
# * +:upload_date+ - (Time)
|
|
556
|
+
# * +:certificate_body+ - (String)
|
|
557
|
+
# * +:certificate_chain+ - (String)
|
|
558
|
+
#
|
|
559
|
+
# @return [Core::Response]
|
|
560
|
+
#
|
|
561
|
+
define_client_method :get_server_certificate, 'GetServerCertificate'
|
|
562
|
+
|
|
563
|
+
# Calls the GetUser API operation.
|
|
564
|
+
# @method get_user(options = {})
|
|
565
|
+
#
|
|
566
|
+
# === Options:
|
|
567
|
+
#
|
|
568
|
+
# * +:user_name+ - (String) Name of the user to get information about.
|
|
569
|
+
# This parameter is optional. If it is not included, it defaults to the
|
|
570
|
+
# user making the request.
|
|
571
|
+
#
|
|
572
|
+
# === Response Structure:
|
|
573
|
+
#
|
|
574
|
+
# * +:user+ - (Hash)
|
|
575
|
+
# * +:path+ - (String)
|
|
576
|
+
# * +:user_name+ - (String)
|
|
577
|
+
# * +:user_id+ - (String)
|
|
578
|
+
# * +:arn+ - (String)
|
|
579
|
+
# * +:create_date+ - (Time)
|
|
580
|
+
#
|
|
581
|
+
# @return [Core::Response]
|
|
582
|
+
#
|
|
583
|
+
define_client_method :get_user, 'GetUser'
|
|
584
|
+
|
|
585
|
+
# Calls the GetUserPolicy API operation.
|
|
586
|
+
# @method get_user_policy(options = {})
|
|
587
|
+
#
|
|
588
|
+
# === Options:
|
|
589
|
+
#
|
|
590
|
+
# * +:user_name+ - *required* - (String) Name of the user who the policy
|
|
591
|
+
# is associated with.
|
|
592
|
+
# * +:policy_name+ - *required* - (String) Name of the policy document to
|
|
593
|
+
# get.
|
|
594
|
+
#
|
|
595
|
+
# === Response Structure:
|
|
596
|
+
#
|
|
597
|
+
# * +:user_name+ - (String)
|
|
598
|
+
# * +:policy_name+ - (String)
|
|
599
|
+
# * +:policy_document+ - (String)
|
|
600
|
+
#
|
|
601
|
+
# @return [Core::Response]
|
|
602
|
+
#
|
|
603
|
+
define_client_method :get_user_policy, 'GetUserPolicy'
|
|
604
|
+
|
|
605
|
+
# Calls the ListAccessKeys API operation.
|
|
606
|
+
# @method list_access_keys(options = {})
|
|
607
|
+
#
|
|
608
|
+
# === Options:
|
|
609
|
+
#
|
|
610
|
+
# * +:user_name+ - (String) Name of the user.
|
|
611
|
+
# * +:marker+ - (String) Use this parameter only when paginating results,
|
|
612
|
+
# and only in a subsequent request after you've received a response
|
|
613
|
+
# where the results are truncated. Set it to the value of the Marker
|
|
614
|
+
# element in the response you just received.
|
|
615
|
+
# * +:max_items+ - (Integer) Use this parameter only when paginating
|
|
616
|
+
# results to indicate the maximum number of keys you want in the
|
|
617
|
+
# response. If there are additional keys beyond the maximum you
|
|
618
|
+
# specify, the IsTruncated response element is +true+ .
|
|
619
|
+
#
|
|
620
|
+
# === Response Structure:
|
|
621
|
+
#
|
|
622
|
+
# * +:access_key_metadata+ - (Array<Hash>)
|
|
623
|
+
# * +:user_name+ - (String)
|
|
624
|
+
# * +:access_key_id+ - (String)
|
|
625
|
+
# * +:status+ - (String)
|
|
626
|
+
# * +:create_date+ - (Time)
|
|
627
|
+
# * +:is_truncated+ - (Boolean)
|
|
628
|
+
# * +:marker+ - (String)
|
|
629
|
+
#
|
|
630
|
+
# @return [Core::Response]
|
|
631
|
+
#
|
|
632
|
+
define_client_method :list_access_keys, 'ListAccessKeys'
|
|
633
|
+
|
|
634
|
+
# Calls the ListAccountAliases API operation.
|
|
635
|
+
# @method list_account_aliases(options = {})
|
|
636
|
+
#
|
|
637
|
+
# === Options:
|
|
638
|
+
#
|
|
639
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
640
|
+
# in a subsequent request after you've received a response where the
|
|
641
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
642
|
+
# the response you just received.
|
|
643
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
644
|
+
# indicate the maximum number of account aliases you want in the
|
|
645
|
+
# response. If there are additional account aliases beyond the maximum
|
|
646
|
+
# you specify, the IsTruncated response element is +true+ .
|
|
647
|
+
#
|
|
648
|
+
# === Response Structure:
|
|
649
|
+
#
|
|
650
|
+
# * +:account_aliases+ - (Array<String>)
|
|
651
|
+
# * +:is_truncated+ - (Boolean)
|
|
652
|
+
# * +:marker+ - (String)
|
|
653
|
+
#
|
|
654
|
+
# @return [Core::Response]
|
|
655
|
+
#
|
|
656
|
+
define_client_method :list_account_aliases, 'ListAccountAliases'
|
|
657
|
+
|
|
658
|
+
# Calls the ListGroupPolicies API operation.
|
|
659
|
+
# @method list_group_policies(options = {})
|
|
660
|
+
#
|
|
661
|
+
# === Options:
|
|
662
|
+
#
|
|
663
|
+
# * +:group_name+ - *required* - (String) The name of the group to list
|
|
664
|
+
# policies for.
|
|
665
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
666
|
+
# in a subsequent request after you've received a response where the
|
|
667
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
668
|
+
# the response you just received.
|
|
669
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
670
|
+
# indicate the maximum number of policy names you want in the response.
|
|
671
|
+
# If there are additional policy names beyond the maximum you specify,
|
|
672
|
+
# the IsTruncated response element is +true+ .
|
|
673
|
+
#
|
|
674
|
+
# === Response Structure:
|
|
675
|
+
#
|
|
676
|
+
# * +:policy_names+ - (Array<String>)
|
|
677
|
+
# * +:is_truncated+ - (Boolean)
|
|
678
|
+
# * +:marker+ - (String)
|
|
679
|
+
#
|
|
680
|
+
# @return [Core::Response]
|
|
681
|
+
#
|
|
682
|
+
define_client_method :list_group_policies, 'ListGroupPolicies'
|
|
683
|
+
|
|
684
|
+
# Calls the ListGroups API operation.
|
|
685
|
+
# @method list_groups(options = {})
|
|
686
|
+
#
|
|
687
|
+
# === Options:
|
|
688
|
+
#
|
|
689
|
+
# * +:path_prefix+ - (String) The path prefix for filtering the results.
|
|
690
|
+
# For example: /division_abc/subdivision_xyz/, which would get all
|
|
691
|
+
# groups whose path starts with /division_abc/subdivision_xyz/. This
|
|
692
|
+
# parameter is optional. If it is not included, it defaults to a slash
|
|
693
|
+
# (/), listing all groups.
|
|
694
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
695
|
+
# in a subsequent request after you've received a response where the
|
|
696
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
697
|
+
# the response you just received.
|
|
698
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
699
|
+
# indicate the maximum number of groups you want in the response. If
|
|
700
|
+
# there are additional groups beyond the maximum you specify, the
|
|
701
|
+
# IsTruncated response element is +true+ .
|
|
702
|
+
#
|
|
703
|
+
# === Response Structure:
|
|
704
|
+
#
|
|
705
|
+
# * +:groups+ - (Array<Hash>)
|
|
706
|
+
# * +:path+ - (String)
|
|
707
|
+
# * +:group_name+ - (String)
|
|
708
|
+
# * +:group_id+ - (String)
|
|
709
|
+
# * +:arn+ - (String)
|
|
710
|
+
# * +:create_date+ - (Time)
|
|
711
|
+
# * +:is_truncated+ - (Boolean)
|
|
712
|
+
# * +:marker+ - (String)
|
|
713
|
+
#
|
|
714
|
+
# @return [Core::Response]
|
|
715
|
+
#
|
|
716
|
+
define_client_method :list_groups, 'ListGroups'
|
|
717
|
+
|
|
718
|
+
# Calls the ListGroupsForUser API operation.
|
|
719
|
+
# @method list_groups_for_user(options = {})
|
|
720
|
+
#
|
|
721
|
+
# === Options:
|
|
722
|
+
#
|
|
723
|
+
# * +:user_name+ - *required* - (String) The name of the user to list
|
|
724
|
+
# groups for.
|
|
725
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
726
|
+
# in a subsequent request after you've received a response where the
|
|
727
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
728
|
+
# the response you just received.
|
|
729
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
730
|
+
# indicate the maximum number of groups you want in the response. If
|
|
731
|
+
# there are additional groups beyond the maximum you specify, the
|
|
732
|
+
# IsTruncated response element is +true+ .
|
|
733
|
+
#
|
|
734
|
+
# === Response Structure:
|
|
735
|
+
#
|
|
736
|
+
# * +:groups+ - (Array<Hash>)
|
|
737
|
+
# * +:path+ - (String)
|
|
738
|
+
# * +:group_name+ - (String)
|
|
739
|
+
# * +:group_id+ - (String)
|
|
740
|
+
# * +:arn+ - (String)
|
|
741
|
+
# * +:create_date+ - (Time)
|
|
742
|
+
# * +:is_truncated+ - (Boolean)
|
|
743
|
+
# * +:marker+ - (String)
|
|
744
|
+
#
|
|
745
|
+
# @return [Core::Response]
|
|
746
|
+
#
|
|
747
|
+
define_client_method :list_groups_for_user, 'ListGroupsForUser'
|
|
748
|
+
|
|
749
|
+
# Calls the ListMFADevices API operation.
|
|
750
|
+
# @method list_mfa_devices(options = {})
|
|
751
|
+
#
|
|
752
|
+
# === Options:
|
|
753
|
+
#
|
|
754
|
+
# * +:user_name+ - (String) Name of the user whose MFA devices you want
|
|
755
|
+
# to list.
|
|
756
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
757
|
+
# in a subsequent request after you've received a response where the
|
|
758
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
759
|
+
# the response you just received.
|
|
760
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
761
|
+
# indicate the maximum number of MFA devices you want in the response.
|
|
762
|
+
# If there are additional MFA devices beyond the maximum you specify,
|
|
763
|
+
# the IsTruncated response element is +true+ .
|
|
764
|
+
#
|
|
765
|
+
# === Response Structure:
|
|
766
|
+
#
|
|
767
|
+
# * +:mfa_devices+ - (Array<Hash>)
|
|
768
|
+
# * +:user_name+ - (String)
|
|
769
|
+
# * +:serial_number+ - (String)
|
|
770
|
+
# * +:enable_date+ - (Time)
|
|
771
|
+
# * +:is_truncated+ - (Boolean)
|
|
772
|
+
# * +:marker+ - (String)
|
|
773
|
+
#
|
|
774
|
+
# @return [Core::Response]
|
|
775
|
+
#
|
|
776
|
+
define_client_method :list_mfa_devices, 'ListMFADevices'
|
|
777
|
+
|
|
778
|
+
# Calls the ListServerCertificates API operation.
|
|
779
|
+
# @method list_server_certificates(options = {})
|
|
780
|
+
#
|
|
781
|
+
# === Options:
|
|
782
|
+
#
|
|
783
|
+
# * +:path_prefix+ - (String) The path prefix for filtering the results.
|
|
784
|
+
# For example: /company/servercerts would get all server certificates
|
|
785
|
+
# for which the path starts with /company/servercerts. This parameter
|
|
786
|
+
# is optional. If it is not included, it defaults to a slash (/),
|
|
787
|
+
# listing all server certificates.
|
|
788
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
789
|
+
# in a subsequent request after you've received a response where the
|
|
790
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
791
|
+
# the response you just received.
|
|
792
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
793
|
+
# indicate the maximum number of server certificates you want in the
|
|
794
|
+
# response. If there are additional server certificates beyond the
|
|
795
|
+
# maximum you specify, the IsTruncated response element will be set to
|
|
796
|
+
# +true+ .
|
|
797
|
+
#
|
|
798
|
+
# === Response Structure:
|
|
799
|
+
#
|
|
800
|
+
# * +:server_certificate_metadata_list+ - (Array<Hash>)
|
|
801
|
+
# * +:path+ - (String)
|
|
802
|
+
# * +:server_certificate_name+ - (String)
|
|
803
|
+
# * +:server_certificate_id+ - (String)
|
|
804
|
+
# * +:arn+ - (String)
|
|
805
|
+
# * +:upload_date+ - (Time)
|
|
806
|
+
# * +:is_truncated+ - (Boolean)
|
|
807
|
+
# * +:marker+ - (String)
|
|
808
|
+
#
|
|
809
|
+
# @return [Core::Response]
|
|
810
|
+
#
|
|
811
|
+
define_client_method :list_server_certificates, 'ListServerCertificates'
|
|
812
|
+
|
|
813
|
+
# Calls the ListSigningCertificates API operation.
|
|
814
|
+
# @method list_signing_certificates(options = {})
|
|
815
|
+
#
|
|
816
|
+
# === Options:
|
|
817
|
+
#
|
|
818
|
+
# * +:user_name+ - (String) The name of the user.
|
|
819
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
820
|
+
# in a subsequent request after you've received a response where the
|
|
821
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
822
|
+
# the response you just received.
|
|
823
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
824
|
+
# indicate the maximum number of certificate IDs you want in the
|
|
825
|
+
# response. If there are additional certificate IDs beyond the maximum
|
|
826
|
+
# you specify, the IsTruncated response element is +true+ .
|
|
827
|
+
#
|
|
828
|
+
# === Response Structure:
|
|
829
|
+
#
|
|
830
|
+
# * +:certificates+ - (Array<Hash>)
|
|
831
|
+
# * +:user_name+ - (String)
|
|
832
|
+
# * +:certificate_id+ - (String)
|
|
833
|
+
# * +:certificate_body+ - (String)
|
|
834
|
+
# * +:status+ - (String)
|
|
835
|
+
# * +:upload_date+ - (Time)
|
|
836
|
+
# * +:is_truncated+ - (Boolean)
|
|
837
|
+
# * +:marker+ - (String)
|
|
838
|
+
#
|
|
839
|
+
# @return [Core::Response]
|
|
840
|
+
#
|
|
841
|
+
define_client_method :list_signing_certificates, 'ListSigningCertificates'
|
|
842
|
+
|
|
843
|
+
# Calls the ListUserPolicies API operation.
|
|
844
|
+
# @method list_user_policies(options = {})
|
|
845
|
+
#
|
|
846
|
+
# === Options:
|
|
847
|
+
#
|
|
848
|
+
# * +:user_name+ - *required* - (String) The name of the user to list
|
|
849
|
+
# policies for.
|
|
850
|
+
# * +:marker+ - (String) Use this only when paginating results, and only
|
|
851
|
+
# in a subsequent request after you've received a response where the
|
|
852
|
+
# results are truncated. Set it to the value of the Marker element in
|
|
853
|
+
# the response you just received.
|
|
854
|
+
# * +:max_items+ - (Integer) Use this only when paginating results to
|
|
855
|
+
# indicate the maximum number of policy names you want in the response.
|
|
856
|
+
# If there are additional policy names beyond the maximum you specify,
|
|
857
|
+
# the IsTruncated response element is +true+ .
|
|
858
|
+
#
|
|
859
|
+
# === Response Structure:
|
|
860
|
+
#
|
|
861
|
+
# * +:policy_names+ - (Array<String>)
|
|
862
|
+
# * +:is_truncated+ - (Boolean)
|
|
863
|
+
# * +:marker+ - (String)
|
|
864
|
+
#
|
|
865
|
+
# @return [Core::Response]
|
|
866
|
+
#
|
|
867
|
+
define_client_method :list_user_policies, 'ListUserPolicies'
|
|
868
|
+
|
|
869
|
+
# Calls the ListUsers API operation.
|
|
870
|
+
# @method list_users(options = {})
|
|
871
|
+
#
|
|
872
|
+
# === Options:
|
|
873
|
+
#
|
|
874
|
+
# * +:path_prefix+ - (String) The path prefix for filtering the results.
|
|
875
|
+
# For example: /division_abc/subdivision_xyz/, which would get all user
|
|
876
|
+
# names whose path starts with /division_abc/subdivision_xyz/. This
|
|
877
|
+
# parameter is optional. If it is not included, it defaults to a slash
|
|
878
|
+
# (/), listing all user names.
|
|
879
|
+
# * +:marker+ - (String) Use this parameter only when paginating results,
|
|
880
|
+
# and only in a subsequent request after you've received a response
|
|
881
|
+
# where the results are truncated. Set it to the value of the Marker
|
|
882
|
+
# element in the response you just received.
|
|
883
|
+
# * +:max_items+ - (Integer) Use this parameter only when paginating
|
|
884
|
+
# results to indicate the maximum number of user names you want in the
|
|
885
|
+
# response. If there are additional user names beyond the maximum you
|
|
886
|
+
# specify, the IsTruncated response element is +true+ .
|
|
887
|
+
#
|
|
888
|
+
# === Response Structure:
|
|
889
|
+
#
|
|
890
|
+
# * +:users+ - (Array<Hash>)
|
|
891
|
+
# * +:path+ - (String)
|
|
892
|
+
# * +:user_name+ - (String)
|
|
893
|
+
# * +:user_id+ - (String)
|
|
894
|
+
# * +:arn+ - (String)
|
|
895
|
+
# * +:create_date+ - (Time)
|
|
896
|
+
# * +:is_truncated+ - (Boolean)
|
|
897
|
+
# * +:marker+ - (String)
|
|
898
|
+
#
|
|
899
|
+
# @return [Core::Response]
|
|
900
|
+
#
|
|
901
|
+
define_client_method :list_users, 'ListUsers'
|
|
902
|
+
|
|
903
|
+
# Calls the ListVirtualMFADevices API operation.
|
|
904
|
+
# @method list_virtual_mfa_devices(options = {})
|
|
905
|
+
#
|
|
906
|
+
# === Options:
|
|
907
|
+
#
|
|
908
|
+
# * +:assignment_status+ - (String) The status (unassigned or assigned)
|
|
909
|
+
# of the devices to list. If you do not specify an AssignmentStatus,
|
|
910
|
+
# the action defaults to Any which lists both assigned and unassigned
|
|
911
|
+
# virtual MFA devices.
|
|
912
|
+
# * +:marker+ - (String) Use this parameter only when paginating results,
|
|
913
|
+
# and only in a subsequent request after you've received a response
|
|
914
|
+
# where the results are truncated. Set it to the value of the Marker
|
|
915
|
+
# element in the response you just received.
|
|
916
|
+
# * +:max_items+ - (Integer) Use this parameter only when paginating
|
|
917
|
+
# results to indicate the maximum number of user names you want in the
|
|
918
|
+
# response. If there are additional user names beyond the maximum you
|
|
919
|
+
# specify, the IsTruncated response element is +true+ .
|
|
920
|
+
#
|
|
921
|
+
# === Response Structure:
|
|
922
|
+
#
|
|
923
|
+
# * +:virtual_mfa_devices+ - (Array<Hash>)
|
|
924
|
+
# * +:serial_number+ - (String)
|
|
925
|
+
# * +:base_32_string_seed+ - (String)
|
|
926
|
+
# * +:qr_code_png+ - (String)
|
|
927
|
+
# * +:user+ - (Hash)
|
|
928
|
+
# * +:path+ - (String)
|
|
929
|
+
# * +:user_name+ - (String)
|
|
930
|
+
# * +:user_id+ - (String)
|
|
931
|
+
# * +:arn+ - (String)
|
|
932
|
+
# * +:create_date+ - (Time)
|
|
933
|
+
# * +:enable_date+ - (Time)
|
|
934
|
+
# * +:is_truncated+ - (Boolean)
|
|
935
|
+
# * +:marker+ - (String)
|
|
936
|
+
#
|
|
937
|
+
# @return [Core::Response]
|
|
938
|
+
#
|
|
939
|
+
define_client_method :list_virtual_mfa_devices, 'ListVirtualMFADevices'
|
|
940
|
+
|
|
941
|
+
# Calls the PutGroupPolicy API operation.
|
|
942
|
+
# @method put_group_policy(options = {})
|
|
943
|
+
#
|
|
944
|
+
# === Options:
|
|
945
|
+
#
|
|
946
|
+
# * +:group_name+ - *required* - (String) Name of the group to associate
|
|
947
|
+
# the policy with.
|
|
948
|
+
# * +:policy_name+ - *required* - (String) Name of the policy document.
|
|
949
|
+
# * +:policy_document+ - *required* - (String) The policy document.
|
|
950
|
+
#
|
|
951
|
+
# === Response Structure:
|
|
952
|
+
#
|
|
953
|
+
# This method returns no response data.
|
|
954
|
+
#
|
|
955
|
+
# @return [Core::Response]
|
|
956
|
+
#
|
|
957
|
+
define_client_method :put_group_policy, 'PutGroupPolicy'
|
|
958
|
+
|
|
959
|
+
# Calls the PutUserPolicy API operation.
|
|
960
|
+
# @method put_user_policy(options = {})
|
|
961
|
+
#
|
|
962
|
+
# === Options:
|
|
963
|
+
#
|
|
964
|
+
# * +:user_name+ - *required* - (String) Name of the user to associate
|
|
965
|
+
# the policy with.
|
|
966
|
+
# * +:policy_name+ - *required* - (String) Name of the policy document.
|
|
967
|
+
# * +:policy_document+ - *required* - (String) The policy document.
|
|
968
|
+
#
|
|
969
|
+
# === Response Structure:
|
|
970
|
+
#
|
|
971
|
+
# This method returns no response data.
|
|
972
|
+
#
|
|
973
|
+
# @return [Core::Response]
|
|
974
|
+
#
|
|
975
|
+
define_client_method :put_user_policy, 'PutUserPolicy'
|
|
976
|
+
|
|
977
|
+
# Calls the RemoveUserFromGroup API operation.
|
|
978
|
+
# @method remove_user_from_group(options = {})
|
|
979
|
+
#
|
|
980
|
+
# === Options:
|
|
981
|
+
#
|
|
982
|
+
# * +:group_name+ - *required* - (String) Name of the group to update.
|
|
983
|
+
# * +:user_name+ - *required* - (String) Name of the user to remove.
|
|
984
|
+
#
|
|
985
|
+
# === Response Structure:
|
|
986
|
+
#
|
|
987
|
+
# This method returns no response data.
|
|
988
|
+
#
|
|
989
|
+
# @return [Core::Response]
|
|
990
|
+
#
|
|
991
|
+
define_client_method :remove_user_from_group, 'RemoveUserFromGroup'
|
|
992
|
+
|
|
993
|
+
# Calls the ResyncMFADevice API operation.
|
|
994
|
+
# @method resync_mfa_device(options = {})
|
|
995
|
+
#
|
|
996
|
+
# === Options:
|
|
997
|
+
#
|
|
998
|
+
# * +:user_name+ - *required* - (String) Name of the user whose MFA
|
|
999
|
+
# device you want to resynchronize.
|
|
1000
|
+
# * +:serial_number+ - *required* - (String) Serial number that uniquely
|
|
1001
|
+
# identifies the MFA device.
|
|
1002
|
+
# * +:authentication_code_1+ - *required* - (String) An authentication
|
|
1003
|
+
# code emitted by the device.
|
|
1004
|
+
# * +:authentication_code_2+ - *required* - (String) A subsequent
|
|
1005
|
+
# authentication code emitted by the device.
|
|
1006
|
+
#
|
|
1007
|
+
# === Response Structure:
|
|
1008
|
+
#
|
|
1009
|
+
# This method returns no response data.
|
|
1010
|
+
#
|
|
1011
|
+
# @return [Core::Response]
|
|
1012
|
+
#
|
|
1013
|
+
define_client_method :resync_mfa_device, 'ResyncMFADevice'
|
|
1014
|
+
|
|
1015
|
+
# Calls the UpdateAccessKey API operation.
|
|
1016
|
+
# @method update_access_key(options = {})
|
|
1017
|
+
#
|
|
1018
|
+
# === Options:
|
|
1019
|
+
#
|
|
1020
|
+
# * +:user_name+ - (String) Name of the user whose key you want to
|
|
1021
|
+
# update.
|
|
1022
|
+
# * +:access_key_id+ - *required* - (String) The Access Key ID of the
|
|
1023
|
+
# Secret Access Key you want to update.
|
|
1024
|
+
# * +:status+ - *required* - (String) The status you want to assign to
|
|
1025
|
+
# the Secret Access Key. Active means the key can be used for API calls
|
|
1026
|
+
# to AWS, while Inactive means the key cannot be used.
|
|
1027
|
+
#
|
|
1028
|
+
# === Response Structure:
|
|
1029
|
+
#
|
|
1030
|
+
# This method returns no response data.
|
|
1031
|
+
#
|
|
1032
|
+
# @return [Core::Response]
|
|
1033
|
+
#
|
|
1034
|
+
define_client_method :update_access_key, 'UpdateAccessKey'
|
|
1035
|
+
|
|
1036
|
+
# Calls the UpdateAccountPasswordPolicy API operation.
|
|
1037
|
+
# @method update_account_password_policy(options = {})
|
|
1038
|
+
#
|
|
1039
|
+
# === Options:
|
|
1040
|
+
#
|
|
1041
|
+
# * +:minimum_password_length+ - (Integer)
|
|
1042
|
+
# * +:require_symbols+ - (Boolean)
|
|
1043
|
+
# * +:require_numbers+ - (Boolean)
|
|
1044
|
+
# * +:require_uppercase_characters+ - (Boolean)
|
|
1045
|
+
# * +:require_lowercase_characters+ - (Boolean)
|
|
1046
|
+
#
|
|
1047
|
+
# === Response Structure:
|
|
1048
|
+
#
|
|
1049
|
+
# This method returns no response data.
|
|
1050
|
+
#
|
|
1051
|
+
# @return [Core::Response]
|
|
1052
|
+
#
|
|
1053
|
+
define_client_method :update_account_password_policy, 'UpdateAccountPasswordPolicy'
|
|
1054
|
+
|
|
1055
|
+
# Calls the UpdateGroup API operation.
|
|
1056
|
+
# @method update_group(options = {})
|
|
1057
|
+
#
|
|
1058
|
+
# === Options:
|
|
1059
|
+
#
|
|
1060
|
+
# * +:group_name+ - *required* - (String) Name of the group to update. If
|
|
1061
|
+
# you're changing the name of the group, this is the original name.
|
|
1062
|
+
# * +:new_path+ - (String) New path for the group. Only include this if
|
|
1063
|
+
# changing the group's path.
|
|
1064
|
+
# * +:new_group_name+ - (String) New name for the group. Only include
|
|
1065
|
+
# this if changing the group's name.
|
|
1066
|
+
#
|
|
1067
|
+
# === Response Structure:
|
|
1068
|
+
#
|
|
1069
|
+
# This method returns no response data.
|
|
1070
|
+
#
|
|
1071
|
+
# @return [Core::Response]
|
|
1072
|
+
#
|
|
1073
|
+
define_client_method :update_group, 'UpdateGroup'
|
|
1074
|
+
|
|
1075
|
+
# Calls the UpdateLoginProfile API operation.
|
|
1076
|
+
# @method update_login_profile(options = {})
|
|
1077
|
+
#
|
|
1078
|
+
# === Options:
|
|
1079
|
+
#
|
|
1080
|
+
# * +:user_name+ - *required* - (String) Name of the user whose password
|
|
1081
|
+
# you want to update.
|
|
1082
|
+
# * +:password+ - (String) The new password for the user name.
|
|
1083
|
+
#
|
|
1084
|
+
# === Response Structure:
|
|
1085
|
+
#
|
|
1086
|
+
# This method returns no response data.
|
|
1087
|
+
#
|
|
1088
|
+
# @return [Core::Response]
|
|
1089
|
+
#
|
|
1090
|
+
define_client_method :update_login_profile, 'UpdateLoginProfile'
|
|
1091
|
+
|
|
1092
|
+
# Calls the UpdateServerCertificate API operation.
|
|
1093
|
+
# @method update_server_certificate(options = {})
|
|
1094
|
+
#
|
|
1095
|
+
# === Options:
|
|
1096
|
+
#
|
|
1097
|
+
# * +:server_certificate_name+ - *required* - (String) The name of the
|
|
1098
|
+
# server certificate that you want to update.
|
|
1099
|
+
# * +:new_path+ - (String) The new path for the server certificate.
|
|
1100
|
+
# Include this only if you are updating the server certificate's path.
|
|
1101
|
+
# * +:new_server_certificate_name+ - (String) The new name for the server
|
|
1102
|
+
# certificate. Include this only if you are updating the server
|
|
1103
|
+
# certificate's name.
|
|
1104
|
+
#
|
|
1105
|
+
# === Response Structure:
|
|
1106
|
+
#
|
|
1107
|
+
# This method returns no response data.
|
|
1108
|
+
#
|
|
1109
|
+
# @return [Core::Response]
|
|
1110
|
+
#
|
|
1111
|
+
define_client_method :update_server_certificate, 'UpdateServerCertificate'
|
|
1112
|
+
|
|
1113
|
+
# Calls the UpdateSigningCertificate API operation.
|
|
1114
|
+
# @method update_signing_certificate(options = {})
|
|
1115
|
+
#
|
|
1116
|
+
# === Options:
|
|
1117
|
+
#
|
|
1118
|
+
# * +:user_name+ - (String) Name of the user the signing certificate
|
|
1119
|
+
# belongs to.
|
|
1120
|
+
# * +:certificate_id+ - *required* - (String) The ID of the signing
|
|
1121
|
+
# certificate you want to update.
|
|
1122
|
+
# * +:status+ - *required* - (String) The status you want to assign to
|
|
1123
|
+
# the certificate. Active means the certificate can be used for API
|
|
1124
|
+
# calls to AWS, while Inactive means the certificate cannot be used.
|
|
1125
|
+
#
|
|
1126
|
+
# === Response Structure:
|
|
1127
|
+
#
|
|
1128
|
+
# This method returns no response data.
|
|
1129
|
+
#
|
|
1130
|
+
# @return [Core::Response]
|
|
1131
|
+
#
|
|
1132
|
+
define_client_method :update_signing_certificate, 'UpdateSigningCertificate'
|
|
1133
|
+
|
|
1134
|
+
# Calls the UpdateUser API operation.
|
|
1135
|
+
# @method update_user(options = {})
|
|
1136
|
+
#
|
|
1137
|
+
# === Options:
|
|
1138
|
+
#
|
|
1139
|
+
# * +:user_name+ - *required* - (String) Name of the user to update. If
|
|
1140
|
+
# you're changing the name of the user, this is the original user name.
|
|
1141
|
+
# * +:new_path+ - (String) New path for the user. Include this parameter
|
|
1142
|
+
# only if you're changing the user's path.
|
|
1143
|
+
# * +:new_user_name+ - (String) New name for the user. Include this
|
|
1144
|
+
# parameter only if you're changing the user's name.
|
|
1145
|
+
#
|
|
1146
|
+
# === Response Structure:
|
|
1147
|
+
#
|
|
1148
|
+
# This method returns no response data.
|
|
1149
|
+
#
|
|
1150
|
+
# @return [Core::Response]
|
|
1151
|
+
#
|
|
1152
|
+
define_client_method :update_user, 'UpdateUser'
|
|
1153
|
+
|
|
1154
|
+
# Calls the UploadServerCertificate API operation.
|
|
1155
|
+
# @method upload_server_certificate(options = {})
|
|
1156
|
+
#
|
|
1157
|
+
# === Options:
|
|
1158
|
+
#
|
|
1159
|
+
# * +:path+ - (String) The path for the server certificate. For more
|
|
1160
|
+
# information about paths, see Identifiers for IAM Entities in Using
|
|
1161
|
+
# AWS Identity and Access Management. This parameter is optional. If it
|
|
1162
|
+
# is not included, it defaults to a slash (/).
|
|
1163
|
+
# * +:server_certificate_name+ - *required* - (String) The name for the
|
|
1164
|
+
# server certificate. Do not include the path in this value.
|
|
1165
|
+
# * +:certificate_body+ - *required* - (String) The contents of the
|
|
1166
|
+
# public key certificate in PEM-encoded format.
|
|
1167
|
+
# * +:private_key+ - *required* - (String) The contents of the private
|
|
1168
|
+
# key in PEM-encoded format.
|
|
1169
|
+
# * +:certificate_chain+ - (String) The contents of the certificate
|
|
1170
|
+
# chain. This is typically a concatenation of the PEM-encoded public
|
|
1171
|
+
# key certificates of the chain.
|
|
1172
|
+
#
|
|
1173
|
+
# === Response Structure:
|
|
1174
|
+
#
|
|
1175
|
+
# * +:server_certificate_metadata+ - (Hash)
|
|
1176
|
+
# * +:path+ - (String)
|
|
1177
|
+
# * +:server_certificate_name+ - (String)
|
|
1178
|
+
# * +:server_certificate_id+ - (String)
|
|
1179
|
+
# * +:arn+ - (String)
|
|
1180
|
+
# * +:upload_date+ - (Time)
|
|
1181
|
+
#
|
|
1182
|
+
# @return [Core::Response]
|
|
1183
|
+
#
|
|
1184
|
+
define_client_method :upload_server_certificate, 'UploadServerCertificate'
|
|
1185
|
+
|
|
1186
|
+
# Calls the UploadSigningCertificate API operation.
|
|
1187
|
+
# @method upload_signing_certificate(options = {})
|
|
1188
|
+
#
|
|
1189
|
+
# === Options:
|
|
1190
|
+
#
|
|
1191
|
+
# * +:user_name+ - (String) Name of the user the signing certificate is
|
|
1192
|
+
# for.
|
|
1193
|
+
# * +:certificate_body+ - *required* - (String) The contents of the
|
|
1194
|
+
# signing certificate.
|
|
1195
|
+
#
|
|
1196
|
+
# === Response Structure:
|
|
1197
|
+
#
|
|
1198
|
+
# * +:certificate+ - (Hash)
|
|
1199
|
+
# * +:user_name+ - (String)
|
|
1200
|
+
# * +:certificate_id+ - (String)
|
|
1201
|
+
# * +:certificate_body+ - (String)
|
|
1202
|
+
# * +:status+ - (String)
|
|
1203
|
+
# * +:upload_date+ - (Time)
|
|
1204
|
+
#
|
|
1205
|
+
# @return [Core::Response]
|
|
1206
|
+
#
|
|
1207
|
+
define_client_method :upload_signing_certificate, 'UploadSigningCertificate'
|
|
1208
|
+
|
|
1209
|
+
## end client methods ##
|
|
42
1210
|
|
|
43
1211
|
end
|
|
44
1212
|
end
|