aws-sdk 1.11.2 → 1.11.3

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.
@@ -31,57 +31,64 @@ module AWS
31
31
  # @!method abort_multipart_upload(options = {})
32
32
  # Calls the DELETE AbortMultipartUpload API operation.
33
33
  # @param [Hash] options
34
- # * `:account_id` - *required* - (String)
35
- # * `:vault_name` - *required* - (String)
36
- # * `:upload_id` - *required* - (String)
34
+ #
35
+ # * `:account_id` - *required* - (String)
36
+ # * `:vault_name` - *required* - (String)
37
+ # * `:upload_id` - *required* - (String)
37
38
  # @return [Core::Response]
38
39
 
39
40
  # @!method complete_multipart_upload(options = {})
40
41
  # Calls the POST CompleteMultipartUpload API operation.
41
42
  # @param [Hash] options
42
- # * `:account_id` - *required* - (String)
43
- # * `:vault_name` - *required* - (String)
44
- # * `:upload_id` - *required* - (String)
45
- # * `:archive_size` - (Integer)
46
- # * `:checksum` - *required* - (String)
47
- # * `:content_sha256` - (String)
43
+ #
44
+ # * `:account_id` - *required* - (String)
45
+ # * `:vault_name` - *required* - (String)
46
+ # * `:upload_id` - *required* - (String)
47
+ # * `:archive_size` - (Integer)
48
+ # * `:checksum` - *required* - (String)
49
+ # * `:content_sha256` - (String)
48
50
  # @return [Core::Response]
49
51
 
50
52
  # @!method create_vault(options = {})
51
53
  # Calls the PUT CreateVault API operation.
52
54
  # @param [Hash] options
53
- # * `:account_id` - *required* - (String)
54
- # * `:vault_name` - *required* - (String)
55
+ #
56
+ # * `:account_id` - *required* - (String)
57
+ # * `:vault_name` - *required* - (String)
55
58
  # @return [Core::Response]
56
59
 
57
60
  # @!method delete_archive(options = {})
58
61
  # Calls the DELETE DeleteArchive API operation.
59
62
  # @param [Hash] options
60
- # * `:account_id` - *required* - (String)
61
- # * `:vault_name` - *required* - (String)
62
- # * `:archive_id` - *required* - (String)
63
+ #
64
+ # * `:account_id` - *required* - (String)
65
+ # * `:vault_name` - *required* - (String)
66
+ # * `:archive_id` - *required* - (String)
63
67
  # @return [Core::Response]
64
68
 
65
69
  # @!method delete_vault(options = {})
66
70
  # Calls the DELETE DeleteVault API operation.
67
71
  # @param [Hash] options
68
- # * `:account_id` - *required* - (String)
69
- # * `:vault_name` - *required* - (String)
72
+ #
73
+ # * `:account_id` - *required* - (String)
74
+ # * `:vault_name` - *required* - (String)
70
75
  # @return [Core::Response]
71
76
 
72
77
  # @!method delete_vault_notifications(options = {})
73
78
  # Calls the DELETE DeleteVaultNotifications API operation.
74
79
  # @param [Hash] options
75
- # * `:account_id` - *required* - (String)
76
- # * `:vault_name` - *required* - (String)
80
+ #
81
+ # * `:account_id` - *required* - (String)
82
+ # * `:vault_name` - *required* - (String)
77
83
  # @return [Core::Response]
78
84
 
79
85
  # @!method describe_job(options = {})
80
86
  # Calls the GET DescribeJob API operation.
81
87
  # @param [Hash] options
82
- # * `:account_id` - *required* - (String)
83
- # * `:vault_name` - *required* - (String)
84
- # * `:job_id` - *required* - (String)
88
+ #
89
+ # * `:account_id` - *required* - (String)
90
+ # * `:vault_name` - *required* - (String)
91
+ # * `:job_id` - *required* - (String)
85
92
  # @return [Core::Response]
86
93
  # The #data method of the response object returns
87
94
  # a hash with the following structure:
@@ -104,8 +111,9 @@ module AWS
104
111
  # @!method describe_vault(options = {})
105
112
  # Calls the GET DescribeVault API operation.
106
113
  # @param [Hash] options
107
- # * `:account_id` - *required* - (String)
108
- # * `:vault_name` - *required* - (String)
114
+ #
115
+ # * `:account_id` - *required* - (String)
116
+ # * `:vault_name` - *required* - (String)
109
117
  # @return [Core::Response]
110
118
  # The #data method of the response object returns
111
119
  # a hash with the following structure:
@@ -120,17 +128,19 @@ module AWS
120
128
  # @!method get_job_output(options = {})
121
129
  # Calls the GET GetJobOutput API operation.
122
130
  # @param [Hash] options
123
- # * `:account_id` - *required* - (String)
124
- # * `:vault_name` - *required* - (String)
125
- # * `:job_id` - *required* - (String)
126
- # * `:range` - (String)
131
+ #
132
+ # * `:account_id` - *required* - (String)
133
+ # * `:vault_name` - *required* - (String)
134
+ # * `:job_id` - *required* - (String)
135
+ # * `:range` - (String)
127
136
  # @return [Core::Response]
128
137
 
129
138
  # @!method get_vault_notifications(options = {})
130
139
  # Calls the GET GetVaultNotifications API operation.
131
140
  # @param [Hash] options
132
- # * `:account_id` - *required* - (String)
133
- # * `:vault_name` - *required* - (String)
141
+ #
142
+ # * `:account_id` - *required* - (String)
143
+ # * `:vault_name` - *required* - (String)
134
144
  # @return [Core::Response]
135
145
  # The #data method of the response object returns
136
146
  # a hash with the following structure:
@@ -141,34 +151,37 @@ module AWS
141
151
  # @!method initiate_job(options = {})
142
152
  # Calls the POST InitiateJob API operation.
143
153
  # @param [Hash] options
144
- # * `:account_id` - *required* - (String)
145
- # * `:vault_name` - *required* - (String)
146
- # * `:job_parameters` - *required* - (Hash)
147
- # * `:format` - (String)
148
- # * `:type` - (String)
149
- # * `:archive_id` - (String)
150
- # * `:description` - (String)
151
- # * `:sns_topic` - (String)
154
+ #
155
+ # * `:account_id` - *required* - (String)
156
+ # * `:vault_name` - *required* - (String)
157
+ # * `:job_parameters` - *required* - (Hash)
158
+ # * `:format` - (String)
159
+ # * `:type` - (String)
160
+ # * `:archive_id` - (String)
161
+ # * `:description` - (String)
162
+ # * `:sns_topic` - (String)
152
163
  # @return [Core::Response]
153
164
 
154
165
  # @!method initiate_multipart_upload(options = {})
155
166
  # Calls the POST InitiateMultipartUpload API operation.
156
167
  # @param [Hash] options
157
- # * `:account_id` - *required* - (String)
158
- # * `:vault_name` - *required* - (String)
159
- # * `:archive_description` - (String)
160
- # * `:part_size` - (Integer)
168
+ #
169
+ # * `:account_id` - *required* - (String)
170
+ # * `:vault_name` - *required* - (String)
171
+ # * `:archive_description` - (String)
172
+ # * `:part_size` - (Integer)
161
173
  # @return [Core::Response]
162
174
 
163
175
  # @!method list_jobs(options = {})
164
176
  # Calls the GET ListJobs API operation.
165
177
  # @param [Hash] options
166
- # * `:account_id` - *required* - (String)
167
- # * `:vault_name` - *required* - (String)
168
- # * `:limit` - (Integer)
169
- # * `:marker` - (String)
170
- # * `:statuscode` - (String)
171
- # * `:completed` - (String)
178
+ #
179
+ # * `:account_id` - *required* - (String)
180
+ # * `:vault_name` - *required* - (String)
181
+ # * `:limit` - (Integer)
182
+ # * `:marker` - (String)
183
+ # * `:statuscode` - (String)
184
+ # * `:completed` - (String)
172
185
  # @return [Core::Response]
173
186
  # The #data method of the response object returns
174
187
  # a hash with the following structure:
@@ -193,10 +206,11 @@ module AWS
193
206
  # @!method list_multipart_uploads(options = {})
194
207
  # Calls the GET ListMultipartUploads API operation.
195
208
  # @param [Hash] options
196
- # * `:account_id` - *required* - (String)
197
- # * `:vault_name` - *required* - (String)
198
- # * `:upload_id_marker` - (String)
199
- # * `:limit` - (Integer)
209
+ #
210
+ # * `:account_id` - *required* - (String)
211
+ # * `:vault_name` - *required* - (String)
212
+ # * `:upload_id_marker` - (String)
213
+ # * `:limit` - (Integer)
200
214
  # @return [Core::Response]
201
215
  # The #data method of the response object returns
202
216
  # a hash with the following structure:
@@ -212,11 +226,12 @@ module AWS
212
226
  # @!method list_parts(options = {})
213
227
  # Calls the GET ListParts API operation.
214
228
  # @param [Hash] options
215
- # * `:account_id` - *required* - (String)
216
- # * `:vault_name` - *required* - (String)
217
- # * `:upload_id` - *required* - (String)
218
- # * `:marker` - (String)
219
- # * `:limit` - (Integer)
229
+ #
230
+ # * `:account_id` - *required* - (String)
231
+ # * `:vault_name` - *required* - (String)
232
+ # * `:upload_id` - *required* - (String)
233
+ # * `:marker` - (String)
234
+ # * `:limit` - (Integer)
220
235
  # @return [Core::Response]
221
236
  # The #data method of the response object returns
222
237
  # a hash with the following structure:
@@ -234,9 +249,10 @@ module AWS
234
249
  # @!method list_vaults(options = {})
235
250
  # Calls the GET ListVaults API operation.
236
251
  # @param [Hash] options
237
- # * `:account_id` - *required* - (String)
238
- # * `:marker` - (String)
239
- # * `:limit` - (Integer)
252
+ #
253
+ # * `:account_id` - *required* - (String)
254
+ # * `:marker` - (String)
255
+ # * `:limit` - (Integer)
240
256
  # @return [Core::Response]
241
257
  # The #data method of the response object returns
242
258
  # a hash with the following structure:
@@ -253,34 +269,37 @@ module AWS
253
269
  # @!method set_vault_notifications(options = {})
254
270
  # Calls the PUT SetVaultNotifications API operation.
255
271
  # @param [Hash] options
256
- # * `:account_id` - *required* - (String)
257
- # * `:vault_name` - *required* - (String)
258
- # * `:vault_notification_config` - *required* - (Hash)
259
- # * `:sns_topic` - (String)
260
- # * `:events` - (Array<String>)
272
+ #
273
+ # * `:account_id` - *required* - (String)
274
+ # * `:vault_name` - *required* - (String)
275
+ # * `:vault_notification_config` - *required* - (Hash)
276
+ # * `:sns_topic` - (String)
277
+ # * `:events` - (Array<String>)
261
278
  # @return [Core::Response]
262
279
 
263
280
  # @!method upload_archive(options = {})
264
281
  # Calls the POST UploadArchive API operation.
265
282
  # @param [Hash] options
266
- # * `:vault_name` - *required* - (String)
267
- # * `:account_id` - *required* - (String)
268
- # * `:archive_description` - (String)
269
- # * `:checksum` - *required* - (String)
270
- # * `:body` - *required* - (IO)
271
- # * `:content_sha256` - (String)
283
+ #
284
+ # * `:vault_name` - *required* - (String)
285
+ # * `:account_id` - *required* - (String)
286
+ # * `:archive_description` - (String)
287
+ # * `:checksum` - *required* - (String)
288
+ # * `:body` - *required* - (IO)
289
+ # * `:content_sha256` - (String)
272
290
  # @return [Core::Response]
273
291
 
274
292
  # @!method upload_multipart_part(options = {})
275
293
  # Calls the PUT UploadMultipartPart API operation.
276
294
  # @param [Hash] options
277
- # * `:account_id` - *required* - (String)
278
- # * `:vault_name` - *required* - (String)
279
- # * `:upload_id` - *required* - (String)
280
- # * `:checksum` - *required* - (String)
281
- # * `:range` - (String)
282
- # * `:body` - *required* - (IO)
283
- # * `:content_sha256` - (String)
295
+ #
296
+ # * `:account_id` - *required* - (String)
297
+ # * `:vault_name` - *required* - (String)
298
+ # * `:upload_id` - *required* - (String)
299
+ # * `:checksum` - *required* - (String)
300
+ # * `:range` - (String)
301
+ # * `:body` - *required* - (IO)
302
+ # * `:content_sha256` - (String)
284
303
  # @return [Core::Response]
285
304
 
286
305
  # end client methods #
@@ -39,6 +39,7 @@ module AWS
39
39
  # @!method add_role_to_instance_profile(options = {})
40
40
  # Calls the AddRoleToInstanceProfile API operation.
41
41
  # @param [Hash] options
42
+ #
42
43
  # * `:instance_profile_name` - *required* - (String) Name of the
43
44
  # instance profile to update.
44
45
  # * `:role_name` - *required* - (String) Name of the role to add.
@@ -47,6 +48,7 @@ module AWS
47
48
  # @!method add_user_to_group(options = {})
48
49
  # Calls the AddUserToGroup API operation.
49
50
  # @param [Hash] options
51
+ #
50
52
  # * `:group_name` - *required* - (String) Name of the group to update.
51
53
  # * `:user_name` - *required* - (String) Name of the user to add.
52
54
  # @return [Core::Response]
@@ -54,6 +56,7 @@ module AWS
54
56
  # @!method change_password(options = {})
55
57
  # Calls the ChangePassword API operation.
56
58
  # @param [Hash] options
59
+ #
57
60
  # * `:old_password` - *required* - (String)
58
61
  # * `:new_password` - *required* - (String)
59
62
  # @return [Core::Response]
@@ -61,6 +64,7 @@ module AWS
61
64
  # @!method create_access_key(options = {})
62
65
  # Calls the CreateAccessKey API operation.
63
66
  # @param [Hash] options
67
+ #
64
68
  # * `:user_name` - (String) The user name that the new key will belong
65
69
  # to.
66
70
  # @return [Core::Response]
@@ -77,6 +81,7 @@ module AWS
77
81
  # @!method create_account_alias(options = {})
78
82
  # Calls the CreateAccountAlias API operation.
79
83
  # @param [Hash] options
84
+ #
80
85
  # * `:account_alias` - *required* - (String) Name of the account alias
81
86
  # to create.
82
87
  # @return [Core::Response]
@@ -84,6 +89,7 @@ module AWS
84
89
  # @!method create_group(options = {})
85
90
  # Calls the CreateGroup API operation.
86
91
  # @param [Hash] options
92
+ #
87
93
  # * `:path` - (String) The path to the group. For more information
88
94
  # about paths, see Identifiers for IAM Entities in Using AWS Identity
89
95
  # and Access Management. This parameter is optional. If it is not
@@ -104,6 +110,7 @@ module AWS
104
110
  # @!method create_instance_profile(options = {})
105
111
  # Calls the CreateInstanceProfile API operation.
106
112
  # @param [Hash] options
113
+ #
107
114
  # * `:instance_profile_name` - *required* - (String) Name of the
108
115
  # instance profile to create.
109
116
  # * `:path` - (String) The path to the instance profile. For more
@@ -131,6 +138,7 @@ module AWS
131
138
  # @!method create_login_profile(options = {})
132
139
  # Calls the CreateLoginProfile API operation.
133
140
  # @param [Hash] options
141
+ #
134
142
  # * `:user_name` - *required* - (String) Name of the user to create a
135
143
  # password for.
136
144
  # * `:password` - *required* - (String) The new password for the user
@@ -146,6 +154,7 @@ module AWS
146
154
  # @!method create_role(options = {})
147
155
  # Calls the CreateRole API operation.
148
156
  # @param [Hash] options
157
+ #
149
158
  # * `:path` - (String) The path to the role. For more information about
150
159
  # paths, see Identifiers for IAM Entities in Using AWS Identity and
151
160
  # Access Management. This parameter is optional. If it is not
@@ -168,6 +177,7 @@ module AWS
168
177
  # @!method create_user(options = {})
169
178
  # Calls the CreateUser API operation.
170
179
  # @param [Hash] options
180
+ #
171
181
  # * `:path` - (String) The path for the user name. For more information
172
182
  # about paths, see Identifiers for IAM Entities in Using AWS Identity
173
183
  # and Access Management. This parameter is optional. If it is not
@@ -187,6 +197,7 @@ module AWS
187
197
  # @!method create_virtual_mfa_device(options = {})
188
198
  # Calls the CreateVirtualMFADevice API operation.
189
199
  # @param [Hash] options
200
+ #
190
201
  # * `:path` - (String) The path for the virtual MFA device. For more
191
202
  # information about paths, see Identifiers for IAM Entities in Using
192
203
  # AWS Identity and Access Management. This parameter is optional. If
@@ -213,6 +224,7 @@ module AWS
213
224
  # @!method deactivate_mfa_device(options = {})
214
225
  # Calls the DeactivateMFADevice API operation.
215
226
  # @param [Hash] options
227
+ #
216
228
  # * `:user_name` - *required* - (String) Name of the user whose MFA
217
229
  # device you want to deactivate.
218
230
  # * `:serial_number` - *required* - (String) The serial number that
@@ -223,6 +235,7 @@ module AWS
223
235
  # @!method delete_access_key(options = {})
224
236
  # Calls the DeleteAccessKey API operation.
225
237
  # @param [Hash] options
238
+ #
226
239
  # * `:user_name` - (String) Name of the user whose key you want to
227
240
  # delete.
228
241
  # * `:access_key_id` - *required* - (String) The Access Key ID for the
@@ -232,6 +245,7 @@ module AWS
232
245
  # @!method delete_account_alias(options = {})
233
246
  # Calls the DeleteAccountAlias API operation.
234
247
  # @param [Hash] options
248
+ #
235
249
  # * `:account_alias` - *required* - (String) Name of the account alias
236
250
  # to delete.
237
251
  # @return [Core::Response]
@@ -239,17 +253,20 @@ module AWS
239
253
  # @!method delete_account_password_policy(options = {})
240
254
  # Calls the DeleteAccountPasswordPolicy API operation.
241
255
  # @param [Hash] options
256
+ #
242
257
  # @return [Core::Response]
243
258
 
244
259
  # @!method delete_group(options = {})
245
260
  # Calls the DeleteGroup API operation.
246
261
  # @param [Hash] options
262
+ #
247
263
  # * `:group_name` - *required* - (String) Name of the group to delete.
248
264
  # @return [Core::Response]
249
265
 
250
266
  # @!method delete_group_policy(options = {})
251
267
  # Calls the DeleteGroupPolicy API operation.
252
268
  # @param [Hash] options
269
+ #
253
270
  # * `:group_name` - *required* - (String) Name of the group the policy
254
271
  # is associated with.
255
272
  # * `:policy_name` - *required* - (String) Name of the policy document
@@ -259,6 +276,7 @@ module AWS
259
276
  # @!method delete_instance_profile(options = {})
260
277
  # Calls the DeleteInstanceProfile API operation.
261
278
  # @param [Hash] options
279
+ #
262
280
  # * `:instance_profile_name` - *required* - (String) Name of the
263
281
  # instance profile to delete.
264
282
  # @return [Core::Response]
@@ -266,6 +284,7 @@ module AWS
266
284
  # @!method delete_login_profile(options = {})
267
285
  # Calls the DeleteLoginProfile API operation.
268
286
  # @param [Hash] options
287
+ #
269
288
  # * `:user_name` - *required* - (String) Name of the user whose
270
289
  # password you want to delete.
271
290
  # @return [Core::Response]
@@ -273,12 +292,14 @@ module AWS
273
292
  # @!method delete_role(options = {})
274
293
  # Calls the DeleteRole API operation.
275
294
  # @param [Hash] options
295
+ #
276
296
  # * `:role_name` - *required* - (String) Name of the role to delete.
277
297
  # @return [Core::Response]
278
298
 
279
299
  # @!method delete_role_policy(options = {})
280
300
  # Calls the DeleteRolePolicy API operation.
281
301
  # @param [Hash] options
302
+ #
282
303
  # * `:role_name` - *required* - (String) Name of the role the
283
304
  # associated with the policy.
284
305
  # * `:policy_name` - *required* - (String) Name of the policy document
@@ -288,6 +309,7 @@ module AWS
288
309
  # @!method delete_server_certificate(options = {})
289
310
  # Calls the DeleteServerCertificate API operation.
290
311
  # @param [Hash] options
312
+ #
291
313
  # * `:server_certificate_name` - *required* - (String) The name of the
292
314
  # server certificate you want to delete.
293
315
  # @return [Core::Response]
@@ -295,6 +317,7 @@ module AWS
295
317
  # @!method delete_signing_certificate(options = {})
296
318
  # Calls the DeleteSigningCertificate API operation.
297
319
  # @param [Hash] options
320
+ #
298
321
  # * `:user_name` - (String) Name of the user the signing certificate
299
322
  # belongs to.
300
323
  # * `:certificate_id` - *required* - (String) ID of the signing
@@ -304,12 +327,14 @@ module AWS
304
327
  # @!method delete_user(options = {})
305
328
  # Calls the DeleteUser API operation.
306
329
  # @param [Hash] options
330
+ #
307
331
  # * `:user_name` - *required* - (String) Name of the user to delete.
308
332
  # @return [Core::Response]
309
333
 
310
334
  # @!method delete_user_policy(options = {})
311
335
  # Calls the DeleteUserPolicy API operation.
312
336
  # @param [Hash] options
337
+ #
313
338
  # * `:user_name` - *required* - (String) Name of the user the policy is
314
339
  # associated with.
315
340
  # * `:policy_name` - *required* - (String) Name of the policy document
@@ -319,6 +344,7 @@ module AWS
319
344
  # @!method delete_virtual_mfa_device(options = {})
320
345
  # Calls the DeleteVirtualMFADevice API operation.
321
346
  # @param [Hash] options
347
+ #
322
348
  # * `:serial_number` - *required* - (String) The serial number that
323
349
  # uniquely identifies the MFA device. For virtual MFA devices, the
324
350
  # serial number is the same as the ARN.
@@ -327,6 +353,7 @@ module AWS
327
353
  # @!method enable_mfa_device(options = {})
328
354
  # Calls the EnableMFADevice API operation.
329
355
  # @param [Hash] options
356
+ #
330
357
  # * `:user_name` - *required* - (String) Name of the user for whom you
331
358
  # want to enable the MFA device.
332
359
  # * `:serial_number` - *required* - (String) The serial number that
@@ -341,6 +368,7 @@ module AWS
341
368
  # @!method get_account_password_policy(options = {})
342
369
  # Calls the GetAccountPasswordPolicy API operation.
343
370
  # @param [Hash] options
371
+ #
344
372
  # @return [Core::Response]
345
373
  # The #data method of the response object returns
346
374
  # a hash with the following structure:
@@ -356,6 +384,7 @@ module AWS
356
384
  # @!method get_account_summary(options = {})
357
385
  # Calls the GetAccountSummary API operation.
358
386
  # @param [Hash] options
387
+ #
359
388
  # @return [Core::Response]
360
389
  # The #data method of the response object returns
361
390
  # a hash with the following structure:
@@ -365,6 +394,7 @@ module AWS
365
394
  # @!method get_group(options = {})
366
395
  # Calls the GetGroup API operation.
367
396
  # @param [Hash] options
397
+ #
368
398
  # * `:group_name` - *required* - (String) Name of the group.
369
399
  # * `:marker` - (String) Use this only when paginating results, and
370
400
  # only in a subsequent request after you've received a response where
@@ -396,6 +426,7 @@ module AWS
396
426
  # @!method get_group_policy(options = {})
397
427
  # Calls the GetGroupPolicy API operation.
398
428
  # @param [Hash] options
429
+ #
399
430
  # * `:group_name` - *required* - (String) Name of the group the policy
400
431
  # is associated with.
401
432
  # * `:policy_name` - *required* - (String) Name of the policy document
@@ -411,6 +442,7 @@ module AWS
411
442
  # @!method get_instance_profile(options = {})
412
443
  # Calls the GetInstanceProfile API operation.
413
444
  # @param [Hash] options
445
+ #
414
446
  # * `:instance_profile_name` - *required* - (String) Name of the
415
447
  # instance profile to get information about.
416
448
  # @return [Core::Response]
@@ -434,6 +466,7 @@ module AWS
434
466
  # @!method get_login_profile(options = {})
435
467
  # Calls the GetLoginProfile API operation.
436
468
  # @param [Hash] options
469
+ #
437
470
  # * `:user_name` - *required* - (String) Name of the user whose login
438
471
  # profile you want to retrieve.
439
472
  # @return [Core::Response]
@@ -447,6 +480,7 @@ module AWS
447
480
  # @!method get_role(options = {})
448
481
  # Calls the GetRole API operation.
449
482
  # @param [Hash] options
483
+ #
450
484
  # * `:role_name` - *required* - (String) Name of the role to get
451
485
  # information about.
452
486
  # @return [Core::Response]
@@ -464,6 +498,7 @@ module AWS
464
498
  # @!method get_role_policy(options = {})
465
499
  # Calls the GetRolePolicy API operation.
466
500
  # @param [Hash] options
501
+ #
467
502
  # * `:role_name` - *required* - (String) Name of the role associated
468
503
  # with the policy.
469
504
  # * `:policy_name` - *required* - (String) Name of the policy document
@@ -479,6 +514,7 @@ module AWS
479
514
  # @!method get_server_certificate(options = {})
480
515
  # Calls the GetServerCertificate API operation.
481
516
  # @param [Hash] options
517
+ #
482
518
  # * `:server_certificate_name` - *required* - (String) The name of the
483
519
  # server certificate you want to retrieve information about.
484
520
  # @return [Core::Response]
@@ -498,6 +534,7 @@ module AWS
498
534
  # @!method get_user(options = {})
499
535
  # Calls the GetUser API operation.
500
536
  # @param [Hash] options
537
+ #
501
538
  # * `:user_name` - (String) Name of the user to get information about.
502
539
  # This parameter is optional. If it is not included, it defaults to
503
540
  # the user making the request.
@@ -515,6 +552,7 @@ module AWS
515
552
  # @!method get_user_policy(options = {})
516
553
  # Calls the GetUserPolicy API operation.
517
554
  # @param [Hash] options
555
+ #
518
556
  # * `:user_name` - *required* - (String) Name of the user who the
519
557
  # policy is associated with.
520
558
  # * `:policy_name` - *required* - (String) Name of the policy document
@@ -530,6 +568,7 @@ module AWS
530
568
  # @!method list_access_keys(options = {})
531
569
  # Calls the ListAccessKeys API operation.
532
570
  # @param [Hash] options
571
+ #
533
572
  # * `:user_name` - (String) Name of the user.
534
573
  # * `:marker` - (String) Use this parameter only when paginating
535
574
  # results, and only in a subsequent request after you've received a
@@ -554,6 +593,7 @@ module AWS
554
593
  # @!method list_account_aliases(options = {})
555
594
  # Calls the ListAccountAliases API operation.
556
595
  # @param [Hash] options
596
+ #
557
597
  # * `:marker` - (String) Use this only when paginating results, and
558
598
  # only in a subsequent request after you've received a response where
559
599
  # the results are truncated. Set it to the value of the Marker
@@ -573,6 +613,7 @@ module AWS
573
613
  # @!method list_group_policies(options = {})
574
614
  # Calls the ListGroupPolicies API operation.
575
615
  # @param [Hash] options
616
+ #
576
617
  # * `:group_name` - *required* - (String) The name of the group to list
577
618
  # policies for.
578
619
  # * `:marker` - (String) Use this only when paginating results, and
@@ -594,6 +635,7 @@ module AWS
594
635
  # @!method list_groups(options = {})
595
636
  # Calls the ListGroups API operation.
596
637
  # @param [Hash] options
638
+ #
597
639
  # * `:path_prefix` - (String) The path prefix for filtering the
598
640
  # results. For example: /division_abc/subdivision_xyz/, which would
599
641
  # get all groups whose path starts with
@@ -623,6 +665,7 @@ module AWS
623
665
  # @!method list_groups_for_user(options = {})
624
666
  # Calls the ListGroupsForUser API operation.
625
667
  # @param [Hash] options
668
+ #
626
669
  # * `:user_name` - *required* - (String) The name of the user to list
627
670
  # groups for.
628
671
  # * `:marker` - (String) Use this only when paginating results, and
@@ -649,6 +692,7 @@ module AWS
649
692
  # @!method list_instance_profiles(options = {})
650
693
  # Calls the ListInstanceProfiles API operation.
651
694
  # @param [Hash] options
695
+ #
652
696
  # * `:path_prefix` - (String) The path prefix for filtering the
653
697
  # results. For example: /application_abc/component_xyz/, which would
654
698
  # get all instance profiles whose path starts with
@@ -686,6 +730,7 @@ module AWS
686
730
  # @!method list_instance_profiles_for_role(options = {})
687
731
  # Calls the ListInstanceProfilesForRole API operation.
688
732
  # @param [Hash] options
733
+ #
689
734
  # * `:role_name` - *required* - (String) The name of the role to list
690
735
  # instance profiles for.
691
736
  # * `:marker` - (String) Use this parameter only when paginating
@@ -719,6 +764,7 @@ module AWS
719
764
  # @!method list_mfa_devices(options = {})
720
765
  # Calls the ListMFADevices API operation.
721
766
  # @param [Hash] options
767
+ #
722
768
  # * `:user_name` - (String) Name of the user whose MFA devices you want
723
769
  # to list.
724
770
  # * `:marker` - (String) Use this only when paginating results, and
@@ -743,6 +789,7 @@ module AWS
743
789
  # @!method list_role_policies(options = {})
744
790
  # Calls the ListRolePolicies API operation.
745
791
  # @param [Hash] options
792
+ #
746
793
  # * `:role_name` - *required* - (String) The name of the role to list
747
794
  # policies for.
748
795
  # * `:marker` - (String) Use this parameter only when paginating
@@ -764,6 +811,7 @@ module AWS
764
811
  # @!method list_roles(options = {})
765
812
  # Calls the ListRoles API operation.
766
813
  # @param [Hash] options
814
+ #
767
815
  # * `:path_prefix` - (String) The path prefix for filtering the
768
816
  # results. For example: /application_abc/component_xyz/, which would
769
817
  # get all roles whose path starts with
@@ -794,6 +842,7 @@ module AWS
794
842
  # @!method list_server_certificates(options = {})
795
843
  # Calls the ListServerCertificates API operation.
796
844
  # @param [Hash] options
845
+ #
797
846
  # * `:path_prefix` - (String) The path prefix for filtering the
798
847
  # results. For example: /company/servercerts would get all server
799
848
  # certificates for which the path starts with /company/servercerts.
@@ -824,6 +873,7 @@ module AWS
824
873
  # @!method list_signing_certificates(options = {})
825
874
  # Calls the ListSigningCertificates API operation.
826
875
  # @param [Hash] options
876
+ #
827
877
  # * `:user_name` - (String) The name of the user.
828
878
  # * `:marker` - (String) Use this only when paginating results, and
829
879
  # only in a subsequent request after you've received a response where
@@ -849,6 +899,7 @@ module AWS
849
899
  # @!method list_user_policies(options = {})
850
900
  # Calls the ListUserPolicies API operation.
851
901
  # @param [Hash] options
902
+ #
852
903
  # * `:user_name` - *required* - (String) The name of the user to list
853
904
  # policies for.
854
905
  # * `:marker` - (String) Use this only when paginating results, and
@@ -870,6 +921,7 @@ module AWS
870
921
  # @!method list_users(options = {})
871
922
  # Calls the ListUsers API operation.
872
923
  # @param [Hash] options
924
+ #
873
925
  # * `:path_prefix` - (String) The path prefix for filtering the
874
926
  # results. For example: /division_abc/subdivision_xyz/, which would
875
927
  # get all user names whose path starts with
@@ -900,13 +952,11 @@ module AWS
900
952
  # @!method list_virtual_mfa_devices(options = {})
901
953
  # Calls the ListVirtualMFADevices API operation.
902
954
  # @param [Hash] options
955
+ #
903
956
  # * `:assignment_status` - (String) The status (unassigned or assigned)
904
957
  # of the devices to list. If you do not specify an AssignmentStatus,
905
958
  # the action defaults to Any which lists both assigned and unassigned
906
- # virtual MFA devices. Valid values include:
907
- # * `Assigned`
908
- # * `Unassigned`
909
- # * `Any`
959
+ # virtual MFA devices.
910
960
  # * `:marker` - (String) Use this parameter only when paginating
911
961
  # results, and only in a subsequent request after you've received a
912
962
  # response where the results are truncated. Set it to the value of
@@ -936,6 +986,7 @@ module AWS
936
986
  # @!method put_group_policy(options = {})
937
987
  # Calls the PutGroupPolicy API operation.
938
988
  # @param [Hash] options
989
+ #
939
990
  # * `:group_name` - *required* - (String) Name of the group to
940
991
  # associate the policy with.
941
992
  # * `:policy_name` - *required* - (String) Name of the policy document.
@@ -945,6 +996,7 @@ module AWS
945
996
  # @!method put_role_policy(options = {})
946
997
  # Calls the PutRolePolicy API operation.
947
998
  # @param [Hash] options
999
+ #
948
1000
  # * `:role_name` - *required* - (String) Name of the role to associate
949
1001
  # the policy with.
950
1002
  # * `:policy_name` - *required* - (String) Name of the policy document.
@@ -954,6 +1006,7 @@ module AWS
954
1006
  # @!method put_user_policy(options = {})
955
1007
  # Calls the PutUserPolicy API operation.
956
1008
  # @param [Hash] options
1009
+ #
957
1010
  # * `:user_name` - *required* - (String) Name of the user to associate
958
1011
  # the policy with.
959
1012
  # * `:policy_name` - *required* - (String) Name of the policy document.
@@ -963,6 +1016,7 @@ module AWS
963
1016
  # @!method remove_role_from_instance_profile(options = {})
964
1017
  # Calls the RemoveRoleFromInstanceProfile API operation.
965
1018
  # @param [Hash] options
1019
+ #
966
1020
  # * `:instance_profile_name` - *required* - (String) Name of the
967
1021
  # instance profile to update.
968
1022
  # * `:role_name` - *required* - (String) Name of the role to remove.
@@ -971,6 +1025,7 @@ module AWS
971
1025
  # @!method remove_user_from_group(options = {})
972
1026
  # Calls the RemoveUserFromGroup API operation.
973
1027
  # @param [Hash] options
1028
+ #
974
1029
  # * `:group_name` - *required* - (String) Name of the group to update.
975
1030
  # * `:user_name` - *required* - (String) Name of the user to remove.
976
1031
  # @return [Core::Response]
@@ -978,6 +1033,7 @@ module AWS
978
1033
  # @!method resync_mfa_device(options = {})
979
1034
  # Calls the ResyncMFADevice API operation.
980
1035
  # @param [Hash] options
1036
+ #
981
1037
  # * `:user_name` - *required* - (String) Name of the user whose MFA
982
1038
  # device you want to resynchronize.
983
1039
  # * `:serial_number` - *required* - (String) Serial number that
@@ -991,21 +1047,20 @@ module AWS
991
1047
  # @!method update_access_key(options = {})
992
1048
  # Calls the UpdateAccessKey API operation.
993
1049
  # @param [Hash] options
1050
+ #
994
1051
  # * `:user_name` - (String) Name of the user whose key you want to
995
1052
  # update.
996
1053
  # * `:access_key_id` - *required* - (String) The Access Key ID of the
997
1054
  # Secret Access Key you want to update.
998
1055
  # * `:status` - *required* - (String) The status you want to assign to
999
1056
  # the Secret Access Key. Active means the key can be used for API
1000
- # calls to AWS, while Inactive means the key cannot be used. Valid
1001
- # values include:
1002
- # * `Active`
1003
- # * `Inactive`
1057
+ # calls to AWS, while Inactive means the key cannot be used.
1004
1058
  # @return [Core::Response]
1005
1059
 
1006
1060
  # @!method update_account_password_policy(options = {})
1007
1061
  # Calls the UpdateAccountPasswordPolicy API operation.
1008
1062
  # @param [Hash] options
1063
+ #
1009
1064
  # * `:minimum_password_length` - (Integer)
1010
1065
  # * `:require_symbols` - (Boolean)
1011
1066
  # * `:require_numbers` - (Boolean)
@@ -1017,6 +1072,7 @@ module AWS
1017
1072
  # @!method update_assume_role_policy(options = {})
1018
1073
  # Calls the UpdateAssumeRolePolicy API operation.
1019
1074
  # @param [Hash] options
1075
+ #
1020
1076
  # * `:role_name` - *required* - (String) Name of the role to update.
1021
1077
  # * `:policy_document` - *required* - (String) The policy that grants
1022
1078
  # an entity permission to assume the role.
@@ -1025,6 +1081,7 @@ module AWS
1025
1081
  # @!method update_group(options = {})
1026
1082
  # Calls the UpdateGroup API operation.
1027
1083
  # @param [Hash] options
1084
+ #
1028
1085
  # * `:group_name` - *required* - (String) Name of the group to update.
1029
1086
  # If you're changing the name of the group, this is the original
1030
1087
  # name.
@@ -1037,6 +1094,7 @@ module AWS
1037
1094
  # @!method update_login_profile(options = {})
1038
1095
  # Calls the UpdateLoginProfile API operation.
1039
1096
  # @param [Hash] options
1097
+ #
1040
1098
  # * `:user_name` - *required* - (String) Name of the user whose
1041
1099
  # password you want to update.
1042
1100
  # * `:password` - (String) The new password for the user name.
@@ -1045,6 +1103,7 @@ module AWS
1045
1103
  # @!method update_server_certificate(options = {})
1046
1104
  # Calls the UpdateServerCertificate API operation.
1047
1105
  # @param [Hash] options
1106
+ #
1048
1107
  # * `:server_certificate_name` - *required* - (String) The name of the
1049
1108
  # server certificate that you want to update.
1050
1109
  # * `:new_path` - (String) The new path for the server certificate.
@@ -1058,6 +1117,7 @@ module AWS
1058
1117
  # @!method update_signing_certificate(options = {})
1059
1118
  # Calls the UpdateSigningCertificate API operation.
1060
1119
  # @param [Hash] options
1120
+ #
1061
1121
  # * `:user_name` - (String) Name of the user the signing certificate
1062
1122
  # belongs to.
1063
1123
  # * `:certificate_id` - *required* - (String) The ID of the signing
@@ -1065,14 +1125,12 @@ module AWS
1065
1125
  # * `:status` - *required* - (String) The status you want to assign to
1066
1126
  # the certificate. Active means the certificate can be used for API
1067
1127
  # calls to AWS, while Inactive means the certificate cannot be used.
1068
- # Valid values include:
1069
- # * `Active`
1070
- # * `Inactive`
1071
1128
  # @return [Core::Response]
1072
1129
 
1073
1130
  # @!method update_user(options = {})
1074
1131
  # Calls the UpdateUser API operation.
1075
1132
  # @param [Hash] options
1133
+ #
1076
1134
  # * `:user_name` - *required* - (String) Name of the user to update. If
1077
1135
  # you're changing the name of the user, this is the original user
1078
1136
  # name.
@@ -1085,6 +1143,7 @@ module AWS
1085
1143
  # @!method upload_server_certificate(options = {})
1086
1144
  # Calls the UploadServerCertificate API operation.
1087
1145
  # @param [Hash] options
1146
+ #
1088
1147
  # * `:path` - (String) The path for the server certificate. For more
1089
1148
  # information about paths, see Identifiers for IAM Entities in Using
1090
1149
  # AWS Identity and Access Management. This parameter is optional. If
@@ -1112,6 +1171,7 @@ module AWS
1112
1171
  # @!method upload_signing_certificate(options = {})
1113
1172
  # Calls the UploadSigningCertificate API operation.
1114
1173
  # @param [Hash] options
1174
+ #
1115
1175
  # * `:user_name` - (String) Name of the user the signing certificate is
1116
1176
  # for.
1117
1177
  # * `:certificate_body` - *required* - (String) The contents of the