aws-sdk 1.5.8 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. data/lib/aws.rb +2 -0
  2. data/lib/aws/api_config/Route53-2012-02-29.yml +348 -0
  3. data/lib/aws/auto_scaling/client.rb +362 -588
  4. data/lib/aws/cloud_formation/client.rb +155 -224
  5. data/lib/aws/cloud_watch/client.rb +156 -229
  6. data/lib/aws/core.rb +67 -52
  7. data/lib/aws/core/client.rb +81 -82
  8. data/lib/aws/core/collection/with_limit_and_next_token.rb +2 -2
  9. data/lib/aws/core/configuration.rb +75 -72
  10. data/lib/aws/core/http/net_http_handler.rb +3 -3
  11. data/lib/aws/core/http/request.rb +107 -138
  12. data/lib/aws/core/inflection.rb +3 -3
  13. data/lib/aws/core/json_client.rb +106 -0
  14. data/lib/aws/core/option_grammar.rb +10 -1
  15. data/lib/aws/core/options/validator.rb +140 -0
  16. data/lib/aws/core/options/xml_serializer.rb +98 -0
  17. data/lib/aws/core/query_client.rb +131 -0
  18. data/lib/aws/core/rest_client.rb +90 -0
  19. data/lib/aws/core/rest_client/input_handler.rb +145 -0
  20. data/lib/aws/core/rest_client/output_handler.rb +43 -0
  21. data/lib/aws/core/signature/version_2.rb +7 -7
  22. data/lib/aws/core/signature/version_3.rb +5 -1
  23. data/lib/aws/core/signature/version_3_https.rb +51 -0
  24. data/lib/aws/core/signature/version_4.rb +5 -22
  25. data/lib/aws/core/signer.rb +1 -1
  26. data/lib/aws/core/uri_escape.rb +2 -0
  27. data/lib/aws/core/xml/frame.rb +8 -8
  28. data/lib/aws/core/xml/grammar.rb +8 -3
  29. data/lib/aws/dynamo_db/client.rb +600 -662
  30. data/lib/aws/ec2/client.rb +2688 -3492
  31. data/lib/aws/ec2/request.rb +0 -1
  32. data/lib/aws/elb/client.rb +280 -407
  33. data/lib/aws/emr/client.rb +7 -7
  34. data/lib/aws/iam/client.rb +822 -1268
  35. data/lib/aws/route_53.rb +71 -0
  36. data/lib/aws/route_53/client.rb +272 -0
  37. data/lib/aws/route_53/config.rb +18 -0
  38. data/lib/aws/route_53/errors.rb +22 -0
  39. data/lib/aws/route_53/request.rb +23 -0
  40. data/lib/aws/s3/object_version_collection.rb +6 -6
  41. data/lib/aws/s3/paginated_collection.rb +1 -1
  42. data/lib/aws/s3/request.rb +10 -5
  43. data/lib/aws/simple_db/client.rb +184 -234
  44. data/lib/aws/simple_email_service/client.rb +147 -238
  45. data/lib/aws/simple_workflow/client.rb +997 -1191
  46. data/lib/aws/sns/client.rb +176 -264
  47. data/lib/aws/sqs/client.rb +162 -253
  48. data/lib/aws/sqs/queue.rb +1 -1
  49. data/lib/aws/sqs/request.rb +4 -0
  50. data/lib/aws/sts/client.rb +57 -66
  51. metadata +95 -71
  52. data/lib/aws/core/client/query_json.rb +0 -112
  53. data/lib/aws/core/client/query_xml.rb +0 -122
@@ -17,7 +17,7 @@ module AWS
17
17
 
18
18
  API_VERSION = '2009-03-31'
19
19
 
20
- extend Core::Client::QueryXML
20
+ extend Core::QueryClient
21
21
 
22
22
  # @private
23
23
  CACHEABLE_REQUESTS = Set[]
@@ -44,8 +44,8 @@ module AWS
44
44
  # * +:job_flow_id+ - *required* - (String) Job flow in which to add the
45
45
  # instance groups.
46
46
  # @return [Core::Response]
47
- # Returns a reponse object whos #data method returns a hash
48
- # the following structure:
47
+ # The #data method of the response object returns
48
+ # a hash with the following structure:
49
49
  # * +:job_flow_id+ - (String)
50
50
  # * +:instance_group_ids+ - (Array<String>)
51
51
  define_client_method :add_instance_groups, 'AddInstanceGroups'
@@ -90,8 +90,8 @@ module AWS
90
90
  # * +:job_flow_states+ - (Array<String>) Return only job flows whose
91
91
  # state is contained in this list.
92
92
  # @return [Core::Response]
93
- # Returns a reponse object whos #data method returns a hash
94
- # the following structure:
93
+ # The #data method of the response object returns
94
+ # a hash with the following structure:
95
95
  # * +:job_flows+ - (Array<Hash>)
96
96
  # * +:job_flow_id+ - (String)
97
97
  # * +:name+ - (String)
@@ -275,8 +275,8 @@ module AWS
275
275
  # value is "karmasphere-enterprise-utility", which tags the job flow
276
276
  # for management by Karmasphere.
277
277
  # @return [Core::Response]
278
- # Returns a reponse object whos #data method returns a hash
279
- # the following structure:
278
+ # The #data method of the response object returns
279
+ # a hash with the following structure:
280
280
  # * +:job_flow_id+ - (String)
281
281
  define_client_method :run_job_flow, 'RunJobFlow'
282
282
 
@@ -19,7 +19,7 @@ module AWS
19
19
 
20
20
  API_VERSION = '2010-05-08'
21
21
 
22
- extend Core::Client::QueryXML
22
+ extend Core::QueryClient
23
23
 
24
24
  # @private
25
25
  CACHEABLE_REQUESTS = Set[
@@ -42,1564 +42,1118 @@ module AWS
42
42
 
43
43
  # Calls the AddRoleToInstanceProfile API operation.
44
44
  # @method add_role_to_instance_profile(options = {})
45
- #
46
- # === Options:
47
- #
48
- # * +:instance_profile_name+ - *required* - (String) Name of the instance
49
- # profile to update.
50
- # * +:role_name+ - *required* - (String) Name of the role to add.
51
- #
52
- # === Response Structure:
53
- #
54
- # This method returns no response data.
55
- #
56
- # @return [Core::Response]
57
- #
45
+ # @param [Hash] options
46
+ # * +:instance_profile_name+ - *required* - (String) Name of the
47
+ # instance profile to update.
48
+ # * +:role_name+ - *required* - (String) Name of the role to add.
49
+ # @return [Core::Response]
58
50
  define_client_method :add_role_to_instance_profile, 'AddRoleToInstanceProfile'
59
51
 
60
52
  # Calls the AddUserToGroup API operation.
61
53
  # @method add_user_to_group(options = {})
62
- #
63
- # === Options:
64
- #
65
- # * +:group_name+ - *required* - (String) Name of the group to update.
66
- # * +:user_name+ - *required* - (String) Name of the user to add.
67
- #
68
- # === Response Structure:
69
- #
70
- # This method returns no response data.
71
- #
72
- # @return [Core::Response]
73
- #
54
+ # @param [Hash] options
55
+ # * +:group_name+ - *required* - (String) Name of the group to update.
56
+ # * +:user_name+ - *required* - (String) Name of the user to add.
57
+ # @return [Core::Response]
74
58
  define_client_method :add_user_to_group, 'AddUserToGroup'
75
59
 
76
60
  # Calls the ChangePassword API operation.
77
61
  # @method change_password(options = {})
78
- #
79
- # === Options:
80
- #
81
- # * +:old_password+ - *required* - (String)
82
- # * +:new_password+ - *required* - (String)
83
- #
84
- # === Response Structure:
85
- #
86
- # This method returns no response data.
87
- #
88
- # @return [Core::Response]
89
- #
62
+ # @param [Hash] options
63
+ # * +:old_password+ - *required* - (String)
64
+ # * +:new_password+ - *required* - (String)
65
+ # @return [Core::Response]
90
66
  define_client_method :change_password, 'ChangePassword'
91
67
 
92
68
  # Calls the CreateAccessKey API operation.
93
69
  # @method create_access_key(options = {})
94
- #
95
- # === Options:
96
- #
97
- # * +:user_name+ - (String) The user name that the new key will belong
98
- # to.
99
- #
100
- # === Response Structure:
101
- #
102
- # * +:access_key+ - (Hash)
103
- # * +:user_name+ - (String)
104
- # * +:access_key_id+ - (String)
105
- # * +:status+ - (String)
106
- # * +:secret_access_key+ - (String)
107
- # * +:create_date+ - (Time)
108
- #
70
+ # @param [Hash] options
71
+ # * +:user_name+ - (String) The user name that the new key will belong
72
+ # to.
109
73
  # @return [Core::Response]
110
- #
74
+ # The #data method of the response object returns
75
+ # a hash with the following structure:
76
+ # * +:access_key+ - (Hash)
77
+ # * +:user_name+ - (String)
78
+ # * +:access_key_id+ - (String)
79
+ # * +:status+ - (String)
80
+ # * +:secret_access_key+ - (String)
81
+ # * +:create_date+ - (Time)
111
82
  define_client_method :create_access_key, 'CreateAccessKey'
112
83
 
113
84
  # Calls the CreateAccountAlias API operation.
114
85
  # @method create_account_alias(options = {})
115
- #
116
- # === Options:
117
- #
118
- # * +:account_alias+ - *required* - (String) Name of the account alias to
119
- # create.
120
- #
121
- # === Response Structure:
122
- #
123
- # This method returns no response data.
124
- #
125
- # @return [Core::Response]
126
- #
86
+ # @param [Hash] options
87
+ # * +:account_alias+ - *required* - (String) Name of the account alias
88
+ # to create.
89
+ # @return [Core::Response]
127
90
  define_client_method :create_account_alias, 'CreateAccountAlias'
128
91
 
129
92
  # Calls the CreateGroup API operation.
130
93
  # @method create_group(options = {})
131
- #
132
- # === Options:
133
- #
134
- # * +:path+ - (String) The path to the group. For more information about
135
- # paths, see Identifiers for IAM Entities in Using AWS Identity and
136
- # Access Management. This parameter is optional. If it is not included,
137
- # it defaults to a slash (/).
138
- # * +:group_name+ - *required* - (String) Name of the group to create. Do
139
- # not include the path in this value.
140
- #
141
- # === Response Structure:
142
- #
143
- # * +:group+ - (Hash)
144
- # * +:path+ - (String)
145
- # * +:group_name+ - (String)
146
- # * +:group_id+ - (String)
147
- # * +:arn+ - (String)
148
- # * +:create_date+ - (Time)
149
- #
150
- # @return [Core::Response]
151
- #
94
+ # @param [Hash] options
95
+ # * +:path+ - (String) The path to the group. For more information
96
+ # about paths, see Identifiers for IAM Entities in Using AWS Identity
97
+ # and Access Management. This parameter is optional. If it is not
98
+ # included, it defaults to a slash (/).
99
+ # * +:group_name+ - *required* - (String) Name of the group to create.
100
+ # Do not include the path in this value.
101
+ # @return [Core::Response]
102
+ # The #data method of the response object returns
103
+ # a hash with the following structure:
104
+ # * +:group+ - (Hash)
105
+ # * +:path+ - (String)
106
+ # * +:group_name+ - (String)
107
+ # * +:group_id+ - (String)
108
+ # * +:arn+ - (String)
109
+ # * +:create_date+ - (Time)
152
110
  define_client_method :create_group, 'CreateGroup'
153
111
 
154
112
  # Calls the CreateInstanceProfile API operation.
155
113
  # @method create_instance_profile(options = {})
156
- #
157
- # === Options:
158
- #
159
- # * +:instance_profile_name+ - *required* - (String) Name of the instance
160
- # profile to create.
161
- # * +:path+ - (String) The path to the instance profile. For more
162
- # information about paths, see Identifiers for IAM Entities in Using
163
- # AWS Identity and Access Management. This parameter is optional. If it
164
- # is not included, it defaults to a slash (/).
165
- #
166
- # === Response Structure:
167
- #
168
- # * +:instance_profile+ - (Hash)
169
- # * +:path+ - (String)
170
- # * +:instance_profile_name+ - (String)
171
- # * +:instance_profile_id+ - (String)
172
- # * +:arn+ - (String)
173
- # * +:create_date+ - (Time)
174
- # * +:roles+ - (Array<Hash>)
114
+ # @param [Hash] options
115
+ # * +:instance_profile_name+ - *required* - (String) Name of the
116
+ # instance profile to create.
117
+ # * +:path+ - (String) The path to the instance profile. For more
118
+ # information about paths, see Identifiers for IAM Entities in Using
119
+ # AWS Identity and Access Management. This parameter is optional. If
120
+ # it is not included, it defaults to a slash (/).
121
+ # @return [Core::Response]
122
+ # The #data method of the response object returns
123
+ # a hash with the following structure:
124
+ # * +:instance_profile+ - (Hash)
175
125
  # * +:path+ - (String)
176
- # * +:role_name+ - (String)
177
- # * +:role_id+ - (String)
126
+ # * +:instance_profile_name+ - (String)
127
+ # * +:instance_profile_id+ - (String)
178
128
  # * +:arn+ - (String)
179
129
  # * +:create_date+ - (Time)
180
- # * +:assume_role_policy_document+ - (String)
181
- #
182
- # @return [Core::Response]
183
- #
130
+ # * +:roles+ - (Array<Hash>)
131
+ # * +:path+ - (String)
132
+ # * +:role_name+ - (String)
133
+ # * +:role_id+ - (String)
134
+ # * +:arn+ - (String)
135
+ # * +:create_date+ - (Time)
136
+ # * +:assume_role_policy_document+ - (String)
184
137
  define_client_method :create_instance_profile, 'CreateInstanceProfile'
185
138
 
186
139
  # Calls the CreateLoginProfile API operation.
187
140
  # @method create_login_profile(options = {})
188
- #
189
- # === Options:
190
- #
191
- # * +:user_name+ - *required* - (String) Name of the user to create a
192
- # password for.
193
- # * +:password+ - *required* - (String) The new password for the user
194
- # name.
195
- #
196
- # === Response Structure:
197
- #
198
- # * +:login_profile+ - (Hash)
199
- # * +:user_name+ - (String)
200
- # * +:create_date+ - (Time)
201
- #
202
- # @return [Core::Response]
203
- #
141
+ # @param [Hash] options
142
+ # * +:user_name+ - *required* - (String) Name of the user to create a
143
+ # password for.
144
+ # * +:password+ - *required* - (String) The new password for the user
145
+ # name.
146
+ # @return [Core::Response]
147
+ # The #data method of the response object returns
148
+ # a hash with the following structure:
149
+ # * +:login_profile+ - (Hash)
150
+ # * +:user_name+ - (String)
151
+ # * +:create_date+ - (Time)
204
152
  define_client_method :create_login_profile, 'CreateLoginProfile'
205
153
 
206
154
  # Calls the CreateRole API operation.
207
155
  # @method create_role(options = {})
208
- #
209
- # === Options:
210
- #
211
- # * +:path+ - (String) The path to the role. For more information about
212
- # paths, see Identifiers for IAM Entities in Using AWS Identity and
213
- # Access Management. This parameter is optional. If it is not included,
214
- # it defaults to a slash (/).
215
- # * +:role_name+ - *required* - (String) Name of the role to create.
216
- # * +:assume_role_policy_document+ - *required* - (String) The policy
217
- # govering by who and under what conditions the role can be assumed.
218
- #
219
- # === Response Structure:
220
- #
221
- # * +:role+ - (Hash)
222
- # * +:path+ - (String)
223
- # * +:role_name+ - (String)
224
- # * +:role_id+ - (String)
225
- # * +:arn+ - (String)
226
- # * +:create_date+ - (Time)
227
- # * +:assume_role_policy_document+ - (String)
228
- #
229
- # @return [Core::Response]
230
- #
156
+ # @param [Hash] options
157
+ # * +:path+ - (String) The path to the role. For more information about
158
+ # paths, see Identifiers for IAM Entities in Using AWS Identity and
159
+ # Access Management. This parameter is optional. If it is not
160
+ # included, it defaults to a slash (/).
161
+ # * +:role_name+ - *required* - (String) Name of the role to create.
162
+ # * +:assume_role_policy_document+ - *required* - (String) The policy
163
+ # govering by who and under what conditions the role can be assumed.
164
+ # @return [Core::Response]
165
+ # The #data method of the response object returns
166
+ # a hash with the following structure:
167
+ # * +:role+ - (Hash)
168
+ # * +:path+ - (String)
169
+ # * +:role_name+ - (String)
170
+ # * +:role_id+ - (String)
171
+ # * +:arn+ - (String)
172
+ # * +:create_date+ - (Time)
173
+ # * +:assume_role_policy_document+ - (String)
231
174
  define_client_method :create_role, 'CreateRole'
232
175
 
233
176
  # Calls the CreateUser API operation.
234
177
  # @method create_user(options = {})
235
- #
236
- # === Options:
237
- #
238
- # * +:path+ - (String) The path for the user name. For more information
239
- # about paths, see Identifiers for IAM Entities in Using AWS Identity
240
- # and Access Management. This parameter is optional. If it is not
241
- # included, it defaults to a slash (/).
242
- # * +:user_name+ - *required* - (String) Name of the user to create.
243
- #
244
- # === Response Structure:
245
- #
246
- # * +:user+ - (Hash)
247
- # * +:path+ - (String)
248
- # * +:user_name+ - (String)
249
- # * +:user_id+ - (String)
250
- # * +:arn+ - (String)
251
- # * +:create_date+ - (Time)
252
- #
253
- # @return [Core::Response]
254
- #
255
- define_client_method :create_user, 'CreateUser'
256
-
257
- # Calls the CreateVirtualMFADevice API operation.
258
- # @method create_virtual_mfa_device(options = {})
259
- #
260
- # === Options:
261
- #
262
- # * +:path+ - (String) The path for the virtual MFA device. For more
263
- # information about paths, see Identifiers for IAM Entities in Using
264
- # AWS Identity and Access Management. This parameter is optional. If it
265
- # is not included, it defaults to a slash (/).
266
- # * +:virtual_mfa_device_name+ - *required* - (String) The name of the
267
- # virtual MFA device. Use with path to uniquely identify a virtual MFA
268
- # device.
269
- #
270
- # === Response Structure:
271
- #
272
- # * +:virtual_mfa_device+ - (Hash)
273
- # * +:serial_number+ - (String)
274
- # * +:base_32_string_seed+ - (String)
275
- # * +:qr_code_png+ - (String)
178
+ # @param [Hash] options
179
+ # * +:path+ - (String) The path for the user name. For more information
180
+ # about paths, see Identifiers for IAM Entities in Using AWS Identity
181
+ # and Access Management. This parameter is optional. If it is not
182
+ # included, it defaults to a slash (/).
183
+ # * +:user_name+ - *required* - (String) Name of the user to create.
184
+ # @return [Core::Response]
185
+ # The #data method of the response object returns
186
+ # a hash with the following structure:
276
187
  # * +:user+ - (Hash)
277
188
  # * +:path+ - (String)
278
189
  # * +:user_name+ - (String)
279
190
  # * +:user_id+ - (String)
280
191
  # * +:arn+ - (String)
281
192
  # * +:create_date+ - (Time)
282
- # * +:enable_date+ - (Time)
283
- #
284
- # @return [Core::Response]
285
- #
193
+ define_client_method :create_user, 'CreateUser'
194
+
195
+ # Calls the CreateVirtualMFADevice API operation.
196
+ # @method create_virtual_mfa_device(options = {})
197
+ # @param [Hash] options
198
+ # * +:path+ - (String) The path for the virtual MFA device. For more
199
+ # information about paths, see Identifiers for IAM Entities in Using
200
+ # AWS Identity and Access Management. This parameter is optional. If
201
+ # it is not included, it defaults to a slash (/).
202
+ # * +:virtual_mfa_device_name+ - *required* - (String) The name of the
203
+ # virtual MFA device. Use with path to uniquely identify a virtual
204
+ # MFA device.
205
+ # @return [Core::Response]
206
+ # The #data method of the response object returns
207
+ # a hash with the following structure:
208
+ # * +:virtual_mfa_device+ - (Hash)
209
+ # * +:serial_number+ - (String)
210
+ # * +:base_32_string_seed+ - (String)
211
+ # * +:qr_code_png+ - (String)
212
+ # * +:user+ - (Hash)
213
+ # * +:path+ - (String)
214
+ # * +:user_name+ - (String)
215
+ # * +:user_id+ - (String)
216
+ # * +:arn+ - (String)
217
+ # * +:create_date+ - (Time)
218
+ # * +:enable_date+ - (Time)
286
219
  define_client_method :create_virtual_mfa_device, 'CreateVirtualMFADevice'
287
220
 
288
221
  # Calls the DeactivateMFADevice API operation.
289
222
  # @method deactivate_mfa_device(options = {})
290
- #
291
- # === Options:
292
- #
293
- # * +:user_name+ - *required* - (String) Name of the user whose MFA
294
- # device you want to deactivate.
295
- # * +:serial_number+ - *required* - (String) The serial number that
296
- # uniquely identifies the MFA device. For virtual MFA devices, the
297
- # serial number is the device ARN.
298
- #
299
- # === Response Structure:
300
- #
301
- # This method returns no response data.
302
- #
303
- # @return [Core::Response]
304
- #
223
+ # @param [Hash] options
224
+ # * +:user_name+ - *required* - (String) Name of the user whose MFA
225
+ # device you want to deactivate.
226
+ # * +:serial_number+ - *required* - (String) The serial number that
227
+ # uniquely identifies the MFA device. For virtual MFA devices, the
228
+ # serial number is the device ARN.
229
+ # @return [Core::Response]
305
230
  define_client_method :deactivate_mfa_device, 'DeactivateMFADevice'
306
231
 
307
232
  # Calls the DeleteAccessKey API operation.
308
233
  # @method delete_access_key(options = {})
309
- #
310
- # === Options:
311
- #
312
- # * +:user_name+ - (String) Name of the user whose key you want to
313
- # delete.
314
- # * +:access_key_id+ - *required* - (String) The Access Key ID for the
315
- # Access Key ID and Secret Access Key you want to delete.
316
- #
317
- # === Response Structure:
318
- #
319
- # This method returns no response data.
320
- #
321
- # @return [Core::Response]
322
- #
234
+ # @param [Hash] options
235
+ # * +:user_name+ - (String) Name of the user whose key you want to
236
+ # delete.
237
+ # * +:access_key_id+ - *required* - (String) The Access Key ID for the
238
+ # Access Key ID and Secret Access Key you want to delete.
239
+ # @return [Core::Response]
323
240
  define_client_method :delete_access_key, 'DeleteAccessKey'
324
241
 
325
242
  # Calls the DeleteAccountAlias API operation.
326
243
  # @method delete_account_alias(options = {})
327
- #
328
- # === Options:
329
- #
330
- # * +:account_alias+ - *required* - (String) Name of the account alias to
331
- # delete.
332
- #
333
- # === Response Structure:
334
- #
335
- # This method returns no response data.
336
- #
337
- # @return [Core::Response]
338
- #
244
+ # @param [Hash] options
245
+ # * +:account_alias+ - *required* - (String) Name of the account alias
246
+ # to delete.
247
+ # @return [Core::Response]
339
248
  define_client_method :delete_account_alias, 'DeleteAccountAlias'
340
249
 
341
250
  # Calls the DeleteAccountPasswordPolicy API operation.
342
251
  # @method delete_account_password_policy(options = {})
343
- #
344
- # === Options:
345
- #
346
- # This method accepts no options.
347
- #
348
- # === Response Structure:
349
- #
350
- # This method returns no response data.
351
- #
352
- # @return [Core::Response]
353
- #
252
+ # @param [Hash] options
253
+ # @return [Core::Response]
354
254
  define_client_method :delete_account_password_policy, 'DeleteAccountPasswordPolicy'
355
255
 
356
256
  # Calls the DeleteGroup API operation.
357
257
  # @method delete_group(options = {})
358
- #
359
- # === Options:
360
- #
361
- # * +:group_name+ - *required* - (String) Name of the group to delete.
362
- #
363
- # === Response Structure:
364
- #
365
- # This method returns no response data.
366
- #
367
- # @return [Core::Response]
368
- #
258
+ # @param [Hash] options
259
+ # * +:group_name+ - *required* - (String) Name of the group to delete.
260
+ # @return [Core::Response]
369
261
  define_client_method :delete_group, 'DeleteGroup'
370
262
 
371
263
  # Calls the DeleteGroupPolicy API operation.
372
264
  # @method delete_group_policy(options = {})
373
- #
374
- # === Options:
375
- #
376
- # * +:group_name+ - *required* - (String) Name of the group the policy is
377
- # associated with.
378
- # * +:policy_name+ - *required* - (String) Name of the policy document to
379
- # delete.
380
- #
381
- # === Response Structure:
382
- #
383
- # This method returns no response data.
384
- #
385
- # @return [Core::Response]
386
- #
265
+ # @param [Hash] options
266
+ # * +:group_name+ - *required* - (String) Name of the group the policy
267
+ # is associated with.
268
+ # * +:policy_name+ - *required* - (String) Name of the policy document
269
+ # to delete.
270
+ # @return [Core::Response]
387
271
  define_client_method :delete_group_policy, 'DeleteGroupPolicy'
388
272
 
389
273
  # Calls the DeleteInstanceProfile API operation.
390
274
  # @method delete_instance_profile(options = {})
391
- #
392
- # === Options:
393
- #
394
- # * +:instance_profile_name+ - *required* - (String) Name of the instance
395
- # profile to delete.
396
- #
397
- # === Response Structure:
398
- #
399
- # This method returns no response data.
400
- #
401
- # @return [Core::Response]
402
- #
275
+ # @param [Hash] options
276
+ # * +:instance_profile_name+ - *required* - (String) Name of the
277
+ # instance profile to delete.
278
+ # @return [Core::Response]
403
279
  define_client_method :delete_instance_profile, 'DeleteInstanceProfile'
404
280
 
405
281
  # Calls the DeleteLoginProfile API operation.
406
282
  # @method delete_login_profile(options = {})
407
- #
408
- # === Options:
409
- #
410
- # * +:user_name+ - *required* - (String) Name of the user whose password
411
- # you want to delete.
412
- #
413
- # === Response Structure:
414
- #
415
- # This method returns no response data.
416
- #
417
- # @return [Core::Response]
418
- #
283
+ # @param [Hash] options
284
+ # * +:user_name+ - *required* - (String) Name of the user whose
285
+ # password you want to delete.
286
+ # @return [Core::Response]
419
287
  define_client_method :delete_login_profile, 'DeleteLoginProfile'
420
288
 
421
289
  # Calls the DeleteRole API operation.
422
290
  # @method delete_role(options = {})
423
- #
424
- # === Options:
425
- #
426
- # * +:role_name+ - *required* - (String) Name of the role to delete.
427
- #
428
- # === Response Structure:
429
- #
430
- # This method returns no response data.
431
- #
432
- # @return [Core::Response]
433
- #
291
+ # @param [Hash] options
292
+ # * +:role_name+ - *required* - (String) Name of the role to delete.
293
+ # @return [Core::Response]
434
294
  define_client_method :delete_role, 'DeleteRole'
435
295
 
436
296
  # Calls the DeleteRolePolicy API operation.
437
297
  # @method delete_role_policy(options = {})
438
- #
439
- # === Options:
440
- #
441
- # * +:role_name+ - *required* - (String) Name of the role the policy is
442
- # associated with.
443
- # * +:policy_name+ - *required* - (String) Name of the policy document to
444
- # delete.
445
- #
446
- # === Response Structure:
447
- #
448
- # This method returns no response data.
449
- #
450
- # @return [Core::Response]
451
- #
298
+ # @param [Hash] options
299
+ # * +:role_name+ - *required* - (String) Name of the role the policy is
300
+ # associated with.
301
+ # * +:policy_name+ - *required* - (String) Name of the policy document
302
+ # to delete.
303
+ # @return [Core::Response]
452
304
  define_client_method :delete_role_policy, 'DeleteRolePolicy'
453
305
 
454
306
  # Calls the DeleteServerCertificate API operation.
455
307
  # @method delete_server_certificate(options = {})
456
- #
457
- # === Options:
458
- #
459
- # * +:server_certificate_name+ - *required* - (String) The name of the
460
- # server certificate you want to delete.
461
- #
462
- # === Response Structure:
463
- #
464
- # This method returns no response data.
465
- #
466
- # @return [Core::Response]
467
- #
308
+ # @param [Hash] options
309
+ # * +:server_certificate_name+ - *required* - (String) The name of the
310
+ # server certificate you want to delete.
311
+ # @return [Core::Response]
468
312
  define_client_method :delete_server_certificate, 'DeleteServerCertificate'
469
313
 
470
314
  # Calls the DeleteSigningCertificate API operation.
471
315
  # @method delete_signing_certificate(options = {})
472
- #
473
- # === Options:
474
- #
475
- # * +:user_name+ - (String) Name of the user the signing certificate
476
- # belongs to.
477
- # * +:certificate_id+ - *required* - (String) ID of the signing
478
- # certificate to delete.
479
- #
480
- # === Response Structure:
481
- #
482
- # This method returns no response data.
483
- #
484
- # @return [Core::Response]
485
- #
316
+ # @param [Hash] options
317
+ # * +:user_name+ - (String) Name of the user the signing certificate
318
+ # belongs to.
319
+ # * +:certificate_id+ - *required* - (String) ID of the signing
320
+ # certificate to delete.
321
+ # @return [Core::Response]
486
322
  define_client_method :delete_signing_certificate, 'DeleteSigningCertificate'
487
323
 
488
324
  # Calls the DeleteUser API operation.
489
325
  # @method delete_user(options = {})
490
- #
491
- # === Options:
492
- #
493
- # * +:user_name+ - *required* - (String) Name of the user to delete.
494
- #
495
- # === Response Structure:
496
- #
497
- # This method returns no response data.
498
- #
499
- # @return [Core::Response]
500
- #
326
+ # @param [Hash] options
327
+ # * +:user_name+ - *required* - (String) Name of the user to delete.
328
+ # @return [Core::Response]
501
329
  define_client_method :delete_user, 'DeleteUser'
502
330
 
503
331
  # Calls the DeleteUserPolicy API operation.
504
332
  # @method delete_user_policy(options = {})
505
- #
506
- # === Options:
507
- #
508
- # * +:user_name+ - *required* - (String) Name of the user the policy is
509
- # associated with.
510
- # * +:policy_name+ - *required* - (String) Name of the policy document to
511
- # delete.
512
- #
513
- # === Response Structure:
514
- #
515
- # This method returns no response data.
516
- #
517
- # @return [Core::Response]
518
- #
333
+ # @param [Hash] options
334
+ # * +:user_name+ - *required* - (String) Name of the user the policy is
335
+ # associated with.
336
+ # * +:policy_name+ - *required* - (String) Name of the policy document
337
+ # to delete.
338
+ # @return [Core::Response]
519
339
  define_client_method :delete_user_policy, 'DeleteUserPolicy'
520
340
 
521
341
  # Calls the DeleteVirtualMFADevice API operation.
522
342
  # @method delete_virtual_mfa_device(options = {})
523
- #
524
- # === Options:
525
- #
526
- # * +:serial_number+ - *required* - (String) The serial number that
527
- # uniquely identifies the MFA device. For virtual MFA devices, the
528
- # serial number is the same as the ARN.
529
- #
530
- # === Response Structure:
531
- #
532
- # This method returns no response data.
533
- #
534
- # @return [Core::Response]
535
- #
343
+ # @param [Hash] options
344
+ # * +:serial_number+ - *required* - (String) The serial number that
345
+ # uniquely identifies the MFA device. For virtual MFA devices, the
346
+ # serial number is the same as the ARN.
347
+ # @return [Core::Response]
536
348
  define_client_method :delete_virtual_mfa_device, 'DeleteVirtualMFADevice'
537
349
 
538
350
  # Calls the EnableMFADevice API operation.
539
351
  # @method enable_mfa_device(options = {})
540
- #
541
- # === Options:
542
- #
543
- # * +:user_name+ - *required* - (String) Name of the user for whom you
544
- # want to enable the MFA device.
545
- # * +:serial_number+ - *required* - (String) The serial number that
546
- # uniquely identifies the MFA device. For virtual MFA devices, the
547
- # serial number is the device ARN.
548
- # * +:authentication_code_1+ - *required* - (String) An authentication
549
- # code emitted by the device.
550
- # * +:authentication_code_2+ - *required* - (String) A subsequent
551
- # authentication code emitted by the device.
552
- #
553
- # === Response Structure:
554
- #
555
- # This method returns no response data.
556
- #
557
- # @return [Core::Response]
558
- #
352
+ # @param [Hash] options
353
+ # * +:user_name+ - *required* - (String) Name of the user for whom you
354
+ # want to enable the MFA device.
355
+ # * +:serial_number+ - *required* - (String) The serial number that
356
+ # uniquely identifies the MFA device. For virtual MFA devices, the
357
+ # serial number is the device ARN.
358
+ # * +:authentication_code_1+ - *required* - (String) An authentication
359
+ # code emitted by the device.
360
+ # * +:authentication_code_2+ - *required* - (String) A subsequent
361
+ # authentication code emitted by the device.
362
+ # @return [Core::Response]
559
363
  define_client_method :enable_mfa_device, 'EnableMFADevice'
560
364
 
561
365
  # Calls the GetAccountPasswordPolicy API operation.
562
366
  # @method get_account_password_policy(options = {})
563
- #
564
- # === Options:
565
- #
566
- # This method accepts no options.
567
- #
568
- # === Response Structure:
569
- #
570
- # * +:password_policy+ - (Hash)
571
- # * +:minimum_password_length+ - (Integer)
572
- # * +:require_symbols+ - (Boolean)
573
- # * +:require_numbers+ - (Boolean)
574
- # * +:require_uppercase_characters+ - (Boolean)
575
- # * +:require_lowercase_characters+ - (Boolean)
576
- # * +:allow_users_to_change_password+ - (Boolean)
577
- #
578
- # @return [Core::Response]
579
- #
367
+ # @param [Hash] options
368
+ # @return [Core::Response]
369
+ # The #data method of the response object returns
370
+ # a hash with the following structure:
371
+ # * +:password_policy+ - (Hash)
372
+ # * +:minimum_password_length+ - (Integer)
373
+ # * +:require_symbols+ - (Boolean)
374
+ # * +:require_numbers+ - (Boolean)
375
+ # * +:require_uppercase_characters+ - (Boolean)
376
+ # * +:require_lowercase_characters+ - (Boolean)
377
+ # * +:allow_users_to_change_password+ - (Boolean)
580
378
  define_client_method :get_account_password_policy, 'GetAccountPasswordPolicy'
581
379
 
582
380
  # Calls the GetAccountSummary API operation.
583
381
  # @method get_account_summary(options = {})
584
- #
585
- # === Options:
586
- #
587
- # This method accepts no options.
588
- #
589
- # === Response Structure:
590
- #
591
- # * +:summary_map+ - (Hash<String,Integer>)
592
- #
593
- # @return [Core::Response]
594
- #
382
+ # @param [Hash] options
383
+ # @return [Core::Response]
384
+ # The #data method of the response object returns
385
+ # a hash with the following structure:
386
+ # * +:summary_map+ - (Hash<String,Integer>)
595
387
  define_client_method :get_account_summary, 'GetAccountSummary'
596
388
 
597
389
  # Calls the GetGroup API operation.
598
390
  # @method get_group(options = {})
599
- #
600
- # === Options:
601
- #
602
- # * +:group_name+ - *required* - (String) Name of the group.
603
- # * +:marker+ - (String) Use this only when paginating results, and only
604
- # in a subsequent request after you've received a response where the
605
- # results are truncated. Set it to the value of the Marker element in
606
- # the response you just received.
607
- # * +:max_items+ - (Integer) Use this only when paginating results to
608
- # indicate the maximum number of user names you want in the response.
609
- # If there are additional user names beyond the maximum you specify,
610
- # the IsTruncated response element is +true+ .
611
- #
612
- # === Response Structure:
613
- #
614
- # * +:group+ - (Hash)
615
- # * +:path+ - (String)
616
- # * +:group_name+ - (String)
617
- # * +:group_id+ - (String)
618
- # * +:arn+ - (String)
619
- # * +:create_date+ - (Time)
620
- # * +:users+ - (Array<Hash>)
621
- # * +:path+ - (String)
622
- # * +:user_name+ - (String)
623
- # * +:user_id+ - (String)
624
- # * +:arn+ - (String)
625
- # * +:create_date+ - (Time)
626
- # * +:is_truncated+ - (Boolean)
627
- # * +:marker+ - (String)
628
- #
629
- # @return [Core::Response]
630
- #
391
+ # @param [Hash] options
392
+ # * +:group_name+ - *required* - (String) Name of the group.
393
+ # * +:marker+ - (String) Use this only when paginating results, and
394
+ # only in a subsequent request after you've received a response where
395
+ # the results are truncated. Set it to the value of the Marker
396
+ # element in the response you just received.
397
+ # * +:max_items+ - (Integer) Use this only when paginating results to
398
+ # indicate the maximum number of user names you want in the response.
399
+ # If there are additional user names beyond the maximum you specify,
400
+ # the IsTruncated response element is +true+ .
401
+ # @return [Core::Response]
402
+ # The #data method of the response object returns
403
+ # a hash with the following structure:
404
+ # * +:group+ - (Hash)
405
+ # * +:path+ - (String)
406
+ # * +:group_name+ - (String)
407
+ # * +:group_id+ - (String)
408
+ # * +:arn+ - (String)
409
+ # * +:create_date+ - (Time)
410
+ # * +:users+ - (Array<Hash>)
411
+ # * +:path+ - (String)
412
+ # * +:user_name+ - (String)
413
+ # * +:user_id+ - (String)
414
+ # * +:arn+ - (String)
415
+ # * +:create_date+ - (Time)
416
+ # * +:is_truncated+ - (Boolean)
417
+ # * +:marker+ - (String)
631
418
  define_client_method :get_group, 'GetGroup'
632
419
 
633
420
  # Calls the GetGroupPolicy API operation.
634
421
  # @method get_group_policy(options = {})
635
- #
636
- # === Options:
637
- #
638
- # * +:group_name+ - *required* - (String) Name of the group the policy is
639
- # associated with.
640
- # * +:policy_name+ - *required* - (String) Name of the policy document to
641
- # get.
642
- #
643
- # === Response Structure:
644
- #
645
- # * +:group_name+ - (String)
646
- # * +:policy_name+ - (String)
647
- # * +:policy_document+ - (String)
648
- #
649
- # @return [Core::Response]
650
- #
422
+ # @param [Hash] options
423
+ # * +:group_name+ - *required* - (String) Name of the group the policy
424
+ # is associated with.
425
+ # * +:policy_name+ - *required* - (String) Name of the policy document
426
+ # to get.
427
+ # @return [Core::Response]
428
+ # The #data method of the response object returns
429
+ # a hash with the following structure:
430
+ # * +:group_name+ - (String)
431
+ # * +:policy_name+ - (String)
432
+ # * +:policy_document+ - (String)
651
433
  define_client_method :get_group_policy, 'GetGroupPolicy'
652
434
 
653
435
  # Calls the GetInstanceProfile API operation.
654
436
  # @method get_instance_profile(options = {})
655
- #
656
- # === Options:
657
- #
658
- # * +:instance_profile_name+ - *required* - (String) Name of the instance
659
- # profile to get information about.
660
- #
661
- # === Response Structure:
662
- #
663
- # * +:instance_profile+ - (Hash)
664
- # * +:path+ - (String)
665
- # * +:instance_profile_name+ - (String)
666
- # * +:instance_profile_id+ - (String)
667
- # * +:arn+ - (String)
668
- # * +:create_date+ - (Time)
669
- # * +:roles+ - (Array<Hash>)
437
+ # @param [Hash] options
438
+ # * +:instance_profile_name+ - *required* - (String) Name of the
439
+ # instance profile to get information about.
440
+ # @return [Core::Response]
441
+ # The #data method of the response object returns
442
+ # a hash with the following structure:
443
+ # * +:instance_profile+ - (Hash)
670
444
  # * +:path+ - (String)
671
- # * +:role_name+ - (String)
672
- # * +:role_id+ - (String)
445
+ # * +:instance_profile_name+ - (String)
446
+ # * +:instance_profile_id+ - (String)
673
447
  # * +:arn+ - (String)
674
448
  # * +:create_date+ - (Time)
675
- # * +:assume_role_policy_document+ - (String)
676
- #
677
- # @return [Core::Response]
678
- #
449
+ # * +:roles+ - (Array<Hash>)
450
+ # * +:path+ - (String)
451
+ # * +:role_name+ - (String)
452
+ # * +:role_id+ - (String)
453
+ # * +:arn+ - (String)
454
+ # * +:create_date+ - (Time)
455
+ # * +:assume_role_policy_document+ - (String)
679
456
  define_client_method :get_instance_profile, 'GetInstanceProfile'
680
457
 
681
458
  # Calls the GetLoginProfile API operation.
682
459
  # @method get_login_profile(options = {})
683
- #
684
- # === Options:
685
- #
686
- # * +:user_name+ - *required* - (String) Name of the user whose login
687
- # profile you want to retrieve.
688
- #
689
- # === Response Structure:
690
- #
691
- # * +:login_profile+ - (Hash)
692
- # * +:user_name+ - (String)
693
- # * +:create_date+ - (Time)
694
- #
460
+ # @param [Hash] options
461
+ # * +:user_name+ - *required* - (String) Name of the user whose login
462
+ # profile you want to retrieve.
695
463
  # @return [Core::Response]
696
- #
464
+ # The #data method of the response object returns
465
+ # a hash with the following structure:
466
+ # * +:login_profile+ - (Hash)
467
+ # * +:user_name+ - (String)
468
+ # * +:create_date+ - (Time)
697
469
  define_client_method :get_login_profile, 'GetLoginProfile'
698
470
 
699
471
  # Calls the GetRole API operation.
700
472
  # @method get_role(options = {})
701
- #
702
- # === Options:
703
- #
704
- # * +:role_name+ - *required* - (String) Name of the role to get
705
- # information about.
706
- #
707
- # === Response Structure:
708
- #
709
- # * +:role+ - (Hash)
710
- # * +:path+ - (String)
711
- # * +:role_name+ - (String)
712
- # * +:role_id+ - (String)
713
- # * +:arn+ - (String)
714
- # * +:create_date+ - (Time)
715
- # * +:assume_role_policy_document+ - (String)
716
- #
473
+ # @param [Hash] options
474
+ # * +:role_name+ - *required* - (String) Name of the role to get
475
+ # information about.
717
476
  # @return [Core::Response]
718
- #
477
+ # The #data method of the response object returns
478
+ # a hash with the following structure:
479
+ # * +:role+ - (Hash)
480
+ # * +:path+ - (String)
481
+ # * +:role_name+ - (String)
482
+ # * +:role_id+ - (String)
483
+ # * +:arn+ - (String)
484
+ # * +:create_date+ - (Time)
485
+ # * +:assume_role_policy_document+ - (String)
719
486
  define_client_method :get_role, 'GetRole'
720
487
 
721
488
  # Calls the GetRolePolicy API operation.
722
489
  # @method get_role_policy(options = {})
723
- #
724
- # === Options:
725
- #
726
- # * +:role_name+ - *required* - (String) Name of the role who the policy
727
- # is associated with.
728
- # * +:policy_name+ - *required* - (String) Name of the policy document to
729
- # get.
730
- #
731
- # === Response Structure:
732
- #
733
- # * +:role_name+ - (String)
734
- # * +:policy_name+ - (String)
735
- # * +:policy_document+ - (String)
736
- #
737
- # @return [Core::Response]
738
- #
490
+ # @param [Hash] options
491
+ # * +:role_name+ - *required* - (String) Name of the role who the
492
+ # policy is associated with.
493
+ # * +:policy_name+ - *required* - (String) Name of the policy document
494
+ # to get.
495
+ # @return [Core::Response]
496
+ # The #data method of the response object returns
497
+ # a hash with the following structure:
498
+ # * +:role_name+ - (String)
499
+ # * +:policy_name+ - (String)
500
+ # * +:policy_document+ - (String)
739
501
  define_client_method :get_role_policy, 'GetRolePolicy'
740
502
 
741
503
  # Calls the GetServerCertificate API operation.
742
504
  # @method get_server_certificate(options = {})
743
- #
744
- # === Options:
745
- #
746
- # * +:server_certificate_name+ - *required* - (String) The name of the
747
- # server certificate you want to retrieve information about.
748
- #
749
- # === Response Structure:
750
- #
751
- # * +:server_certificate+ - (Hash)
752
- # * +:server_certificate_metadata+ - (Hash)
753
- # * +:path+ - (String)
754
- # * +:server_certificate_name+ - (String)
755
- # * +:server_certificate_id+ - (String)
756
- # * +:arn+ - (String)
757
- # * +:upload_date+ - (Time)
758
- # * +:certificate_body+ - (String)
759
- # * +:certificate_chain+ - (String)
760
- #
761
- # @return [Core::Response]
762
- #
505
+ # @param [Hash] options
506
+ # * +:server_certificate_name+ - *required* - (String) The name of the
507
+ # server certificate you want to retrieve information about.
508
+ # @return [Core::Response]
509
+ # The #data method of the response object returns
510
+ # a hash with the following structure:
511
+ # * +:server_certificate+ - (Hash)
512
+ # * +:server_certificate_metadata+ - (Hash)
513
+ # * +:path+ - (String)
514
+ # * +:server_certificate_name+ - (String)
515
+ # * +:server_certificate_id+ - (String)
516
+ # * +:arn+ - (String)
517
+ # * +:upload_date+ - (Time)
518
+ # * +:certificate_body+ - (String)
519
+ # * +:certificate_chain+ - (String)
763
520
  define_client_method :get_server_certificate, 'GetServerCertificate'
764
521
 
765
522
  # Calls the GetUser API operation.
766
523
  # @method get_user(options = {})
767
- #
768
- # === Options:
769
- #
770
- # * +:user_name+ - (String) Name of the user to get information about.
771
- # This parameter is optional. If it is not included, it defaults to the
772
- # user making the request.
773
- #
774
- # === Response Structure:
775
- #
776
- # * +:user+ - (Hash)
777
- # * +:path+ - (String)
778
- # * +:user_name+ - (String)
779
- # * +:user_id+ - (String)
780
- # * +:arn+ - (String)
781
- # * +:create_date+ - (Time)
782
- #
524
+ # @param [Hash] options
525
+ # * +:user_name+ - (String) Name of the user to get information about.
526
+ # This parameter is optional. If it is not included, it defaults to
527
+ # the user making the request.
783
528
  # @return [Core::Response]
784
- #
529
+ # The #data method of the response object returns
530
+ # a hash with the following structure:
531
+ # * +:user+ - (Hash)
532
+ # * +:path+ - (String)
533
+ # * +:user_name+ - (String)
534
+ # * +:user_id+ - (String)
535
+ # * +:arn+ - (String)
536
+ # * +:create_date+ - (Time)
785
537
  define_client_method :get_user, 'GetUser'
786
538
 
787
539
  # Calls the GetUserPolicy API operation.
788
540
  # @method get_user_policy(options = {})
789
- #
790
- # === Options:
791
- #
792
- # * +:user_name+ - *required* - (String) Name of the user who the policy
793
- # is associated with.
794
- # * +:policy_name+ - *required* - (String) Name of the policy document to
795
- # get.
796
- #
797
- # === Response Structure:
798
- #
799
- # * +:user_name+ - (String)
800
- # * +:policy_name+ - (String)
801
- # * +:policy_document+ - (String)
802
- #
803
- # @return [Core::Response]
804
- #
541
+ # @param [Hash] options
542
+ # * +:user_name+ - *required* - (String) Name of the user who the
543
+ # policy is associated with.
544
+ # * +:policy_name+ - *required* - (String) Name of the policy document
545
+ # to get.
546
+ # @return [Core::Response]
547
+ # The #data method of the response object returns
548
+ # a hash with the following structure:
549
+ # * +:user_name+ - (String)
550
+ # * +:policy_name+ - (String)
551
+ # * +:policy_document+ - (String)
805
552
  define_client_method :get_user_policy, 'GetUserPolicy'
806
553
 
807
554
  # Calls the ListAccessKeys API operation.
808
555
  # @method list_access_keys(options = {})
809
- #
810
- # === Options:
811
- #
812
- # * +:user_name+ - (String) Name of the user.
813
- # * +:marker+ - (String) Use this parameter only when paginating results,
814
- # and only in a subsequent request after you've received a response
815
- # where the results are truncated. Set it to the value of the Marker
816
- # element in the response you just received.
817
- # * +:max_items+ - (Integer) Use this parameter only when paginating
818
- # results to indicate the maximum number of keys you want in the
819
- # response. If there are additional keys beyond the maximum you
820
- # specify, the IsTruncated response element is +true+ .
821
- #
822
- # === Response Structure:
823
- #
824
- # * +:access_key_metadata+ - (Array<Hash>)
825
- # * +:user_name+ - (String)
826
- # * +:access_key_id+ - (String)
827
- # * +:status+ - (String)
828
- # * +:create_date+ - (Time)
829
- # * +:is_truncated+ - (Boolean)
830
- # * +:marker+ - (String)
831
- #
832
- # @return [Core::Response]
833
- #
556
+ # @param [Hash] options
557
+ # * +:user_name+ - (String) Name of the user.
558
+ # * +:marker+ - (String) Use this parameter only when paginating
559
+ # results, and only in a subsequent request after you've received a
560
+ # response where the results are truncated. Set it to the value of
561
+ # the Marker element in the response you just received.
562
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
563
+ # results to indicate the maximum number of keys you want in the
564
+ # response. If there are additional keys beyond the maximum you
565
+ # specify, the IsTruncated response element is +true+ .
566
+ # @return [Core::Response]
567
+ # The #data method of the response object returns
568
+ # a hash with the following structure:
569
+ # * +:access_key_metadata+ - (Array<Hash>)
570
+ # * +:user_name+ - (String)
571
+ # * +:access_key_id+ - (String)
572
+ # * +:status+ - (String)
573
+ # * +:create_date+ - (Time)
574
+ # * +:is_truncated+ - (Boolean)
575
+ # * +:marker+ - (String)
834
576
  define_client_method :list_access_keys, 'ListAccessKeys'
835
577
 
836
578
  # Calls the ListAccountAliases API operation.
837
579
  # @method list_account_aliases(options = {})
838
- #
839
- # === Options:
840
- #
841
- # * +:marker+ - (String) Use this only when paginating results, and only
842
- # in a subsequent request after you've received a response where the
843
- # results are truncated. Set it to the value of the Marker element in
844
- # the response you just received.
845
- # * +:max_items+ - (Integer) Use this only when paginating results to
846
- # indicate the maximum number of account aliases you want in the
847
- # response. If there are additional account aliases beyond the maximum
848
- # you specify, the IsTruncated response element is +true+ .
849
- #
850
- # === Response Structure:
851
- #
852
- # * +:account_aliases+ - (Array<String>)
853
- # * +:is_truncated+ - (Boolean)
854
- # * +:marker+ - (String)
855
- #
856
- # @return [Core::Response]
857
- #
580
+ # @param [Hash] options
581
+ # * +:marker+ - (String) Use this only when paginating results, and
582
+ # only in a subsequent request after you've received a response where
583
+ # the results are truncated. Set it to the value of the Marker
584
+ # element in the response you just received.
585
+ # * +:max_items+ - (Integer) Use this only when paginating results to
586
+ # indicate the maximum number of account aliases you want in the
587
+ # response. If there are additional account aliases beyond the
588
+ # maximum you specify, the IsTruncated response element is +true+ .
589
+ # @return [Core::Response]
590
+ # The #data method of the response object returns
591
+ # a hash with the following structure:
592
+ # * +:account_aliases+ - (Array<String>)
593
+ # * +:is_truncated+ - (Boolean)
594
+ # * +:marker+ - (String)
858
595
  define_client_method :list_account_aliases, 'ListAccountAliases'
859
596
 
860
597
  # Calls the ListGroupPolicies API operation.
861
598
  # @method list_group_policies(options = {})
862
- #
863
- # === Options:
864
- #
865
- # * +:group_name+ - *required* - (String) The name of the group to list
866
- # policies for.
867
- # * +:marker+ - (String) Use this only when paginating results, and only
868
- # in a subsequent request after you've received a response where the
869
- # results are truncated. Set it to the value of the Marker element in
870
- # the response you just received.
871
- # * +:max_items+ - (Integer) Use this only when paginating results to
872
- # indicate the maximum number of policy names you want in the response.
873
- # If there are additional policy names beyond the maximum you specify,
874
- # the IsTruncated response element is +true+ .
875
- #
876
- # === Response Structure:
877
- #
878
- # * +:policy_names+ - (Array<String>)
879
- # * +:is_truncated+ - (Boolean)
880
- # * +:marker+ - (String)
881
- #
882
- # @return [Core::Response]
883
- #
599
+ # @param [Hash] options
600
+ # * +:group_name+ - *required* - (String) The name of the group to list
601
+ # policies for.
602
+ # * +:marker+ - (String) Use this only when paginating results, and
603
+ # only in a subsequent request after you've received a response where
604
+ # the results are truncated. Set it to the value of the Marker
605
+ # element in the response you just received.
606
+ # * +:max_items+ - (Integer) Use this only when paginating results to
607
+ # indicate the maximum number of policy names you want in the
608
+ # response. If there are additional policy names beyond the maximum
609
+ # you specify, the IsTruncated response element is +true+ .
610
+ # @return [Core::Response]
611
+ # The #data method of the response object returns
612
+ # a hash with the following structure:
613
+ # * +:policy_names+ - (Array<String>)
614
+ # * +:is_truncated+ - (Boolean)
615
+ # * +:marker+ - (String)
884
616
  define_client_method :list_group_policies, 'ListGroupPolicies'
885
617
 
886
618
  # Calls the ListGroups API operation.
887
619
  # @method list_groups(options = {})
888
- #
889
- # === Options:
890
- #
891
- # * +:path_prefix+ - (String) The path prefix for filtering the results.
892
- # For example: /division_abc/subdivision_xyz/, which would get all
893
- # groups whose path starts with /division_abc/subdivision_xyz/. This
894
- # parameter is optional. If it is not included, it defaults to a slash
895
- # (/), listing all groups.
896
- # * +:marker+ - (String) Use this only when paginating results, and only
897
- # in a subsequent request after you've received a response where the
898
- # results are truncated. Set it to the value of the Marker element in
899
- # the response you just received.
900
- # * +:max_items+ - (Integer) Use this only when paginating results to
901
- # indicate the maximum number of groups you want in the response. If
902
- # there are additional groups beyond the maximum you specify, the
903
- # IsTruncated response element is +true+ .
904
- #
905
- # === Response Structure:
906
- #
907
- # * +:groups+ - (Array<Hash>)
908
- # * +:path+ - (String)
909
- # * +:group_name+ - (String)
910
- # * +:group_id+ - (String)
911
- # * +:arn+ - (String)
912
- # * +:create_date+ - (Time)
913
- # * +:is_truncated+ - (Boolean)
914
- # * +:marker+ - (String)
915
- #
916
- # @return [Core::Response]
917
- #
620
+ # @param [Hash] options
621
+ # * +:path_prefix+ - (String) The path prefix for filtering the
622
+ # results. For example: /division_abc/subdivision_xyz/, which would
623
+ # get all groups whose path starts with
624
+ # /division_abc/subdivision_xyz/. This parameter is optional. If it
625
+ # is not included, it defaults to a slash (/), listing all groups.
626
+ # * +:marker+ - (String) Use this only when paginating results, and
627
+ # only in a subsequent request after you've received a response where
628
+ # the results are truncated. Set it to the value of the Marker
629
+ # element in the response you just received.
630
+ # * +:max_items+ - (Integer) Use this only when paginating results to
631
+ # indicate the maximum number of groups you want in the response. If
632
+ # there are additional groups beyond the maximum you specify, the
633
+ # IsTruncated response element is +true+ .
634
+ # @return [Core::Response]
635
+ # The #data method of the response object returns
636
+ # a hash with the following structure:
637
+ # * +:groups+ - (Array<Hash>)
638
+ # * +:path+ - (String)
639
+ # * +:group_name+ - (String)
640
+ # * +:group_id+ - (String)
641
+ # * +:arn+ - (String)
642
+ # * +:create_date+ - (Time)
643
+ # * +:is_truncated+ - (Boolean)
644
+ # * +:marker+ - (String)
918
645
  define_client_method :list_groups, 'ListGroups'
919
646
 
920
647
  # Calls the ListGroupsForUser API operation.
921
648
  # @method list_groups_for_user(options = {})
922
- #
923
- # === Options:
924
- #
925
- # * +:user_name+ - *required* - (String) The name of the user to list
926
- # groups for.
927
- # * +:marker+ - (String) Use this only when paginating results, and only
928
- # in a subsequent request after you've received a response where the
929
- # results are truncated. Set it to the value of the Marker element in
930
- # the response you just received.
931
- # * +:max_items+ - (Integer) Use this only when paginating results to
932
- # indicate the maximum number of groups you want in the response. If
933
- # there are additional groups beyond the maximum you specify, the
934
- # IsTruncated response element is +true+ .
935
- #
936
- # === Response Structure:
937
- #
938
- # * +:groups+ - (Array<Hash>)
939
- # * +:path+ - (String)
940
- # * +:group_name+ - (String)
941
- # * +:group_id+ - (String)
942
- # * +:arn+ - (String)
943
- # * +:create_date+ - (Time)
944
- # * +:is_truncated+ - (Boolean)
945
- # * +:marker+ - (String)
946
- #
947
- # @return [Core::Response]
948
- #
649
+ # @param [Hash] options
650
+ # * +:user_name+ - *required* - (String) The name of the user to list
651
+ # groups for.
652
+ # * +:marker+ - (String) Use this only when paginating results, and
653
+ # only in a subsequent request after you've received a response where
654
+ # the results are truncated. Set it to the value of the Marker
655
+ # element in the response you just received.
656
+ # * +:max_items+ - (Integer) Use this only when paginating results to
657
+ # indicate the maximum number of groups you want in the response. If
658
+ # there are additional groups beyond the maximum you specify, the
659
+ # IsTruncated response element is +true+ .
660
+ # @return [Core::Response]
661
+ # The #data method of the response object returns
662
+ # a hash with the following structure:
663
+ # * +:groups+ - (Array<Hash>)
664
+ # * +:path+ - (String)
665
+ # * +:group_name+ - (String)
666
+ # * +:group_id+ - (String)
667
+ # * +:arn+ - (String)
668
+ # * +:create_date+ - (Time)
669
+ # * +:is_truncated+ - (Boolean)
670
+ # * +:marker+ - (String)
949
671
  define_client_method :list_groups_for_user, 'ListGroupsForUser'
950
672
 
951
673
  # Calls the ListInstanceProfiles API operation.
952
674
  # @method list_instance_profiles(options = {})
953
- #
954
- # === Options:
955
- #
956
- # * +:path_prefix+ - (String) The path prefix for filtering the results.
957
- # For example: /application_abc/component_xyz/, which would get all
958
- # instance profiles whose path starts with
959
- # /application_abc/component_xyz/. This parameter is optional. If it is
960
- # not included, it defaults to a slash (/), listing all instance
961
- # profiles.
962
- # * +:marker+ - (String) Use this parameter only when paginating results,
963
- # and only in a subsequent request after you've received a response
964
- # where the results are truncated. Set it to the value of the Marker
965
- # element in the response you just received.
966
- # * +:max_items+ - (Integer) Use this parameter only when paginating
967
- # results to indicate the maximum number of user names you want in the
968
- # response. If there are additional user names beyond the maximum you
969
- # specify, the IsTruncated response element is +true+ .
970
- #
971
- # === Response Structure:
972
- #
973
- # * +:instance_profiles+ - (Array<Hash>)
974
- # * +:path+ - (String)
975
- # * +:instance_profile_name+ - (String)
976
- # * +:instance_profile_id+ - (String)
977
- # * +:arn+ - (String)
978
- # * +:create_date+ - (Time)
979
- # * +:roles+ - (Array<Hash>)
675
+ # @param [Hash] options
676
+ # * +:path_prefix+ - (String) The path prefix for filtering the
677
+ # results. For example: /application_abc/component_xyz/, which would
678
+ # get all instance profiles whose path starts with
679
+ # /application_abc/component_xyz/. This parameter is optional. If it
680
+ # is not included, it defaults to a slash (/), listing all instance
681
+ # profiles.
682
+ # * +:marker+ - (String) Use this parameter only when paginating
683
+ # results, and only in a subsequent request after you've received a
684
+ # response where the results are truncated. Set it to the value of
685
+ # the Marker element in the response you just received.
686
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
687
+ # results to indicate the maximum number of user names you want in
688
+ # the response. If there are additional user names beyond the maximum
689
+ # you specify, the IsTruncated response element is +true+ .
690
+ # @return [Core::Response]
691
+ # The #data method of the response object returns
692
+ # a hash with the following structure:
693
+ # * +:instance_profiles+ - (Array<Hash>)
980
694
  # * +:path+ - (String)
981
- # * +:role_name+ - (String)
982
- # * +:role_id+ - (String)
695
+ # * +:instance_profile_name+ - (String)
696
+ # * +:instance_profile_id+ - (String)
983
697
  # * +:arn+ - (String)
984
698
  # * +:create_date+ - (Time)
985
- # * +:assume_role_policy_document+ - (String)
986
- # * +:is_truncated+ - (Boolean)
987
- # * +:marker+ - (String)
988
- #
989
- # @return [Core::Response]
990
- #
699
+ # * +:roles+ - (Array<Hash>)
700
+ # * +:path+ - (String)
701
+ # * +:role_name+ - (String)
702
+ # * +:role_id+ - (String)
703
+ # * +:arn+ - (String)
704
+ # * +:create_date+ - (Time)
705
+ # * +:assume_role_policy_document+ - (String)
706
+ # * +:is_truncated+ - (Boolean)
707
+ # * +:marker+ - (String)
991
708
  define_client_method :list_instance_profiles, 'ListInstanceProfiles'
992
709
 
993
710
  # Calls the ListInstanceProfilesForRole API operation.
994
711
  # @method list_instance_profiles_for_role(options = {})
995
- #
996
- # === Options:
997
- #
998
- # * +:role_name+ - *required* - (String) The name of the role to list
999
- # instance profiles for.
1000
- # * +:marker+ - (String) Use this parameter only when paginating results,
1001
- # and only in a subsequent request after you've received a response
1002
- # where the results are truncated. Set it to the value of the Marker
1003
- # element in the response you just received.
1004
- # * +:max_items+ - (Integer) Use this parameter only when paginating
1005
- # results to indicate the maximum number of user names you want in the
1006
- # response. If there are additional user names beyond the maximum you
1007
- # specify, the IsTruncated response element is +true+ .
1008
- #
1009
- # === Response Structure:
1010
- #
1011
- # * +:instance_profiles+ - (Array<Hash>)
1012
- # * +:path+ - (String)
1013
- # * +:instance_profile_name+ - (String)
1014
- # * +:instance_profile_id+ - (String)
1015
- # * +:arn+ - (String)
1016
- # * +:create_date+ - (Time)
1017
- # * +:roles+ - (Array<Hash>)
712
+ # @param [Hash] options
713
+ # * +:role_name+ - *required* - (String) The name of the role to list
714
+ # instance profiles for.
715
+ # * +:marker+ - (String) Use this parameter only when paginating
716
+ # results, and only in a subsequent request after you've received a
717
+ # response where the results are truncated. Set it to the value of
718
+ # the Marker element in the response you just received.
719
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
720
+ # results to indicate the maximum number of user names you want in
721
+ # the response. If there are additional user names beyond the maximum
722
+ # you specify, the IsTruncated response element is +true+ .
723
+ # @return [Core::Response]
724
+ # The #data method of the response object returns
725
+ # a hash with the following structure:
726
+ # * +:instance_profiles+ - (Array<Hash>)
1018
727
  # * +:path+ - (String)
1019
- # * +:role_name+ - (String)
1020
- # * +:role_id+ - (String)
728
+ # * +:instance_profile_name+ - (String)
729
+ # * +:instance_profile_id+ - (String)
1021
730
  # * +:arn+ - (String)
1022
731
  # * +:create_date+ - (Time)
1023
- # * +:assume_role_policy_document+ - (String)
1024
- # * +:is_truncated+ - (Boolean)
1025
- # * +:marker+ - (String)
1026
- #
1027
- # @return [Core::Response]
1028
- #
732
+ # * +:roles+ - (Array<Hash>)
733
+ # * +:path+ - (String)
734
+ # * +:role_name+ - (String)
735
+ # * +:role_id+ - (String)
736
+ # * +:arn+ - (String)
737
+ # * +:create_date+ - (Time)
738
+ # * +:assume_role_policy_document+ - (String)
739
+ # * +:is_truncated+ - (Boolean)
740
+ # * +:marker+ - (String)
1029
741
  define_client_method :list_instance_profiles_for_role, 'ListInstanceProfilesForRole'
1030
742
 
1031
743
  # Calls the ListMFADevices API operation.
1032
744
  # @method list_mfa_devices(options = {})
1033
- #
1034
- # === Options:
1035
- #
1036
- # * +:user_name+ - (String) Name of the user whose MFA devices you want
1037
- # to list.
1038
- # * +:marker+ - (String) Use this only when paginating results, and only
1039
- # in a subsequent request after you've received a response where the
1040
- # results are truncated. Set it to the value of the Marker element in
1041
- # the response you just received.
1042
- # * +:max_items+ - (Integer) Use this only when paginating results to
1043
- # indicate the maximum number of MFA devices you want in the response.
1044
- # If there are additional MFA devices beyond the maximum you specify,
1045
- # the IsTruncated response element is +true+ .
1046
- #
1047
- # === Response Structure:
1048
- #
1049
- # * +:mfa_devices+ - (Array<Hash>)
1050
- # * +:user_name+ - (String)
1051
- # * +:serial_number+ - (String)
1052
- # * +:enable_date+ - (Time)
1053
- # * +:is_truncated+ - (Boolean)
1054
- # * +:marker+ - (String)
1055
- #
1056
- # @return [Core::Response]
1057
- #
745
+ # @param [Hash] options
746
+ # * +:user_name+ - (String) Name of the user whose MFA devices you want
747
+ # to list.
748
+ # * +:marker+ - (String) Use this only when paginating results, and
749
+ # only in a subsequent request after you've received a response where
750
+ # the results are truncated. Set it to the value of the Marker
751
+ # element in the response you just received.
752
+ # * +:max_items+ - (Integer) Use this only when paginating results to
753
+ # indicate the maximum number of MFA devices you want in the
754
+ # response. If there are additional MFA devices beyond the maximum
755
+ # you specify, the IsTruncated response element is +true+ .
756
+ # @return [Core::Response]
757
+ # The #data method of the response object returns
758
+ # a hash with the following structure:
759
+ # * +:mfa_devices+ - (Array<Hash>)
760
+ # * +:user_name+ - (String)
761
+ # * +:serial_number+ - (String)
762
+ # * +:enable_date+ - (Time)
763
+ # * +:is_truncated+ - (Boolean)
764
+ # * +:marker+ - (String)
1058
765
  define_client_method :list_mfa_devices, 'ListMFADevices'
1059
766
 
1060
767
  # Calls the ListRolePolicies API operation.
1061
768
  # @method list_role_policies(options = {})
1062
- #
1063
- # === Options:
1064
- #
1065
- # * +:role_name+ - *required* - (String) The name of the role to list
1066
- # policies for.
1067
- # * +:marker+ - (String) Use this parameter only when paginating results,
1068
- # and only in a subsequent request after you've received a response
1069
- # where the results are truncated. Set it to the value of the Marker
1070
- # element in the response you just received.
1071
- # * +:max_items+ - (Integer) Use this parameter only when paginating
1072
- # results to indicate the maximum number of user names you want in the
1073
- # response. If there are additional user names beyond the maximum you
1074
- # specify, the IsTruncated response element is +true+ .
1075
- #
1076
- # === Response Structure:
1077
- #
1078
- # * +:policy_names+ - (Array<String>)
1079
- # * +:is_truncated+ - (Boolean)
1080
- # * +:marker+ - (String)
1081
- #
1082
- # @return [Core::Response]
1083
- #
769
+ # @param [Hash] options
770
+ # * +:role_name+ - *required* - (String) The name of the role to list
771
+ # policies for.
772
+ # * +:marker+ - (String) Use this parameter only when paginating
773
+ # results, and only in a subsequent request after you've received a
774
+ # response where the results are truncated. Set it to the value of
775
+ # the Marker element in the response you just received.
776
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
777
+ # results to indicate the maximum number of user names you want in
778
+ # the response. If there are additional user names beyond the maximum
779
+ # you specify, the IsTruncated response element is +true+ .
780
+ # @return [Core::Response]
781
+ # The #data method of the response object returns
782
+ # a hash with the following structure:
783
+ # * +:policy_names+ - (Array<String>)
784
+ # * +:is_truncated+ - (Boolean)
785
+ # * +:marker+ - (String)
1084
786
  define_client_method :list_role_policies, 'ListRolePolicies'
1085
787
 
1086
788
  # Calls the ListRoles API operation.
1087
789
  # @method list_roles(options = {})
1088
- #
1089
- # === Options:
1090
- #
1091
- # * +:path_prefix+ - (String) The path prefix for filtering the results.
1092
- # For example: /application_abc/component_xyz/, which would get all
1093
- # roles whose path starts with /application_abc/component_xyz/. This
1094
- # parameter is optional. If it is not included, it defaults to a slash
1095
- # (/), listing all roles.
1096
- # * +:marker+ - (String) Use this parameter only when paginating results,
1097
- # and only in a subsequent request after you've received a response
1098
- # where the results are truncated. Set it to the value of the Marker
1099
- # element in the response you just received.
1100
- # * +:max_items+ - (Integer) Use this parameter only when paginating
1101
- # results to indicate the maximum number of user names you want in the
1102
- # response. If there are additional user names beyond the maximum you
1103
- # specify, the IsTruncated response element is +true+ .
1104
- #
1105
- # === Response Structure:
1106
- #
1107
- # * +:roles+ - (Array<Hash>)
1108
- # * +:path+ - (String)
1109
- # * +:role_name+ - (String)
1110
- # * +:role_id+ - (String)
1111
- # * +:arn+ - (String)
1112
- # * +:create_date+ - (Time)
1113
- # * +:assume_role_policy_document+ - (String)
1114
- # * +:is_truncated+ - (Boolean)
1115
- # * +:marker+ - (String)
1116
- #
1117
- # @return [Core::Response]
1118
- #
790
+ # @param [Hash] options
791
+ # * +:path_prefix+ - (String) The path prefix for filtering the
792
+ # results. For example: /application_abc/component_xyz/, which would
793
+ # get all roles whose path starts with
794
+ # /application_abc/component_xyz/. This parameter is optional. If it
795
+ # is not included, it defaults to a slash (/), listing all roles.
796
+ # * +:marker+ - (String) Use this parameter only when paginating
797
+ # results, and only in a subsequent request after you've received a
798
+ # response where the results are truncated. Set it to the value of
799
+ # the Marker element in the response you just received.
800
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
801
+ # results to indicate the maximum number of user names you want in
802
+ # the response. If there are additional user names beyond the maximum
803
+ # you specify, the IsTruncated response element is +true+ .
804
+ # @return [Core::Response]
805
+ # The #data method of the response object returns
806
+ # a hash with the following structure:
807
+ # * +:roles+ - (Array<Hash>)
808
+ # * +:path+ - (String)
809
+ # * +:role_name+ - (String)
810
+ # * +:role_id+ - (String)
811
+ # * +:arn+ - (String)
812
+ # * +:create_date+ - (Time)
813
+ # * +:assume_role_policy_document+ - (String)
814
+ # * +:is_truncated+ - (Boolean)
815
+ # * +:marker+ - (String)
1119
816
  define_client_method :list_roles, 'ListRoles'
1120
817
 
1121
818
  # Calls the ListServerCertificates API operation.
1122
819
  # @method list_server_certificates(options = {})
1123
- #
1124
- # === Options:
1125
- #
1126
- # * +:path_prefix+ - (String) The path prefix for filtering the results.
1127
- # For example: /company/servercerts would get all server certificates
1128
- # for which the path starts with /company/servercerts. This parameter
1129
- # is optional. If it is not included, it defaults to a slash (/),
1130
- # listing all server certificates.
1131
- # * +:marker+ - (String) Use this only when paginating results, and only
1132
- # in a subsequent request after you've received a response where the
1133
- # results are truncated. Set it to the value of the Marker element in
1134
- # the response you just received.
1135
- # * +:max_items+ - (Integer) Use this only when paginating results to
1136
- # indicate the maximum number of server certificates you want in the
1137
- # response. If there are additional server certificates beyond the
1138
- # maximum you specify, the IsTruncated response element will be set to
1139
- # +true+ .
1140
- #
1141
- # === Response Structure:
1142
- #
1143
- # * +:server_certificate_metadata_list+ - (Array<Hash>)
1144
- # * +:path+ - (String)
1145
- # * +:server_certificate_name+ - (String)
1146
- # * +:server_certificate_id+ - (String)
1147
- # * +:arn+ - (String)
1148
- # * +:upload_date+ - (Time)
1149
- # * +:is_truncated+ - (Boolean)
1150
- # * +:marker+ - (String)
1151
- #
1152
- # @return [Core::Response]
1153
- #
820
+ # @param [Hash] options
821
+ # * +:path_prefix+ - (String) The path prefix for filtering the
822
+ # results. For example: /company/servercerts would get all server
823
+ # certificates for which the path starts with /company/servercerts.
824
+ # This parameter is optional. If it is not included, it defaults to a
825
+ # slash (/), listing all server certificates.
826
+ # * +:marker+ - (String) Use this only when paginating results, and
827
+ # only in a subsequent request after you've received a response where
828
+ # the results are truncated. Set it to the value of the Marker
829
+ # element in the response you just received.
830
+ # * +:max_items+ - (Integer) Use this only when paginating results to
831
+ # indicate the maximum number of server certificates you want in the
832
+ # response. If there are additional server certificates beyond the
833
+ # maximum you specify, the IsTruncated response element will be set
834
+ # to +true+ .
835
+ # @return [Core::Response]
836
+ # The #data method of the response object returns
837
+ # a hash with the following structure:
838
+ # * +:server_certificate_metadata_list+ - (Array<Hash>)
839
+ # * +:path+ - (String)
840
+ # * +:server_certificate_name+ - (String)
841
+ # * +:server_certificate_id+ - (String)
842
+ # * +:arn+ - (String)
843
+ # * +:upload_date+ - (Time)
844
+ # * +:is_truncated+ - (Boolean)
845
+ # * +:marker+ - (String)
1154
846
  define_client_method :list_server_certificates, 'ListServerCertificates'
1155
847
 
1156
848
  # Calls the ListSigningCertificates API operation.
1157
849
  # @method list_signing_certificates(options = {})
1158
- #
1159
- # === Options:
1160
- #
1161
- # * +:user_name+ - (String) The name of the user.
1162
- # * +:marker+ - (String) Use this only when paginating results, and only
1163
- # in a subsequent request after you've received a response where the
1164
- # results are truncated. Set it to the value of the Marker element in
1165
- # the response you just received.
1166
- # * +:max_items+ - (Integer) Use this only when paginating results to
1167
- # indicate the maximum number of certificate IDs you want in the
1168
- # response. If there are additional certificate IDs beyond the maximum
1169
- # you specify, the IsTruncated response element is +true+ .
1170
- #
1171
- # === Response Structure:
1172
- #
1173
- # * +:certificates+ - (Array<Hash>)
1174
- # * +:user_name+ - (String)
1175
- # * +:certificate_id+ - (String)
1176
- # * +:certificate_body+ - (String)
1177
- # * +:status+ - (String)
1178
- # * +:upload_date+ - (Time)
1179
- # * +:is_truncated+ - (Boolean)
1180
- # * +:marker+ - (String)
1181
- #
1182
- # @return [Core::Response]
1183
- #
850
+ # @param [Hash] options
851
+ # * +:user_name+ - (String) The name of the user.
852
+ # * +:marker+ - (String) Use this only when paginating results, and
853
+ # only in a subsequent request after you've received a response where
854
+ # the results are truncated. Set it to the value of the Marker
855
+ # element in the response you just received.
856
+ # * +:max_items+ - (Integer) Use this only when paginating results to
857
+ # indicate the maximum number of certificate IDs you want in the
858
+ # response. If there are additional certificate IDs beyond the
859
+ # maximum you specify, the IsTruncated response element is +true+ .
860
+ # @return [Core::Response]
861
+ # The #data method of the response object returns
862
+ # a hash with the following structure:
863
+ # * +:certificates+ - (Array<Hash>)
864
+ # * +:user_name+ - (String)
865
+ # * +:certificate_id+ - (String)
866
+ # * +:certificate_body+ - (String)
867
+ # * +:status+ - (String)
868
+ # * +:upload_date+ - (Time)
869
+ # * +:is_truncated+ - (Boolean)
870
+ # * +:marker+ - (String)
1184
871
  define_client_method :list_signing_certificates, 'ListSigningCertificates'
1185
872
 
1186
873
  # Calls the ListUserPolicies API operation.
1187
874
  # @method list_user_policies(options = {})
1188
- #
1189
- # === Options:
1190
- #
1191
- # * +:user_name+ - *required* - (String) The name of the user to list
1192
- # policies for.
1193
- # * +:marker+ - (String) Use this only when paginating results, and only
1194
- # in a subsequent request after you've received a response where the
1195
- # results are truncated. Set it to the value of the Marker element in
1196
- # the response you just received.
1197
- # * +:max_items+ - (Integer) Use this only when paginating results to
1198
- # indicate the maximum number of policy names you want in the response.
1199
- # If there are additional policy names beyond the maximum you specify,
1200
- # the IsTruncated response element is +true+ .
1201
- #
1202
- # === Response Structure:
1203
- #
1204
- # * +:policy_names+ - (Array<String>)
1205
- # * +:is_truncated+ - (Boolean)
1206
- # * +:marker+ - (String)
1207
- #
1208
- # @return [Core::Response]
1209
- #
875
+ # @param [Hash] options
876
+ # * +:user_name+ - *required* - (String) The name of the user to list
877
+ # policies for.
878
+ # * +:marker+ - (String) Use this only when paginating results, and
879
+ # only in a subsequent request after you've received a response where
880
+ # the results are truncated. Set it to the value of the Marker
881
+ # element in the response you just received.
882
+ # * +:max_items+ - (Integer) Use this only when paginating results to
883
+ # indicate the maximum number of policy names you want in the
884
+ # response. If there are additional policy names beyond the maximum
885
+ # you specify, the IsTruncated response element is +true+ .
886
+ # @return [Core::Response]
887
+ # The #data method of the response object returns
888
+ # a hash with the following structure:
889
+ # * +:policy_names+ - (Array<String>)
890
+ # * +:is_truncated+ - (Boolean)
891
+ # * +:marker+ - (String)
1210
892
  define_client_method :list_user_policies, 'ListUserPolicies'
1211
893
 
1212
894
  # Calls the ListUsers API operation.
1213
895
  # @method list_users(options = {})
1214
- #
1215
- # === Options:
1216
- #
1217
- # * +:path_prefix+ - (String) The path prefix for filtering the results.
1218
- # For example: /division_abc/subdivision_xyz/, which would get all user
1219
- # names whose path starts with /division_abc/subdivision_xyz/. This
1220
- # parameter is optional. If it is not included, it defaults to a slash
1221
- # (/), listing all user names.
1222
- # * +:marker+ - (String) Use this parameter only when paginating results,
1223
- # and only in a subsequent request after you've received a response
1224
- # where the results are truncated. Set it to the value of the Marker
1225
- # element in the response you just received.
1226
- # * +:max_items+ - (Integer) Use this parameter only when paginating
1227
- # results to indicate the maximum number of user names you want in the
1228
- # response. If there are additional user names beyond the maximum you
1229
- # specify, the IsTruncated response element is +true+ .
1230
- #
1231
- # === Response Structure:
1232
- #
1233
- # * +:users+ - (Array<Hash>)
1234
- # * +:path+ - (String)
1235
- # * +:user_name+ - (String)
1236
- # * +:user_id+ - (String)
1237
- # * +:arn+ - (String)
1238
- # * +:create_date+ - (Time)
1239
- # * +:is_truncated+ - (Boolean)
1240
- # * +:marker+ - (String)
1241
- #
1242
- # @return [Core::Response]
1243
- #
1244
- define_client_method :list_users, 'ListUsers'
1245
-
1246
- # Calls the ListVirtualMFADevices API operation.
1247
- # @method list_virtual_mfa_devices(options = {})
1248
- #
1249
- # === Options:
1250
- #
1251
- # * +:assignment_status+ - (String) The status (unassigned or assigned)
1252
- # of the devices to list. If you do not specify an AssignmentStatus,
1253
- # the action defaults to Any which lists both assigned and unassigned
1254
- # virtual MFA devices.
1255
- # * +:marker+ - (String) Use this parameter only when paginating results,
1256
- # and only in a subsequent request after you've received a response
1257
- # where the results are truncated. Set it to the value of the Marker
1258
- # element in the response you just received.
1259
- # * +:max_items+ - (Integer) Use this parameter only when paginating
1260
- # results to indicate the maximum number of user names you want in the
1261
- # response. If there are additional user names beyond the maximum you
1262
- # specify, the IsTruncated response element is +true+ .
1263
- #
1264
- # === Response Structure:
1265
- #
1266
- # * +:virtual_mfa_devices+ - (Array<Hash>)
1267
- # * +:serial_number+ - (String)
1268
- # * +:base_32_string_seed+ - (String)
1269
- # * +:qr_code_png+ - (String)
1270
- # * +:user+ - (Hash)
896
+ # @param [Hash] options
897
+ # * +:path_prefix+ - (String) The path prefix for filtering the
898
+ # results. For example: /division_abc/subdivision_xyz/, which would
899
+ # get all user names whose path starts with
900
+ # /division_abc/subdivision_xyz/. This parameter is optional. If it
901
+ # is not included, it defaults to a slash (/), listing all user
902
+ # names.
903
+ # * +:marker+ - (String) Use this parameter only when paginating
904
+ # results, and only in a subsequent request after you've received a
905
+ # response where the results are truncated. Set it to the value of
906
+ # the Marker element in the response you just received.
907
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
908
+ # results to indicate the maximum number of user names you want in
909
+ # the response. If there are additional user names beyond the maximum
910
+ # you specify, the IsTruncated response element is +true+ .
911
+ # @return [Core::Response]
912
+ # The #data method of the response object returns
913
+ # a hash with the following structure:
914
+ # * +:users+ - (Array<Hash>)
1271
915
  # * +:path+ - (String)
1272
916
  # * +:user_name+ - (String)
1273
917
  # * +:user_id+ - (String)
1274
918
  # * +:arn+ - (String)
1275
919
  # * +:create_date+ - (Time)
1276
- # * +:enable_date+ - (Time)
1277
- # * +:is_truncated+ - (Boolean)
1278
- # * +:marker+ - (String)
1279
- #
1280
- # @return [Core::Response]
1281
- #
920
+ # * +:is_truncated+ - (Boolean)
921
+ # * +:marker+ - (String)
922
+ define_client_method :list_users, 'ListUsers'
923
+
924
+ # Calls the ListVirtualMFADevices API operation.
925
+ # @method list_virtual_mfa_devices(options = {})
926
+ # @param [Hash] options
927
+ # * +:assignment_status+ - (String) The status (unassigned or assigned)
928
+ # of the devices to list. If you do not specify an AssignmentStatus,
929
+ # the action defaults to Any which lists both assigned and unassigned
930
+ # virtual MFA devices.
931
+ # * +:marker+ - (String) Use this parameter only when paginating
932
+ # results, and only in a subsequent request after you've received a
933
+ # response where the results are truncated. Set it to the value of
934
+ # the Marker element in the response you just received.
935
+ # * +:max_items+ - (Integer) Use this parameter only when paginating
936
+ # results to indicate the maximum number of user names you want in
937
+ # the response. If there are additional user names beyond the maximum
938
+ # you specify, the IsTruncated response element is +true+ .
939
+ # @return [Core::Response]
940
+ # The #data method of the response object returns
941
+ # a hash with the following structure:
942
+ # * +:virtual_mfa_devices+ - (Array<Hash>)
943
+ # * +:serial_number+ - (String)
944
+ # * +:base_32_string_seed+ - (String)
945
+ # * +:qr_code_png+ - (String)
946
+ # * +:user+ - (Hash)
947
+ # * +:path+ - (String)
948
+ # * +:user_name+ - (String)
949
+ # * +:user_id+ - (String)
950
+ # * +:arn+ - (String)
951
+ # * +:create_date+ - (Time)
952
+ # * +:enable_date+ - (Time)
953
+ # * +:is_truncated+ - (Boolean)
954
+ # * +:marker+ - (String)
1282
955
  define_client_method :list_virtual_mfa_devices, 'ListVirtualMFADevices'
1283
956
 
1284
957
  # Calls the PutGroupPolicy API operation.
1285
958
  # @method put_group_policy(options = {})
1286
- #
1287
- # === Options:
1288
- #
1289
- # * +:group_name+ - *required* - (String) Name of the group to associate
1290
- # the policy with.
1291
- # * +:policy_name+ - *required* - (String) Name of the policy document.
1292
- # * +:policy_document+ - *required* - (String) The policy document.
1293
- #
1294
- # === Response Structure:
1295
- #
1296
- # This method returns no response data.
1297
- #
1298
- # @return [Core::Response]
1299
- #
959
+ # @param [Hash] options
960
+ # * +:group_name+ - *required* - (String) Name of the group to
961
+ # associate the policy with.
962
+ # * +:policy_name+ - *required* - (String) Name of the policy document.
963
+ # * +:policy_document+ - *required* - (String) The policy document.
964
+ # @return [Core::Response]
1300
965
  define_client_method :put_group_policy, 'PutGroupPolicy'
1301
966
 
1302
967
  # Calls the PutRolePolicy API operation.
1303
968
  # @method put_role_policy(options = {})
1304
- #
1305
- # === Options:
1306
- #
1307
- # * +:role_name+ - *required* - (String) Name of the role to associate
1308
- # the policy with.
1309
- # * +:policy_name+ - *required* - (String) Name of the policy document.
1310
- # * +:policy_document+ - *required* - (String) The policy document.
1311
- #
1312
- # === Response Structure:
1313
- #
1314
- # This method returns no response data.
1315
- #
1316
- # @return [Core::Response]
1317
- #
969
+ # @param [Hash] options
970
+ # * +:role_name+ - *required* - (String) Name of the role to associate
971
+ # the policy with.
972
+ # * +:policy_name+ - *required* - (String) Name of the policy document.
973
+ # * +:policy_document+ - *required* - (String) The policy document.
974
+ # @return [Core::Response]
1318
975
  define_client_method :put_role_policy, 'PutRolePolicy'
1319
976
 
1320
977
  # Calls the PutUserPolicy API operation.
1321
978
  # @method put_user_policy(options = {})
1322
- #
1323
- # === Options:
1324
- #
1325
- # * +:user_name+ - *required* - (String) Name of the user to associate
1326
- # the policy with.
1327
- # * +:policy_name+ - *required* - (String) Name of the policy document.
1328
- # * +:policy_document+ - *required* - (String) The policy document.
1329
- #
1330
- # === Response Structure:
1331
- #
1332
- # This method returns no response data.
1333
- #
1334
- # @return [Core::Response]
1335
- #
979
+ # @param [Hash] options
980
+ # * +:user_name+ - *required* - (String) Name of the user to associate
981
+ # the policy with.
982
+ # * +:policy_name+ - *required* - (String) Name of the policy document.
983
+ # * +:policy_document+ - *required* - (String) The policy document.
984
+ # @return [Core::Response]
1336
985
  define_client_method :put_user_policy, 'PutUserPolicy'
1337
986
 
1338
987
  # Calls the RemoveRoleFromInstanceProfile API operation.
1339
988
  # @method remove_role_from_instance_profile(options = {})
1340
- #
1341
- # === Options:
1342
- #
1343
- # * +:instance_profile_name+ - *required* - (String) Name of the instance
1344
- # profile to update.
1345
- # * +:role_name+ - *required* - (String) Name of the role to remove.
1346
- #
1347
- # === Response Structure:
1348
- #
1349
- # This method returns no response data.
1350
- #
1351
- # @return [Core::Response]
1352
- #
989
+ # @param [Hash] options
990
+ # * +:instance_profile_name+ - *required* - (String) Name of the
991
+ # instance profile to update.
992
+ # * +:role_name+ - *required* - (String) Name of the role to remove.
993
+ # @return [Core::Response]
1353
994
  define_client_method :remove_role_from_instance_profile, 'RemoveRoleFromInstanceProfile'
1354
995
 
1355
996
  # Calls the RemoveUserFromGroup API operation.
1356
997
  # @method remove_user_from_group(options = {})
1357
- #
1358
- # === Options:
1359
- #
1360
- # * +:group_name+ - *required* - (String) Name of the group to update.
1361
- # * +:user_name+ - *required* - (String) Name of the user to remove.
1362
- #
1363
- # === Response Structure:
1364
- #
1365
- # This method returns no response data.
1366
- #
1367
- # @return [Core::Response]
1368
- #
998
+ # @param [Hash] options
999
+ # * +:group_name+ - *required* - (String) Name of the group to update.
1000
+ # * +:user_name+ - *required* - (String) Name of the user to remove.
1001
+ # @return [Core::Response]
1369
1002
  define_client_method :remove_user_from_group, 'RemoveUserFromGroup'
1370
1003
 
1371
1004
  # Calls the ResyncMFADevice API operation.
1372
1005
  # @method resync_mfa_device(options = {})
1373
- #
1374
- # === Options:
1375
- #
1376
- # * +:user_name+ - *required* - (String) Name of the user whose MFA
1377
- # device you want to resynchronize.
1378
- # * +:serial_number+ - *required* - (String) Serial number that uniquely
1379
- # identifies the MFA device.
1380
- # * +:authentication_code_1+ - *required* - (String) An authentication
1381
- # code emitted by the device.
1382
- # * +:authentication_code_2+ - *required* - (String) A subsequent
1383
- # authentication code emitted by the device.
1384
- #
1385
- # === Response Structure:
1386
- #
1387
- # This method returns no response data.
1388
- #
1389
- # @return [Core::Response]
1390
- #
1006
+ # @param [Hash] options
1007
+ # * +:user_name+ - *required* - (String) Name of the user whose MFA
1008
+ # device you want to resynchronize.
1009
+ # * +:serial_number+ - *required* - (String) Serial number that
1010
+ # uniquely identifies the MFA device.
1011
+ # * +:authentication_code_1+ - *required* - (String) An authentication
1012
+ # code emitted by the device.
1013
+ # * +:authentication_code_2+ - *required* - (String) A subsequent
1014
+ # authentication code emitted by the device.
1015
+ # @return [Core::Response]
1391
1016
  define_client_method :resync_mfa_device, 'ResyncMFADevice'
1392
1017
 
1393
1018
  # Calls the UpdateAccessKey API operation.
1394
1019
  # @method update_access_key(options = {})
1395
- #
1396
- # === Options:
1397
- #
1398
- # * +:user_name+ - (String) Name of the user whose key you want to
1399
- # update.
1400
- # * +:access_key_id+ - *required* - (String) The Access Key ID of the
1401
- # Secret Access Key you want to update.
1402
- # * +:status+ - *required* - (String) The status you want to assign to
1403
- # the Secret Access Key. Active means the key can be used for API calls
1404
- # to AWS, while Inactive means the key cannot be used.
1405
- #
1406
- # === Response Structure:
1407
- #
1408
- # This method returns no response data.
1409
- #
1410
- # @return [Core::Response]
1411
- #
1020
+ # @param [Hash] options
1021
+ # * +:user_name+ - (String) Name of the user whose key you want to
1022
+ # update.
1023
+ # * +:access_key_id+ - *required* - (String) The Access Key ID of the
1024
+ # Secret Access Key you want to update.
1025
+ # * +:status+ - *required* - (String) The status you want to assign to
1026
+ # the Secret Access Key. Active means the key can be used for API
1027
+ # calls to AWS, while Inactive means the key cannot be used.
1028
+ # @return [Core::Response]
1412
1029
  define_client_method :update_access_key, 'UpdateAccessKey'
1413
1030
 
1414
1031
  # Calls the UpdateAccountPasswordPolicy API operation.
1415
1032
  # @method update_account_password_policy(options = {})
1416
- #
1417
- # === Options:
1418
- #
1419
- # * +:minimum_password_length+ - (Integer)
1420
- # * +:require_symbols+ - (Boolean)
1421
- # * +:require_numbers+ - (Boolean)
1422
- # * +:require_uppercase_characters+ - (Boolean)
1423
- # * +:require_lowercase_characters+ - (Boolean)
1424
- # * +:allow_users_to_change_password+ - (Boolean)
1425
- #
1426
- # === Response Structure:
1427
- #
1428
- # This method returns no response data.
1429
- #
1430
- # @return [Core::Response]
1431
- #
1033
+ # @param [Hash] options
1034
+ # * +:minimum_password_length+ - (Integer)
1035
+ # * +:require_symbols+ - (Boolean)
1036
+ # * +:require_numbers+ - (Boolean)
1037
+ # * +:require_uppercase_characters+ - (Boolean)
1038
+ # * +:require_lowercase_characters+ - (Boolean)
1039
+ # * +:allow_users_to_change_password+ - (Boolean)
1040
+ # @return [Core::Response]
1432
1041
  define_client_method :update_account_password_policy, 'UpdateAccountPasswordPolicy'
1433
1042
 
1434
1043
  # Calls the UpdateAssumeRolePolicy API operation.
1435
1044
  # @method update_assume_role_policy(options = {})
1436
- #
1437
- # === Options:
1438
- #
1439
- # * +:role_name+ - *required* - (String) Name of the role to update.
1440
- # * +:policy_document+ - *required* - (String) The policy govering by who
1441
- # and under what conditions the role can be assumed.
1442
- #
1443
- # === Response Structure:
1444
- #
1445
- # This method returns no response data.
1446
- #
1447
- # @return [Core::Response]
1448
- #
1045
+ # @param [Hash] options
1046
+ # * +:role_name+ - *required* - (String) Name of the role to update.
1047
+ # * +:policy_document+ - *required* - (String) The policy govering by
1048
+ # who and under what conditions the role can be assumed.
1049
+ # @return [Core::Response]
1449
1050
  define_client_method :update_assume_role_policy, 'UpdateAssumeRolePolicy'
1450
1051
 
1451
1052
  # Calls the UpdateGroup API operation.
1452
1053
  # @method update_group(options = {})
1453
- #
1454
- # === Options:
1455
- #
1456
- # * +:group_name+ - *required* - (String) Name of the group to update. If
1457
- # you're changing the name of the group, this is the original name.
1458
- # * +:new_path+ - (String) New path for the group. Only include this if
1459
- # changing the group's path.
1460
- # * +:new_group_name+ - (String) New name for the group. Only include
1461
- # this if changing the group's name.
1462
- #
1463
- # === Response Structure:
1464
- #
1465
- # This method returns no response data.
1466
- #
1467
- # @return [Core::Response]
1468
- #
1054
+ # @param [Hash] options
1055
+ # * +:group_name+ - *required* - (String) Name of the group to update.
1056
+ # If you're changing the name of the group, this is the original
1057
+ # name.
1058
+ # * +:new_path+ - (String) New path for the group. Only include this if
1059
+ # changing the group's path.
1060
+ # * +:new_group_name+ - (String) New name for the group. Only include
1061
+ # this if changing the group's name.
1062
+ # @return [Core::Response]
1469
1063
  define_client_method :update_group, 'UpdateGroup'
1470
1064
 
1471
1065
  # Calls the UpdateLoginProfile API operation.
1472
1066
  # @method update_login_profile(options = {})
1473
- #
1474
- # === Options:
1475
- #
1476
- # * +:user_name+ - *required* - (String) Name of the user whose password
1477
- # you want to update.
1478
- # * +:password+ - (String) The new password for the user name.
1479
- #
1480
- # === Response Structure:
1481
- #
1482
- # This method returns no response data.
1483
- #
1484
- # @return [Core::Response]
1485
- #
1067
+ # @param [Hash] options
1068
+ # * +:user_name+ - *required* - (String) Name of the user whose
1069
+ # password you want to update.
1070
+ # * +:password+ - (String) The new password for the user name.
1071
+ # @return [Core::Response]
1486
1072
  define_client_method :update_login_profile, 'UpdateLoginProfile'
1487
1073
 
1488
1074
  # Calls the UpdateServerCertificate API operation.
1489
1075
  # @method update_server_certificate(options = {})
1490
- #
1491
- # === Options:
1492
- #
1493
- # * +:server_certificate_name+ - *required* - (String) The name of the
1494
- # server certificate that you want to update.
1495
- # * +:new_path+ - (String) The new path for the server certificate.
1496
- # Include this only if you are updating the server certificate's path.
1497
- # * +:new_server_certificate_name+ - (String) The new name for the server
1498
- # certificate. Include this only if you are updating the server
1499
- # certificate's name.
1500
- #
1501
- # === Response Structure:
1502
- #
1503
- # This method returns no response data.
1504
- #
1505
- # @return [Core::Response]
1506
- #
1076
+ # @param [Hash] options
1077
+ # * +:server_certificate_name+ - *required* - (String) The name of the
1078
+ # server certificate that you want to update.
1079
+ # * +:new_path+ - (String) The new path for the server certificate.
1080
+ # Include this only if you are updating the server certificate's
1081
+ # path.
1082
+ # * +:new_server_certificate_name+ - (String) The new name for the
1083
+ # server certificate. Include this only if you are updating the
1084
+ # server certificate's name.
1085
+ # @return [Core::Response]
1507
1086
  define_client_method :update_server_certificate, 'UpdateServerCertificate'
1508
1087
 
1509
1088
  # Calls the UpdateSigningCertificate API operation.
1510
1089
  # @method update_signing_certificate(options = {})
1511
- #
1512
- # === Options:
1513
- #
1514
- # * +:user_name+ - (String) Name of the user the signing certificate
1515
- # belongs to.
1516
- # * +:certificate_id+ - *required* - (String) The ID of the signing
1517
- # certificate you want to update.
1518
- # * +:status+ - *required* - (String) The status you want to assign to
1519
- # the certificate. Active means the certificate can be used for API
1520
- # calls to AWS, while Inactive means the certificate cannot be used.
1521
- #
1522
- # === Response Structure:
1523
- #
1524
- # This method returns no response data.
1525
- #
1526
- # @return [Core::Response]
1527
- #
1090
+ # @param [Hash] options
1091
+ # * +:user_name+ - (String) Name of the user the signing certificate
1092
+ # belongs to.
1093
+ # * +:certificate_id+ - *required* - (String) The ID of the signing
1094
+ # certificate you want to update.
1095
+ # * +:status+ - *required* - (String) The status you want to assign to
1096
+ # the certificate. Active means the certificate can be used for API
1097
+ # calls to AWS, while Inactive means the certificate cannot be used.
1098
+ # @return [Core::Response]
1528
1099
  define_client_method :update_signing_certificate, 'UpdateSigningCertificate'
1529
1100
 
1530
1101
  # Calls the UpdateUser API operation.
1531
1102
  # @method update_user(options = {})
1532
- #
1533
- # === Options:
1534
- #
1535
- # * +:user_name+ - *required* - (String) Name of the user to update. If
1536
- # you're changing the name of the user, this is the original user name.
1537
- # * +:new_path+ - (String) New path for the user. Include this parameter
1538
- # only if you're changing the user's path.
1539
- # * +:new_user_name+ - (String) New name for the user. Include this
1540
- # parameter only if you're changing the user's name.
1541
- #
1542
- # === Response Structure:
1543
- #
1544
- # This method returns no response data.
1545
- #
1546
- # @return [Core::Response]
1547
- #
1103
+ # @param [Hash] options
1104
+ # * +:user_name+ - *required* - (String) Name of the user to update. If
1105
+ # you're changing the name of the user, this is the original user
1106
+ # name.
1107
+ # * +:new_path+ - (String) New path for the user. Include this
1108
+ # parameter only if you're changing the user's path.
1109
+ # * +:new_user_name+ - (String) New name for the user. Include this
1110
+ # parameter only if you're changing the user's name.
1111
+ # @return [Core::Response]
1548
1112
  define_client_method :update_user, 'UpdateUser'
1549
1113
 
1550
1114
  # Calls the UploadServerCertificate API operation.
1551
1115
  # @method upload_server_certificate(options = {})
1552
- #
1553
- # === Options:
1554
- #
1555
- # * +:path+ - (String) The path for the server certificate. For more
1556
- # information about paths, see Identifiers for IAM Entities in Using
1557
- # AWS Identity and Access Management. This parameter is optional. If it
1558
- # is not included, it defaults to a slash (/).
1559
- # * +:server_certificate_name+ - *required* - (String) The name for the
1560
- # server certificate. Do not include the path in this value.
1561
- # * +:certificate_body+ - *required* - (String) The contents of the
1562
- # public key certificate in PEM-encoded format.
1563
- # * +:private_key+ - *required* - (String) The contents of the private
1564
- # key in PEM-encoded format.
1565
- # * +:certificate_chain+ - (String) The contents of the certificate
1566
- # chain. This is typically a concatenation of the PEM-encoded public
1567
- # key certificates of the chain.
1568
- #
1569
- # === Response Structure:
1570
- #
1571
- # * +:server_certificate_metadata+ - (Hash)
1572
- # * +:path+ - (String)
1573
- # * +:server_certificate_name+ - (String)
1574
- # * +:server_certificate_id+ - (String)
1575
- # * +:arn+ - (String)
1576
- # * +:upload_date+ - (Time)
1577
- #
1578
- # @return [Core::Response]
1579
- #
1116
+ # @param [Hash] options
1117
+ # * +:path+ - (String) The path for the server certificate. For more
1118
+ # information about paths, see Identifiers for IAM Entities in Using
1119
+ # AWS Identity and Access Management. This parameter is optional. If
1120
+ # it is not included, it defaults to a slash (/).
1121
+ # * +:server_certificate_name+ - *required* - (String) The name for the
1122
+ # server certificate. Do not include the path in this value.
1123
+ # * +:certificate_body+ - *required* - (String) The contents of the
1124
+ # public key certificate in PEM-encoded format.
1125
+ # * +:private_key+ - *required* - (String) The contents of the private
1126
+ # key in PEM-encoded format.
1127
+ # * +:certificate_chain+ - (String) The contents of the certificate
1128
+ # chain. This is typically a concatenation of the PEM-encoded public
1129
+ # key certificates of the chain.
1130
+ # @return [Core::Response]
1131
+ # The #data method of the response object returns
1132
+ # a hash with the following structure:
1133
+ # * +:server_certificate_metadata+ - (Hash)
1134
+ # * +:path+ - (String)
1135
+ # * +:server_certificate_name+ - (String)
1136
+ # * +:server_certificate_id+ - (String)
1137
+ # * +:arn+ - (String)
1138
+ # * +:upload_date+ - (Time)
1580
1139
  define_client_method :upload_server_certificate, 'UploadServerCertificate'
1581
1140
 
1582
1141
  # Calls the UploadSigningCertificate API operation.
1583
1142
  # @method upload_signing_certificate(options = {})
1584
- #
1585
- # === Options:
1586
- #
1587
- # * +:user_name+ - (String) Name of the user the signing certificate is
1588
- # for.
1589
- # * +:certificate_body+ - *required* - (String) The contents of the
1590
- # signing certificate.
1591
- #
1592
- # === Response Structure:
1593
- #
1594
- # * +:certificate+ - (Hash)
1595
- # * +:user_name+ - (String)
1596
- # * +:certificate_id+ - (String)
1597
- # * +:certificate_body+ - (String)
1598
- # * +:status+ - (String)
1599
- # * +:upload_date+ - (Time)
1600
- #
1601
- # @return [Core::Response]
1602
- #
1143
+ # @param [Hash] options
1144
+ # * +:user_name+ - (String) Name of the user the signing certificate is
1145
+ # for.
1146
+ # * +:certificate_body+ - *required* - (String) The contents of the
1147
+ # signing certificate.
1148
+ # @return [Core::Response]
1149
+ # The #data method of the response object returns
1150
+ # a hash with the following structure:
1151
+ # * +:certificate+ - (Hash)
1152
+ # * +:user_name+ - (String)
1153
+ # * +:certificate_id+ - (String)
1154
+ # * +:certificate_body+ - (String)
1155
+ # * +:status+ - (String)
1156
+ # * +:upload_date+ - (Time)
1603
1157
  define_client_method :upload_signing_certificate, 'UploadSigningCertificate'
1604
1158
 
1605
1159
  ## end client methods ##