aws-sdk-licensemanagerusersubscriptions 1.0.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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions/client.rb +904 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions/client_api.rb +422 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions/customizations.rb +0 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions/errors.rb +150 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions/resource.rb +26 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions/types.rb +885 -0
- data/lib/aws-sdk-licensemanagerusersubscriptions.rb +53 -0
- metadata +90 -0
@@ -0,0 +1,885 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::LicenseManagerUserSubscriptions
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Details about an Active Directory identity provider.
|
27
|
+
#
|
28
|
+
# @note When making an API call, you may pass ActiveDirectoryIdentityProvider
|
29
|
+
# data as a hash:
|
30
|
+
#
|
31
|
+
# {
|
32
|
+
# directory_id: "String",
|
33
|
+
# }
|
34
|
+
#
|
35
|
+
# @!attribute [rw] directory_id
|
36
|
+
# The directory ID for an Active Directory identity provider.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ActiveDirectoryIdentityProvider AWS API Documentation
|
40
|
+
#
|
41
|
+
class ActiveDirectoryIdentityProvider < Struct.new(
|
42
|
+
:directory_id)
|
43
|
+
SENSITIVE = []
|
44
|
+
include Aws::Structure
|
45
|
+
end
|
46
|
+
|
47
|
+
# @note When making an API call, you may pass AssociateUserRequest
|
48
|
+
# data as a hash:
|
49
|
+
#
|
50
|
+
# {
|
51
|
+
# domain: "String",
|
52
|
+
# identity_provider: { # required
|
53
|
+
# active_directory_identity_provider: {
|
54
|
+
# directory_id: "String",
|
55
|
+
# },
|
56
|
+
# },
|
57
|
+
# instance_id: "String", # required
|
58
|
+
# username: "String", # required
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# @!attribute [rw] domain
|
62
|
+
# The domain name of the user.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] identity_provider
|
66
|
+
# The identity provider of the user.
|
67
|
+
# @return [Types::IdentityProvider]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] instance_id
|
70
|
+
# The ID of the EC2 instance, which provides user-based subscriptions.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] username
|
74
|
+
# The user name from the identity provider for the user.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/AssociateUserRequest AWS API Documentation
|
78
|
+
#
|
79
|
+
class AssociateUserRequest < Struct.new(
|
80
|
+
:domain,
|
81
|
+
:identity_provider,
|
82
|
+
:instance_id,
|
83
|
+
:username)
|
84
|
+
SENSITIVE = []
|
85
|
+
include Aws::Structure
|
86
|
+
end
|
87
|
+
|
88
|
+
# @!attribute [rw] instance_user_summary
|
89
|
+
# Metadata that describes the associate user operation.
|
90
|
+
# @return [Types::InstanceUserSummary]
|
91
|
+
#
|
92
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/AssociateUserResponse AWS API Documentation
|
93
|
+
#
|
94
|
+
class AssociateUserResponse < Struct.new(
|
95
|
+
:instance_user_summary)
|
96
|
+
SENSITIVE = []
|
97
|
+
include Aws::Structure
|
98
|
+
end
|
99
|
+
|
100
|
+
# The request couldn't be completed because it conflicted with the
|
101
|
+
# current state of the resource.
|
102
|
+
#
|
103
|
+
# @!attribute [rw] message
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ConflictException AWS API Documentation
|
107
|
+
#
|
108
|
+
class ConflictException < Struct.new(
|
109
|
+
:message)
|
110
|
+
SENSITIVE = []
|
111
|
+
include Aws::Structure
|
112
|
+
end
|
113
|
+
|
114
|
+
# @note When making an API call, you may pass DeregisterIdentityProviderRequest
|
115
|
+
# data as a hash:
|
116
|
+
#
|
117
|
+
# {
|
118
|
+
# identity_provider: { # required
|
119
|
+
# active_directory_identity_provider: {
|
120
|
+
# directory_id: "String",
|
121
|
+
# },
|
122
|
+
# },
|
123
|
+
# product: "String", # required
|
124
|
+
# }
|
125
|
+
#
|
126
|
+
# @!attribute [rw] identity_provider
|
127
|
+
# An object that specifies details for the identity provider.
|
128
|
+
# @return [Types::IdentityProvider]
|
129
|
+
#
|
130
|
+
# @!attribute [rw] product
|
131
|
+
# The name of the user-based subscription product.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DeregisterIdentityProviderRequest AWS API Documentation
|
135
|
+
#
|
136
|
+
class DeregisterIdentityProviderRequest < Struct.new(
|
137
|
+
:identity_provider,
|
138
|
+
:product)
|
139
|
+
SENSITIVE = []
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
143
|
+
# @!attribute [rw] identity_provider_summary
|
144
|
+
# Metadata that describes the results of an identity provider
|
145
|
+
# operation.
|
146
|
+
# @return [Types::IdentityProviderSummary]
|
147
|
+
#
|
148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DeregisterIdentityProviderResponse AWS API Documentation
|
149
|
+
#
|
150
|
+
class DeregisterIdentityProviderResponse < Struct.new(
|
151
|
+
:identity_provider_summary)
|
152
|
+
SENSITIVE = []
|
153
|
+
include Aws::Structure
|
154
|
+
end
|
155
|
+
|
156
|
+
# @note When making an API call, you may pass DisassociateUserRequest
|
157
|
+
# data as a hash:
|
158
|
+
#
|
159
|
+
# {
|
160
|
+
# domain: "String",
|
161
|
+
# identity_provider: { # required
|
162
|
+
# active_directory_identity_provider: {
|
163
|
+
# directory_id: "String",
|
164
|
+
# },
|
165
|
+
# },
|
166
|
+
# instance_id: "String", # required
|
167
|
+
# username: "String", # required
|
168
|
+
# }
|
169
|
+
#
|
170
|
+
# @!attribute [rw] domain
|
171
|
+
# The domain name of the user.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] identity_provider
|
175
|
+
# An object that specifies details for the identity provider.
|
176
|
+
# @return [Types::IdentityProvider]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] instance_id
|
179
|
+
# The ID of the EC2 instance, which provides user-based subscriptions.
|
180
|
+
# @return [String]
|
181
|
+
#
|
182
|
+
# @!attribute [rw] username
|
183
|
+
# The user name from the identity provider for the user.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DisassociateUserRequest AWS API Documentation
|
187
|
+
#
|
188
|
+
class DisassociateUserRequest < Struct.new(
|
189
|
+
:domain,
|
190
|
+
:identity_provider,
|
191
|
+
:instance_id,
|
192
|
+
:username)
|
193
|
+
SENSITIVE = []
|
194
|
+
include Aws::Structure
|
195
|
+
end
|
196
|
+
|
197
|
+
# @!attribute [rw] instance_user_summary
|
198
|
+
# Metadata that describes the associate user operation.
|
199
|
+
# @return [Types::InstanceUserSummary]
|
200
|
+
#
|
201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DisassociateUserResponse AWS API Documentation
|
202
|
+
#
|
203
|
+
class DisassociateUserResponse < Struct.new(
|
204
|
+
:instance_user_summary)
|
205
|
+
SENSITIVE = []
|
206
|
+
include Aws::Structure
|
207
|
+
end
|
208
|
+
|
209
|
+
# A filter name and value pair that is used to return more specific
|
210
|
+
# results from a describe operation. Filters can be used to match a set
|
211
|
+
# of resources by specific criteria, such as tags, attributes, or IDs.
|
212
|
+
#
|
213
|
+
# @note When making an API call, you may pass Filter
|
214
|
+
# data as a hash:
|
215
|
+
#
|
216
|
+
# {
|
217
|
+
# attribute: "String",
|
218
|
+
# operation: "String",
|
219
|
+
# value: "String",
|
220
|
+
# }
|
221
|
+
#
|
222
|
+
# @!attribute [rw] attribute
|
223
|
+
# The name of an attribute to use as a filter.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] operation
|
227
|
+
# The type of search (For example, eq, geq, leq)
|
228
|
+
# @return [String]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] value
|
231
|
+
# Value of the filter.
|
232
|
+
# @return [String]
|
233
|
+
#
|
234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/Filter AWS API Documentation
|
235
|
+
#
|
236
|
+
class Filter < Struct.new(
|
237
|
+
:attribute,
|
238
|
+
:operation,
|
239
|
+
:value)
|
240
|
+
SENSITIVE = []
|
241
|
+
include Aws::Structure
|
242
|
+
end
|
243
|
+
|
244
|
+
# Details about an identity provider.
|
245
|
+
#
|
246
|
+
# @note IdentityProvider is a union - when making an API calls you must set exactly one of the members.
|
247
|
+
#
|
248
|
+
# @note IdentityProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IdentityProvider corresponding to the set member.
|
249
|
+
#
|
250
|
+
# @!attribute [rw] active_directory_identity_provider
|
251
|
+
# An object that details an Active Directory identity provider.
|
252
|
+
# @return [Types::ActiveDirectoryIdentityProvider]
|
253
|
+
#
|
254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/IdentityProvider AWS API Documentation
|
255
|
+
#
|
256
|
+
class IdentityProvider < Struct.new(
|
257
|
+
:active_directory_identity_provider,
|
258
|
+
:unknown)
|
259
|
+
SENSITIVE = []
|
260
|
+
include Aws::Structure
|
261
|
+
include Aws::Structure::Union
|
262
|
+
|
263
|
+
class ActiveDirectoryIdentityProvider < IdentityProvider; end
|
264
|
+
class Unknown < IdentityProvider; end
|
265
|
+
end
|
266
|
+
|
267
|
+
# Describes an identity provider.
|
268
|
+
#
|
269
|
+
# @!attribute [rw] failure_message
|
270
|
+
# The failure message associated with an identity provider.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] identity_provider
|
274
|
+
# An object that specifies details for the identity provider.
|
275
|
+
# @return [Types::IdentityProvider]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] product
|
278
|
+
# The name of the user-based subscription product.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] status
|
282
|
+
# The status of an identity provider.
|
283
|
+
# @return [String]
|
284
|
+
#
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/IdentityProviderSummary AWS API Documentation
|
286
|
+
#
|
287
|
+
class IdentityProviderSummary < Struct.new(
|
288
|
+
:failure_message,
|
289
|
+
:identity_provider,
|
290
|
+
:product,
|
291
|
+
:status)
|
292
|
+
SENSITIVE = []
|
293
|
+
include Aws::Structure
|
294
|
+
end
|
295
|
+
|
296
|
+
# Describes an EC2 instance providing user-based subscriptions.
|
297
|
+
#
|
298
|
+
# @!attribute [rw] instance_id
|
299
|
+
# The ID of the EC2 instance, which provides user-based subscriptions.
|
300
|
+
# @return [String]
|
301
|
+
#
|
302
|
+
# @!attribute [rw] last_status_check_date
|
303
|
+
# The date of the last status check.
|
304
|
+
# @return [String]
|
305
|
+
#
|
306
|
+
# @!attribute [rw] products
|
307
|
+
# A list of provided user-based subscription products.
|
308
|
+
# @return [Array<String>]
|
309
|
+
#
|
310
|
+
# @!attribute [rw] status
|
311
|
+
# The status of an EC2 instance resource.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] status_message
|
315
|
+
# The status message for an EC2 instance.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/InstanceSummary AWS API Documentation
|
319
|
+
#
|
320
|
+
class InstanceSummary < Struct.new(
|
321
|
+
:instance_id,
|
322
|
+
:last_status_check_date,
|
323
|
+
:products,
|
324
|
+
:status,
|
325
|
+
:status_message)
|
326
|
+
SENSITIVE = []
|
327
|
+
include Aws::Structure
|
328
|
+
end
|
329
|
+
|
330
|
+
# Describes users of an EC2 instance providing user-based subscriptions.
|
331
|
+
#
|
332
|
+
# @!attribute [rw] association_date
|
333
|
+
# The date a user was associated with an EC2 instance.
|
334
|
+
# @return [String]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] disassociation_date
|
337
|
+
# The date a user was disassociated from an EC2 instance.
|
338
|
+
# @return [String]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] domain
|
341
|
+
# The domain name of the user.
|
342
|
+
# @return [String]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] identity_provider
|
345
|
+
# An object that specifies details for the identity provider.
|
346
|
+
# @return [Types::IdentityProvider]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] instance_id
|
349
|
+
# The ID of the EC2 instance, which provides user-based subscriptions.
|
350
|
+
# @return [String]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] status
|
353
|
+
# The status of a user associated with an EC2 instance.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] status_message
|
357
|
+
# The status message for users of an EC2 instance.
|
358
|
+
# @return [String]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] username
|
361
|
+
# The user name from the identity provider for the user.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/InstanceUserSummary AWS API Documentation
|
365
|
+
#
|
366
|
+
class InstanceUserSummary < Struct.new(
|
367
|
+
:association_date,
|
368
|
+
:disassociation_date,
|
369
|
+
:domain,
|
370
|
+
:identity_provider,
|
371
|
+
:instance_id,
|
372
|
+
:status,
|
373
|
+
:status_message,
|
374
|
+
:username)
|
375
|
+
SENSITIVE = []
|
376
|
+
include Aws::Structure
|
377
|
+
end
|
378
|
+
|
379
|
+
# An exception occurred with the service.
|
380
|
+
#
|
381
|
+
# @!attribute [rw] message
|
382
|
+
# @return [String]
|
383
|
+
#
|
384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/InternalServerException AWS API Documentation
|
385
|
+
#
|
386
|
+
class InternalServerException < Struct.new(
|
387
|
+
:message)
|
388
|
+
SENSITIVE = []
|
389
|
+
include Aws::Structure
|
390
|
+
end
|
391
|
+
|
392
|
+
# @note When making an API call, you may pass ListIdentityProvidersRequest
|
393
|
+
# data as a hash:
|
394
|
+
#
|
395
|
+
# {
|
396
|
+
# max_results: 1,
|
397
|
+
# next_token: "String",
|
398
|
+
# }
|
399
|
+
#
|
400
|
+
# @!attribute [rw] max_results
|
401
|
+
# Maximum number of results to return in a single call.
|
402
|
+
# @return [Integer]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] next_token
|
405
|
+
# Token for the next set of results.
|
406
|
+
# @return [String]
|
407
|
+
#
|
408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListIdentityProvidersRequest AWS API Documentation
|
409
|
+
#
|
410
|
+
class ListIdentityProvidersRequest < Struct.new(
|
411
|
+
:max_results,
|
412
|
+
:next_token)
|
413
|
+
SENSITIVE = []
|
414
|
+
include Aws::Structure
|
415
|
+
end
|
416
|
+
|
417
|
+
# @!attribute [rw] identity_provider_summaries
|
418
|
+
# Metadata that describes the list identity providers operation.
|
419
|
+
# @return [Array<Types::IdentityProviderSummary>]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] next_token
|
422
|
+
# Token for the next set of results.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListIdentityProvidersResponse AWS API Documentation
|
426
|
+
#
|
427
|
+
class ListIdentityProvidersResponse < Struct.new(
|
428
|
+
:identity_provider_summaries,
|
429
|
+
:next_token)
|
430
|
+
SENSITIVE = []
|
431
|
+
include Aws::Structure
|
432
|
+
end
|
433
|
+
|
434
|
+
# @note When making an API call, you may pass ListInstancesRequest
|
435
|
+
# data as a hash:
|
436
|
+
#
|
437
|
+
# {
|
438
|
+
# filters: [
|
439
|
+
# {
|
440
|
+
# attribute: "String",
|
441
|
+
# operation: "String",
|
442
|
+
# value: "String",
|
443
|
+
# },
|
444
|
+
# ],
|
445
|
+
# max_results: 1,
|
446
|
+
# next_token: "String",
|
447
|
+
# }
|
448
|
+
#
|
449
|
+
# @!attribute [rw] filters
|
450
|
+
# An array of structures that you can use to filter the results to
|
451
|
+
# those that match one or more sets of key-value pairs that you
|
452
|
+
# specify.
|
453
|
+
# @return [Array<Types::Filter>]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] max_results
|
456
|
+
# Maximum number of results to return in a single call.
|
457
|
+
# @return [Integer]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] next_token
|
460
|
+
# Token for the next set of results.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListInstancesRequest AWS API Documentation
|
464
|
+
#
|
465
|
+
class ListInstancesRequest < Struct.new(
|
466
|
+
:filters,
|
467
|
+
:max_results,
|
468
|
+
:next_token)
|
469
|
+
SENSITIVE = []
|
470
|
+
include Aws::Structure
|
471
|
+
end
|
472
|
+
|
473
|
+
# @!attribute [rw] instance_summaries
|
474
|
+
# Metadata that describes the list instances operation.
|
475
|
+
# @return [Array<Types::InstanceSummary>]
|
476
|
+
#
|
477
|
+
# @!attribute [rw] next_token
|
478
|
+
# Token for the next set of results.
|
479
|
+
# @return [String]
|
480
|
+
#
|
481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListInstancesResponse AWS API Documentation
|
482
|
+
#
|
483
|
+
class ListInstancesResponse < Struct.new(
|
484
|
+
:instance_summaries,
|
485
|
+
:next_token)
|
486
|
+
SENSITIVE = []
|
487
|
+
include Aws::Structure
|
488
|
+
end
|
489
|
+
|
490
|
+
# @note When making an API call, you may pass ListProductSubscriptionsRequest
|
491
|
+
# data as a hash:
|
492
|
+
#
|
493
|
+
# {
|
494
|
+
# filters: [
|
495
|
+
# {
|
496
|
+
# attribute: "String",
|
497
|
+
# operation: "String",
|
498
|
+
# value: "String",
|
499
|
+
# },
|
500
|
+
# ],
|
501
|
+
# identity_provider: { # required
|
502
|
+
# active_directory_identity_provider: {
|
503
|
+
# directory_id: "String",
|
504
|
+
# },
|
505
|
+
# },
|
506
|
+
# max_results: 1,
|
507
|
+
# next_token: "String",
|
508
|
+
# product: "String", # required
|
509
|
+
# }
|
510
|
+
#
|
511
|
+
# @!attribute [rw] filters
|
512
|
+
# An array of structures that you can use to filter the results to
|
513
|
+
# those that match one or more sets of key-value pairs that you
|
514
|
+
# specify.
|
515
|
+
# @return [Array<Types::Filter>]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] identity_provider
|
518
|
+
# An object that specifies details for the identity provider.
|
519
|
+
# @return [Types::IdentityProvider]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] max_results
|
522
|
+
# Maximum number of results to return in a single call.
|
523
|
+
# @return [Integer]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] next_token
|
526
|
+
# Token for the next set of results.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @!attribute [rw] product
|
530
|
+
# The name of the user-based subscription product.
|
531
|
+
# @return [String]
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListProductSubscriptionsRequest AWS API Documentation
|
534
|
+
#
|
535
|
+
class ListProductSubscriptionsRequest < Struct.new(
|
536
|
+
:filters,
|
537
|
+
:identity_provider,
|
538
|
+
:max_results,
|
539
|
+
:next_token,
|
540
|
+
:product)
|
541
|
+
SENSITIVE = []
|
542
|
+
include Aws::Structure
|
543
|
+
end
|
544
|
+
|
545
|
+
# @!attribute [rw] next_token
|
546
|
+
# Token for the next set of results.
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] product_user_summaries
|
550
|
+
# Metadata that describes the list product subscriptions operation.
|
551
|
+
# @return [Array<Types::ProductUserSummary>]
|
552
|
+
#
|
553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListProductSubscriptionsResponse AWS API Documentation
|
554
|
+
#
|
555
|
+
class ListProductSubscriptionsResponse < Struct.new(
|
556
|
+
:next_token,
|
557
|
+
:product_user_summaries)
|
558
|
+
SENSITIVE = []
|
559
|
+
include Aws::Structure
|
560
|
+
end
|
561
|
+
|
562
|
+
# @note When making an API call, you may pass ListUserAssociationsRequest
|
563
|
+
# data as a hash:
|
564
|
+
#
|
565
|
+
# {
|
566
|
+
# filters: [
|
567
|
+
# {
|
568
|
+
# attribute: "String",
|
569
|
+
# operation: "String",
|
570
|
+
# value: "String",
|
571
|
+
# },
|
572
|
+
# ],
|
573
|
+
# identity_provider: { # required
|
574
|
+
# active_directory_identity_provider: {
|
575
|
+
# directory_id: "String",
|
576
|
+
# },
|
577
|
+
# },
|
578
|
+
# instance_id: "String", # required
|
579
|
+
# max_results: 1,
|
580
|
+
# next_token: "String",
|
581
|
+
# }
|
582
|
+
#
|
583
|
+
# @!attribute [rw] filters
|
584
|
+
# An array of structures that you can use to filter the results to
|
585
|
+
# those that match one or more sets of key-value pairs that you
|
586
|
+
# specify.
|
587
|
+
# @return [Array<Types::Filter>]
|
588
|
+
#
|
589
|
+
# @!attribute [rw] identity_provider
|
590
|
+
# An object that specifies details for the identity provider.
|
591
|
+
# @return [Types::IdentityProvider]
|
592
|
+
#
|
593
|
+
# @!attribute [rw] instance_id
|
594
|
+
# The ID of the EC2 instance, which provides user-based subscriptions.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @!attribute [rw] max_results
|
598
|
+
# Maximum number of results to return in a single call.
|
599
|
+
# @return [Integer]
|
600
|
+
#
|
601
|
+
# @!attribute [rw] next_token
|
602
|
+
# Token for the next set of results.
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListUserAssociationsRequest AWS API Documentation
|
606
|
+
#
|
607
|
+
class ListUserAssociationsRequest < Struct.new(
|
608
|
+
:filters,
|
609
|
+
:identity_provider,
|
610
|
+
:instance_id,
|
611
|
+
:max_results,
|
612
|
+
:next_token)
|
613
|
+
SENSITIVE = []
|
614
|
+
include Aws::Structure
|
615
|
+
end
|
616
|
+
|
617
|
+
# @!attribute [rw] instance_user_summaries
|
618
|
+
# Metadata that describes the list user association operation.
|
619
|
+
# @return [Array<Types::InstanceUserSummary>]
|
620
|
+
#
|
621
|
+
# @!attribute [rw] next_token
|
622
|
+
# Token for the next set of results.
|
623
|
+
# @return [String]
|
624
|
+
#
|
625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListUserAssociationsResponse AWS API Documentation
|
626
|
+
#
|
627
|
+
class ListUserAssociationsResponse < Struct.new(
|
628
|
+
:instance_user_summaries,
|
629
|
+
:next_token)
|
630
|
+
SENSITIVE = []
|
631
|
+
include Aws::Structure
|
632
|
+
end
|
633
|
+
|
634
|
+
# The summary of the user-based subscription products for a user.
|
635
|
+
#
|
636
|
+
# @!attribute [rw] domain
|
637
|
+
# The domain name of the user.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] identity_provider
|
641
|
+
# An object that specifies details for the identity provider.
|
642
|
+
# @return [Types::IdentityProvider]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] product
|
645
|
+
# The name of the user-based subscription product.
|
646
|
+
# @return [String]
|
647
|
+
#
|
648
|
+
# @!attribute [rw] status
|
649
|
+
# The status of a product for a user.
|
650
|
+
# @return [String]
|
651
|
+
#
|
652
|
+
# @!attribute [rw] status_message
|
653
|
+
# The status message for a product for a user.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @!attribute [rw] subscription_end_date
|
657
|
+
# The end date of a subscription.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @!attribute [rw] subscription_start_date
|
661
|
+
# The start date of a subscription.
|
662
|
+
# @return [String]
|
663
|
+
#
|
664
|
+
# @!attribute [rw] username
|
665
|
+
# The user name from the identity provider of the user.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ProductUserSummary AWS API Documentation
|
669
|
+
#
|
670
|
+
class ProductUserSummary < Struct.new(
|
671
|
+
:domain,
|
672
|
+
:identity_provider,
|
673
|
+
:product,
|
674
|
+
:status,
|
675
|
+
:status_message,
|
676
|
+
:subscription_end_date,
|
677
|
+
:subscription_start_date,
|
678
|
+
:username)
|
679
|
+
SENSITIVE = []
|
680
|
+
include Aws::Structure
|
681
|
+
end
|
682
|
+
|
683
|
+
# @note When making an API call, you may pass RegisterIdentityProviderRequest
|
684
|
+
# data as a hash:
|
685
|
+
#
|
686
|
+
# {
|
687
|
+
# identity_provider: { # required
|
688
|
+
# active_directory_identity_provider: {
|
689
|
+
# directory_id: "String",
|
690
|
+
# },
|
691
|
+
# },
|
692
|
+
# product: "String", # required
|
693
|
+
# }
|
694
|
+
#
|
695
|
+
# @!attribute [rw] identity_provider
|
696
|
+
# An object that specifies details for the identity provider.
|
697
|
+
# @return [Types::IdentityProvider]
|
698
|
+
#
|
699
|
+
# @!attribute [rw] product
|
700
|
+
# The name of the user-based subscription product.
|
701
|
+
# @return [String]
|
702
|
+
#
|
703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProviderRequest AWS API Documentation
|
704
|
+
#
|
705
|
+
class RegisterIdentityProviderRequest < Struct.new(
|
706
|
+
:identity_provider,
|
707
|
+
:product)
|
708
|
+
SENSITIVE = []
|
709
|
+
include Aws::Structure
|
710
|
+
end
|
711
|
+
|
712
|
+
# @!attribute [rw] identity_provider_summary
|
713
|
+
# Metadata that describes the results of an identity provider
|
714
|
+
# operation.
|
715
|
+
# @return [Types::IdentityProviderSummary]
|
716
|
+
#
|
717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProviderResponse AWS API Documentation
|
718
|
+
#
|
719
|
+
class RegisterIdentityProviderResponse < Struct.new(
|
720
|
+
:identity_provider_summary)
|
721
|
+
SENSITIVE = []
|
722
|
+
include Aws::Structure
|
723
|
+
end
|
724
|
+
|
725
|
+
# The resource couldn't be found.
|
726
|
+
#
|
727
|
+
# @!attribute [rw] message
|
728
|
+
# @return [String]
|
729
|
+
#
|
730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ResourceNotFoundException AWS API Documentation
|
731
|
+
#
|
732
|
+
class ResourceNotFoundException < Struct.new(
|
733
|
+
:message)
|
734
|
+
SENSITIVE = []
|
735
|
+
include Aws::Structure
|
736
|
+
end
|
737
|
+
|
738
|
+
# The request failed because a service quota is exceeded.
|
739
|
+
#
|
740
|
+
# @!attribute [rw] message
|
741
|
+
# @return [String]
|
742
|
+
#
|
743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
744
|
+
#
|
745
|
+
class ServiceQuotaExceededException < Struct.new(
|
746
|
+
:message)
|
747
|
+
SENSITIVE = []
|
748
|
+
include Aws::Structure
|
749
|
+
end
|
750
|
+
|
751
|
+
# @note When making an API call, you may pass StartProductSubscriptionRequest
|
752
|
+
# data as a hash:
|
753
|
+
#
|
754
|
+
# {
|
755
|
+
# domain: "String",
|
756
|
+
# identity_provider: { # required
|
757
|
+
# active_directory_identity_provider: {
|
758
|
+
# directory_id: "String",
|
759
|
+
# },
|
760
|
+
# },
|
761
|
+
# product: "String", # required
|
762
|
+
# username: "String", # required
|
763
|
+
# }
|
764
|
+
#
|
765
|
+
# @!attribute [rw] domain
|
766
|
+
# The domain name of the user.
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @!attribute [rw] identity_provider
|
770
|
+
# An object that specifies details for the identity provider.
|
771
|
+
# @return [Types::IdentityProvider]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] product
|
774
|
+
# The name of the user-based subscription product.
|
775
|
+
# @return [String]
|
776
|
+
#
|
777
|
+
# @!attribute [rw] username
|
778
|
+
# The user name from the identity provider of the user.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/StartProductSubscriptionRequest AWS API Documentation
|
782
|
+
#
|
783
|
+
class StartProductSubscriptionRequest < Struct.new(
|
784
|
+
:domain,
|
785
|
+
:identity_provider,
|
786
|
+
:product,
|
787
|
+
:username)
|
788
|
+
SENSITIVE = []
|
789
|
+
include Aws::Structure
|
790
|
+
end
|
791
|
+
|
792
|
+
# @!attribute [rw] product_user_summary
|
793
|
+
# Metadata that describes the start product subscription operation.
|
794
|
+
# @return [Types::ProductUserSummary]
|
795
|
+
#
|
796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/StartProductSubscriptionResponse AWS API Documentation
|
797
|
+
#
|
798
|
+
class StartProductSubscriptionResponse < Struct.new(
|
799
|
+
:product_user_summary)
|
800
|
+
SENSITIVE = []
|
801
|
+
include Aws::Structure
|
802
|
+
end
|
803
|
+
|
804
|
+
# @note When making an API call, you may pass StopProductSubscriptionRequest
|
805
|
+
# data as a hash:
|
806
|
+
#
|
807
|
+
# {
|
808
|
+
# domain: "String",
|
809
|
+
# identity_provider: { # required
|
810
|
+
# active_directory_identity_provider: {
|
811
|
+
# directory_id: "String",
|
812
|
+
# },
|
813
|
+
# },
|
814
|
+
# product: "String", # required
|
815
|
+
# username: "String", # required
|
816
|
+
# }
|
817
|
+
#
|
818
|
+
# @!attribute [rw] domain
|
819
|
+
# The domain name of the user.
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] identity_provider
|
823
|
+
# An object that specifies details for the identity provider.
|
824
|
+
# @return [Types::IdentityProvider]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] product
|
827
|
+
# The name of the user-based subscription product.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] username
|
831
|
+
# The user name from the identity provider for the user.
|
832
|
+
# @return [String]
|
833
|
+
#
|
834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/StopProductSubscriptionRequest AWS API Documentation
|
835
|
+
#
|
836
|
+
class StopProductSubscriptionRequest < Struct.new(
|
837
|
+
:domain,
|
838
|
+
:identity_provider,
|
839
|
+
:product,
|
840
|
+
:username)
|
841
|
+
SENSITIVE = []
|
842
|
+
include Aws::Structure
|
843
|
+
end
|
844
|
+
|
845
|
+
# @!attribute [rw] product_user_summary
|
846
|
+
# Metadata that describes the start product subscription operation.
|
847
|
+
# @return [Types::ProductUserSummary]
|
848
|
+
#
|
849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/StopProductSubscriptionResponse AWS API Documentation
|
850
|
+
#
|
851
|
+
class StopProductSubscriptionResponse < Struct.new(
|
852
|
+
:product_user_summary)
|
853
|
+
SENSITIVE = []
|
854
|
+
include Aws::Structure
|
855
|
+
end
|
856
|
+
|
857
|
+
# The request was denied because of request throttling. Retry the
|
858
|
+
# request.
|
859
|
+
#
|
860
|
+
# @!attribute [rw] message
|
861
|
+
# @return [String]
|
862
|
+
#
|
863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ThrottlingException AWS API Documentation
|
864
|
+
#
|
865
|
+
class ThrottlingException < Struct.new(
|
866
|
+
:message)
|
867
|
+
SENSITIVE = []
|
868
|
+
include Aws::Structure
|
869
|
+
end
|
870
|
+
|
871
|
+
# A parameter is not valid.
|
872
|
+
#
|
873
|
+
# @!attribute [rw] message
|
874
|
+
# @return [String]
|
875
|
+
#
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ValidationException AWS API Documentation
|
877
|
+
#
|
878
|
+
class ValidationException < Struct.new(
|
879
|
+
:message)
|
880
|
+
SENSITIVE = []
|
881
|
+
include Aws::Structure
|
882
|
+
end
|
883
|
+
|
884
|
+
end
|
885
|
+
end
|