aws-sdk-licensemanagerusersubscriptions 1.25.0 → 1.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -25,6 +25,18 @@ module Aws::LicenseManagerUserSubscriptions
25
25
 
26
26
  # Details about an Active Directory identity provider.
27
27
  #
28
+ # @!attribute [rw] active_directory_settings
29
+ # The `ActiveDirectorySettings` resource contains details about the
30
+ # Active Directory, including network access details such as domain
31
+ # name and IP addresses, and the credential provider for user
32
+ # administration.
33
+ # @return [Types::ActiveDirectorySettings]
34
+ #
35
+ # @!attribute [rw] active_directory_type
36
+ # The type of Active Directory – either a self-managed Active
37
+ # Directory or an Amazon Web Services Managed Active Directory.
38
+ # @return [String]
39
+ #
28
40
  # @!attribute [rw] directory_id
29
41
  # The directory ID for an Active Directory identity provider.
30
42
  # @return [String]
@@ -32,25 +44,66 @@ module Aws::LicenseManagerUserSubscriptions
32
44
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ActiveDirectoryIdentityProvider AWS API Documentation
33
45
  #
34
46
  class ActiveDirectoryIdentityProvider < Struct.new(
47
+ :active_directory_settings,
48
+ :active_directory_type,
35
49
  :directory_id)
36
50
  SENSITIVE = []
37
51
  include Aws::Structure
38
52
  end
39
53
 
54
+ # Contains network access and credential details that are needed for
55
+ # user administration in the Active Directory.
56
+ #
57
+ # @!attribute [rw] domain_credentials_provider
58
+ # Points to the `CredentialsProvider` resource that contains
59
+ # information about the credential provider for user administration.
60
+ # @return [Types::CredentialsProvider]
61
+ #
62
+ # @!attribute [rw] domain_ipv_4_list
63
+ # A list of domain IPv4 addresses that are used for the Active
64
+ # Directory.
65
+ # @return [Array<String>]
66
+ #
67
+ # @!attribute [rw] domain_name
68
+ # The domain name for the Active Directory.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] domain_network_settings
72
+ # The `DomainNetworkSettings` resource contains an array of subnets
73
+ # that apply for the Active Directory.
74
+ # @return [Types::DomainNetworkSettings]
75
+ #
76
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ActiveDirectorySettings AWS API Documentation
77
+ #
78
+ class ActiveDirectorySettings < Struct.new(
79
+ :domain_credentials_provider,
80
+ :domain_ipv_4_list,
81
+ :domain_name,
82
+ :domain_network_settings)
83
+ SENSITIVE = []
84
+ include Aws::Structure
85
+ end
86
+
40
87
  # @!attribute [rw] domain
41
- # The domain name of the user.
88
+ # The domain name of the Active Directory that contains information
89
+ # for the user to associate.
42
90
  # @return [String]
43
91
  #
44
92
  # @!attribute [rw] identity_provider
45
- # The identity provider of the user.
93
+ # The identity provider for the user.
46
94
  # @return [Types::IdentityProvider]
47
95
  #
48
96
  # @!attribute [rw] instance_id
49
- # The ID of the EC2 instance, which provides user-based subscriptions.
97
+ # The ID of the EC2 instance that provides the user-based
98
+ # subscription.
50
99
  # @return [String]
51
100
  #
101
+ # @!attribute [rw] tags
102
+ # The tags that apply for the user association.
103
+ # @return [Hash<String,String>]
104
+ #
52
105
  # @!attribute [rw] username
53
- # The user name from the identity provider for the user.
106
+ # The user name from the identity provider.
54
107
  # @return [String]
55
108
  #
56
109
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/AssociateUserRequest AWS API Documentation
@@ -59,8 +112,9 @@ module Aws::LicenseManagerUserSubscriptions
59
112
  :domain,
60
113
  :identity_provider,
61
114
  :instance_id,
115
+ :tags,
62
116
  :username)
63
- SENSITIVE = []
117
+ SENSITIVE = [:tags]
64
118
  include Aws::Structure
65
119
  end
66
120
 
@@ -90,18 +144,131 @@ module Aws::LicenseManagerUserSubscriptions
90
144
  include Aws::Structure
91
145
  end
92
146
 
147
+ # @!attribute [rw] identity_provider_arn
148
+ # The Amazon Resource Name (ARN) that identifies the
149
+ # `IdentityProvider` resource that contains details about a registered
150
+ # identity provider. In the case of Active Directory, that can be a
151
+ # self-managed Active Directory or an Amazon Web Services Managed
152
+ # Active Directory that contains user identity details.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] license_server_settings
156
+ # The `LicenseServerSettings` resource to create for the endpoint. The
157
+ # settings include the type of license server and the Secrets Manager
158
+ # secret that enables administrators to add or remove users associated
159
+ # with the license server.
160
+ # @return [Types::LicenseServerSettings]
161
+ #
162
+ # @!attribute [rw] tags
163
+ # The tags that apply for the license server endpoint.
164
+ # @return [Hash<String,String>]
165
+ #
166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/CreateLicenseServerEndpointRequest AWS API Documentation
167
+ #
168
+ class CreateLicenseServerEndpointRequest < Struct.new(
169
+ :identity_provider_arn,
170
+ :license_server_settings,
171
+ :tags)
172
+ SENSITIVE = [:tags]
173
+ include Aws::Structure
174
+ end
175
+
176
+ # @!attribute [rw] identity_provider_arn
177
+ # The Amazon Resource Name (ARN) of the identity provider specified in
178
+ # the request.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] license_server_endpoint_arn
182
+ # The ARN of the `LicenseServerEndpoint` resource.
183
+ # @return [String]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/CreateLicenseServerEndpointResponse AWS API Documentation
186
+ #
187
+ class CreateLicenseServerEndpointResponse < Struct.new(
188
+ :identity_provider_arn,
189
+ :license_server_endpoint_arn)
190
+ SENSITIVE = []
191
+ include Aws::Structure
192
+ end
193
+
194
+ # Contains information about the credential provider for user
195
+ # administration.
196
+ #
197
+ # @note CredentialsProvider is a union - when making an API calls you must set exactly one of the members.
198
+ #
199
+ # @note CredentialsProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CredentialsProvider corresponding to the set member.
200
+ #
201
+ # @!attribute [rw] secrets_manager_credentials_provider
202
+ # Identifies the Secrets Manager secret that contains credentials
203
+ # needed for user administration in the Active Directory.
204
+ # @return [Types::SecretsManagerCredentialsProvider]
205
+ #
206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/CredentialsProvider AWS API Documentation
207
+ #
208
+ class CredentialsProvider < Struct.new(
209
+ :secrets_manager_credentials_provider,
210
+ :unknown)
211
+ SENSITIVE = []
212
+ include Aws::Structure
213
+ include Aws::Structure::Union
214
+
215
+ class SecretsManagerCredentialsProvider < CredentialsProvider; end
216
+ class Unknown < CredentialsProvider; end
217
+ end
218
+
219
+ # @!attribute [rw] license_server_endpoint_arn
220
+ # The Amazon Resource Name (ARN) that identifies the
221
+ # `LicenseServerEndpoint` resource to delete.
222
+ # @return [String]
223
+ #
224
+ # @!attribute [rw] server_type
225
+ # The type of License Server that the delete request refers to.
226
+ # @return [String]
227
+ #
228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DeleteLicenseServerEndpointRequest AWS API Documentation
229
+ #
230
+ class DeleteLicenseServerEndpointRequest < Struct.new(
231
+ :license_server_endpoint_arn,
232
+ :server_type)
233
+ SENSITIVE = []
234
+ include Aws::Structure
235
+ end
236
+
237
+ # @!attribute [rw] license_server_endpoint
238
+ # Shows details from the `LicenseServerEndpoint` resource that was
239
+ # deleted.
240
+ # @return [Types::LicenseServerEndpoint]
241
+ #
242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DeleteLicenseServerEndpointResponse AWS API Documentation
243
+ #
244
+ class DeleteLicenseServerEndpointResponse < Struct.new(
245
+ :license_server_endpoint)
246
+ SENSITIVE = []
247
+ include Aws::Structure
248
+ end
249
+
93
250
  # @!attribute [rw] identity_provider
94
- # An object that specifies details for the identity provider.
251
+ # An object that specifies details for the Active Directory identity
252
+ # provider.
95
253
  # @return [Types::IdentityProvider]
96
254
  #
255
+ # @!attribute [rw] identity_provider_arn
256
+ # The Amazon Resource Name (ARN) that identifies the identity provider
257
+ # to deregister.
258
+ # @return [String]
259
+ #
97
260
  # @!attribute [rw] product
98
261
  # The name of the user-based subscription product.
262
+ #
263
+ # Valid values: `VISUAL_STUDIO_ENTERPRISE` \|
264
+ # `VISUAL_STUDIO_PROFESSIONAL` \| `OFFICE_PROFESSIONAL_PLUS`
99
265
  # @return [String]
100
266
  #
101
267
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DeregisterIdentityProviderRequest AWS API Documentation
102
268
  #
103
269
  class DeregisterIdentityProviderRequest < Struct.new(
104
270
  :identity_provider,
271
+ :identity_provider_arn,
105
272
  :product)
106
273
  SENSITIVE = []
107
274
  include Aws::Structure
@@ -121,19 +288,27 @@ module Aws::LicenseManagerUserSubscriptions
121
288
  end
122
289
 
123
290
  # @!attribute [rw] domain
124
- # The domain name of the user.
291
+ # The domain name of the Active Directory that contains information
292
+ # for the user to disassociate.
125
293
  # @return [String]
126
294
  #
127
295
  # @!attribute [rw] identity_provider
128
- # An object that specifies details for the identity provider.
296
+ # An object that specifies details for the Active Directory identity
297
+ # provider.
129
298
  # @return [Types::IdentityProvider]
130
299
  #
131
300
  # @!attribute [rw] instance_id
132
- # The ID of the EC2 instance, which provides user-based subscriptions.
301
+ # The ID of the EC2 instance which provides user-based subscriptions.
302
+ # @return [String]
303
+ #
304
+ # @!attribute [rw] instance_user_arn
305
+ # The Amazon Resource Name (ARN) of the user to disassociate from the
306
+ # EC2 instance.
133
307
  # @return [String]
134
308
  #
135
309
  # @!attribute [rw] username
136
- # The user name from the identity provider for the user.
310
+ # The user name from the Active Directory identity provider for the
311
+ # user.
137
312
  # @return [String]
138
313
  #
139
314
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DisassociateUserRequest AWS API Documentation
@@ -142,6 +317,7 @@ module Aws::LicenseManagerUserSubscriptions
142
317
  :domain,
143
318
  :identity_provider,
144
319
  :instance_id,
320
+ :instance_user_arn,
145
321
  :username)
146
322
  SENSITIVE = []
147
323
  include Aws::Structure
@@ -159,9 +335,25 @@ module Aws::LicenseManagerUserSubscriptions
159
335
  include Aws::Structure
160
336
  end
161
337
 
338
+ # Contains network settings for the Active Directory domain.
339
+ #
340
+ # @!attribute [rw] subnets
341
+ # Contains a list of subnets that apply for the Active Directory
342
+ # domain.
343
+ # @return [Array<String>]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DomainNetworkSettings AWS API Documentation
346
+ #
347
+ class DomainNetworkSettings < Struct.new(
348
+ :subnets)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
162
353
  # A filter name and value pair that is used to return more specific
163
- # results from a describe operation. Filters can be used to match a set
164
- # of resources by specific criteria, such as tags, attributes, or IDs.
354
+ # results from a describe or list operation. You can use filters can be
355
+ # used to match a set of resources by specific criteria, such as tags,
356
+ # attributes, or IDs.
165
357
  #
166
358
  # @!attribute [rw] attribute
167
359
  # The name of an attribute to use as a filter.
@@ -185,14 +377,15 @@ module Aws::LicenseManagerUserSubscriptions
185
377
  include Aws::Structure
186
378
  end
187
379
 
188
- # Details about an identity provider.
380
+ # Refers to an identity provider.
189
381
  #
190
382
  # @note IdentityProvider is a union - when making an API calls you must set exactly one of the members.
191
383
  #
192
384
  # @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.
193
385
  #
194
386
  # @!attribute [rw] active_directory_identity_provider
195
- # An object that details an Active Directory identity provider.
387
+ # The `ActiveDirectoryIdentityProvider` resource contains settings and
388
+ # other details about a specific Active Directory identity provider.
196
389
  # @return [Types::ActiveDirectoryIdentityProvider]
197
390
  #
198
391
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/IdentityProvider AWS API Documentation
@@ -215,21 +408,26 @@ module Aws::LicenseManagerUserSubscriptions
215
408
  # @return [String]
216
409
  #
217
410
  # @!attribute [rw] identity_provider
218
- # An object that specifies details for the identity provider.
411
+ # The `IdentityProvider` resource contains information about an
412
+ # identity provider.
219
413
  # @return [Types::IdentityProvider]
220
414
  #
415
+ # @!attribute [rw] identity_provider_arn
416
+ # The Amazon Resource Name (ARN) of the identity provider.
417
+ # @return [String]
418
+ #
221
419
  # @!attribute [rw] product
222
420
  # The name of the user-based subscription product.
223
421
  # @return [String]
224
422
  #
225
423
  # @!attribute [rw] settings
226
- # An object that details the registered identity provider’s product
227
- # related configuration settings such as the subnets to provision VPC
228
- # endpoints.
424
+ # The `Settings` resource contains details about the registered
425
+ # identity provider’s product related configuration settings, such as
426
+ # the subnets to provision VPC endpoints.
229
427
  # @return [Types::Settings]
230
428
  #
231
429
  # @!attribute [rw] status
232
- # The status of an identity provider.
430
+ # The status of the identity provider.
233
431
  # @return [String]
234
432
  #
235
433
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/IdentityProviderSummary AWS API Documentation
@@ -237,6 +435,7 @@ module Aws::LicenseManagerUserSubscriptions
237
435
  class IdentityProviderSummary < Struct.new(
238
436
  :failure_message,
239
437
  :identity_provider,
438
+ :identity_provider_arn,
240
439
  :product,
241
440
  :settings,
242
441
  :status)
@@ -289,15 +488,21 @@ module Aws::LicenseManagerUserSubscriptions
289
488
  # @return [String]
290
489
  #
291
490
  # @!attribute [rw] domain
292
- # The domain name of the user.
491
+ # The domain name of the Active Directory that contains the user
492
+ # information for the product subscription.
293
493
  # @return [String]
294
494
  #
295
495
  # @!attribute [rw] identity_provider
296
- # An object that specifies details for the identity provider.
496
+ # The `IdentityProvider` resource specifies details about the identity
497
+ # provider.
297
498
  # @return [Types::IdentityProvider]
298
499
  #
299
500
  # @!attribute [rw] instance_id
300
- # The ID of the EC2 instance, which provides user-based subscriptions.
501
+ # The ID of the EC2 instance that provides user-based subscriptions.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] instance_user_arn
505
+ # The Amazon Resource Name (ARN) that identifies the instance user.
301
506
  # @return [String]
302
507
  #
303
508
  # @!attribute [rw] status
@@ -320,6 +525,7 @@ module Aws::LicenseManagerUserSubscriptions
320
525
  :domain,
321
526
  :identity_provider,
322
527
  :instance_id,
528
+ :instance_user_arn,
323
529
  :status,
324
530
  :status_message,
325
531
  :username)
@@ -340,17 +546,133 @@ module Aws::LicenseManagerUserSubscriptions
340
546
  include Aws::Structure
341
547
  end
342
548
 
549
+ # Information about a Remote Desktop Services (RDS) license server.
550
+ #
551
+ # @!attribute [rw] health_status
552
+ # The health status of the RDS license server.
553
+ # @return [String]
554
+ #
555
+ # @!attribute [rw] ipv_4_address
556
+ # A list of domain IPv4 addresses that are used for the RDS license
557
+ # server.
558
+ # @return [String]
559
+ #
560
+ # @!attribute [rw] provisioning_status
561
+ # The current state of the provisioning process for the RDS license
562
+ # server.
563
+ # @return [String]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/LicenseServer AWS API Documentation
566
+ #
567
+ class LicenseServer < Struct.new(
568
+ :health_status,
569
+ :ipv_4_address,
570
+ :provisioning_status)
571
+ SENSITIVE = []
572
+ include Aws::Structure
573
+ end
574
+
575
+ # Contains details about a network endpoint for a Remote Desktop
576
+ # Services (RDS) license server.
577
+ #
578
+ # @!attribute [rw] creation_time
579
+ # The timestamp when License Manager created the license server
580
+ # endpoint.
581
+ # @return [Time]
582
+ #
583
+ # @!attribute [rw] identity_provider_arn
584
+ # The Amazon Resource Name (ARN) of the identity provider that's
585
+ # associated with the RDS license server endpoint.
586
+ # @return [String]
587
+ #
588
+ # @!attribute [rw] license_server_endpoint_arn
589
+ # The ARN of the `ServerEndpoint` resource for the RDS license server.
590
+ # @return [String]
591
+ #
592
+ # @!attribute [rw] license_server_endpoint_id
593
+ # The ID of the license server endpoint.
594
+ # @return [String]
595
+ #
596
+ # @!attribute [rw] license_server_endpoint_provisioning_status
597
+ # The current state of the provisioning process for the RDS license
598
+ # server endpoint
599
+ # @return [String]
600
+ #
601
+ # @!attribute [rw] license_servers
602
+ # An array of `LicenseServer` resources that represent the license
603
+ # servers that are accessed through this endpoint.
604
+ # @return [Array<Types::LicenseServer>]
605
+ #
606
+ # @!attribute [rw] server_endpoint
607
+ # The `ServerEndpoint` resource contains the network address of the
608
+ # RDS license server endpoint.
609
+ # @return [Types::ServerEndpoint]
610
+ #
611
+ # @!attribute [rw] server_type
612
+ # The type of license server.
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] status_message
616
+ # The message associated with the provisioning status, if there is
617
+ # one.
618
+ # @return [String]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/LicenseServerEndpoint AWS API Documentation
621
+ #
622
+ class LicenseServerEndpoint < Struct.new(
623
+ :creation_time,
624
+ :identity_provider_arn,
625
+ :license_server_endpoint_arn,
626
+ :license_server_endpoint_id,
627
+ :license_server_endpoint_provisioning_status,
628
+ :license_servers,
629
+ :server_endpoint,
630
+ :server_type,
631
+ :status_message)
632
+ SENSITIVE = []
633
+ include Aws::Structure
634
+ end
635
+
636
+ # The settings to configure your license server.
637
+ #
638
+ # @!attribute [rw] server_settings
639
+ # The `ServerSettings` resource contains the settings for your server.
640
+ # @return [Types::ServerSettings]
641
+ #
642
+ # @!attribute [rw] server_type
643
+ # The type of license server.
644
+ # @return [String]
645
+ #
646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/LicenseServerSettings AWS API Documentation
647
+ #
648
+ class LicenseServerSettings < Struct.new(
649
+ :server_settings,
650
+ :server_type)
651
+ SENSITIVE = []
652
+ include Aws::Structure
653
+ end
654
+
655
+ # @!attribute [rw] filters
656
+ # You can use the following filters to streamline results:
657
+ #
658
+ # * Product
659
+ #
660
+ # * DirectoryId
661
+ # @return [Array<Types::Filter>]
662
+ #
343
663
  # @!attribute [rw] max_results
344
- # Maximum number of results to return in a single call.
664
+ # The maximum number of results to return from a single request.
345
665
  # @return [Integer]
346
666
  #
347
667
  # @!attribute [rw] next_token
348
- # Token for the next set of results.
668
+ # A token to specify where to start paginating. This is the nextToken
669
+ # from a previously truncated response.
349
670
  # @return [String]
350
671
  #
351
672
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListIdentityProvidersRequest AWS API Documentation
352
673
  #
353
674
  class ListIdentityProvidersRequest < Struct.new(
675
+ :filters,
354
676
  :max_results,
355
677
  :next_token)
356
678
  SENSITIVE = []
@@ -358,11 +680,16 @@ module Aws::LicenseManagerUserSubscriptions
358
680
  end
359
681
 
360
682
  # @!attribute [rw] identity_provider_summaries
361
- # Metadata that describes the list identity providers operation.
683
+ # An array of `IdentityProviderSummary` resources that contain details
684
+ # about the Active Directory identity providers that meet the request
685
+ # criteria.
362
686
  # @return [Array<Types::IdentityProviderSummary>]
363
687
  #
364
688
  # @!attribute [rw] next_token
365
- # Token for the next set of results.
689
+ # The next token used for paginated responses. When this field isn't
690
+ # empty, there are additional elements that the service hasn't
691
+ # included in this request. Use this token with the next request to
692
+ # retrieve additional objects.
366
693
  # @return [String]
367
694
  #
368
695
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListIdentityProvidersResponse AWS API Documentation
@@ -375,17 +702,20 @@ module Aws::LicenseManagerUserSubscriptions
375
702
  end
376
703
 
377
704
  # @!attribute [rw] filters
378
- # An array of structures that you can use to filter the results to
379
- # those that match one or more sets of key-value pairs that you
380
- # specify.
705
+ # You can use the following filters to streamline results:
706
+ #
707
+ # * Status
708
+ #
709
+ # * InstanceId
381
710
  # @return [Array<Types::Filter>]
382
711
  #
383
712
  # @!attribute [rw] max_results
384
- # Maximum number of results to return in a single call.
713
+ # The maximum number of results to return from a single request.
385
714
  # @return [Integer]
386
715
  #
387
716
  # @!attribute [rw] next_token
388
- # Token for the next set of results.
717
+ # A token to specify where to start paginating. This is the nextToken
718
+ # from a previously truncated response.
389
719
  # @return [String]
390
720
  #
391
721
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListInstancesRequest AWS API Documentation
@@ -399,11 +729,16 @@ module Aws::LicenseManagerUserSubscriptions
399
729
  end
400
730
 
401
731
  # @!attribute [rw] instance_summaries
402
- # Metadata that describes the list instances operation.
732
+ # An array of `InstanceSummary` resources that contain details about
733
+ # the instances that provide user-based subscriptions and also meet
734
+ # the request criteria.
403
735
  # @return [Array<Types::InstanceSummary>]
404
736
  #
405
737
  # @!attribute [rw] next_token
406
- # Token for the next set of results.
738
+ # The next token used for paginated responses. When this field isn't
739
+ # empty, there are additional elements that the service hasn't
740
+ # included in this request. Use this token with the next request to
741
+ # retrieve additional objects.
407
742
  # @return [String]
408
743
  #
409
744
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListInstancesResponse AWS API Documentation
@@ -416,9 +751,62 @@ module Aws::LicenseManagerUserSubscriptions
416
751
  end
417
752
 
418
753
  # @!attribute [rw] filters
419
- # An array of structures that you can use to filter the results to
420
- # those that match one or more sets of key-value pairs that you
421
- # specify.
754
+ # You can use the following filters to streamline results:
755
+ #
756
+ # * IdentityProviderArn
757
+ #
758
+ # ^
759
+ # @return [Array<Types::Filter>]
760
+ #
761
+ # @!attribute [rw] max_results
762
+ # The maximum number of results to return from a single request.
763
+ # @return [Integer]
764
+ #
765
+ # @!attribute [rw] next_token
766
+ # A token to specify where to start paginating. This is the nextToken
767
+ # from a previously truncated response.
768
+ # @return [String]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListLicenseServerEndpointsRequest AWS API Documentation
771
+ #
772
+ class ListLicenseServerEndpointsRequest < Struct.new(
773
+ :filters,
774
+ :max_results,
775
+ :next_token)
776
+ SENSITIVE = []
777
+ include Aws::Structure
778
+ end
779
+
780
+ # @!attribute [rw] license_server_endpoints
781
+ # An array of `LicenseServerEndpoint` resources that contain detailed
782
+ # information about the RDS License Servers that meet the request
783
+ # criteria.
784
+ # @return [Array<Types::LicenseServerEndpoint>]
785
+ #
786
+ # @!attribute [rw] next_token
787
+ # The next token used for paginated responses. When this field isn't
788
+ # empty, there are additional elements that the service hasn't
789
+ # included in this request. Use this token with the next request to
790
+ # retrieve additional objects.
791
+ # @return [String]
792
+ #
793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListLicenseServerEndpointsResponse AWS API Documentation
794
+ #
795
+ class ListLicenseServerEndpointsResponse < Struct.new(
796
+ :license_server_endpoints,
797
+ :next_token)
798
+ SENSITIVE = []
799
+ include Aws::Structure
800
+ end
801
+
802
+ # @!attribute [rw] filters
803
+ # You can use the following filters to streamline results:
804
+ #
805
+ # * Status
806
+ #
807
+ # * Username
808
+ #
809
+ # * Domain
422
810
  # @return [Array<Types::Filter>]
423
811
  #
424
812
  # @!attribute [rw] identity_provider
@@ -426,15 +814,19 @@ module Aws::LicenseManagerUserSubscriptions
426
814
  # @return [Types::IdentityProvider]
427
815
  #
428
816
  # @!attribute [rw] max_results
429
- # Maximum number of results to return in a single call.
817
+ # The maximum number of results to return from a single request.
430
818
  # @return [Integer]
431
819
  #
432
820
  # @!attribute [rw] next_token
433
- # Token for the next set of results.
821
+ # A token to specify where to start paginating. This is the nextToken
822
+ # from a previously truncated response.
434
823
  # @return [String]
435
824
  #
436
825
  # @!attribute [rw] product
437
826
  # The name of the user-based subscription product.
827
+ #
828
+ # Valid values: `VISUAL_STUDIO_ENTERPRISE` \|
829
+ # `VISUAL_STUDIO_PROFESSIONAL` \| `OFFICE_PROFESSIONAL_PLUS`
438
830
  # @return [String]
439
831
  #
440
832
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListProductSubscriptionsRequest AWS API Documentation
@@ -450,7 +842,10 @@ module Aws::LicenseManagerUserSubscriptions
450
842
  end
451
843
 
452
844
  # @!attribute [rw] next_token
453
- # Token for the next set of results.
845
+ # The next token used for paginated responses. When this field isn't
846
+ # empty, there are additional elements that the service hasn't
847
+ # included in this request. Use this token with the next request to
848
+ # retrieve additional objects.
454
849
  # @return [String]
455
850
  #
456
851
  # @!attribute [rw] product_user_summaries
@@ -466,10 +861,39 @@ module Aws::LicenseManagerUserSubscriptions
466
861
  include Aws::Structure
467
862
  end
468
863
 
864
+ # @!attribute [rw] resource_arn
865
+ # The Amazon Resource Name (ARN) of the resource whose tags you want
866
+ # to retrieve.
867
+ # @return [String]
868
+ #
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListTagsForResourceRequest AWS API Documentation
870
+ #
871
+ class ListTagsForResourceRequest < Struct.new(
872
+ :resource_arn)
873
+ SENSITIVE = []
874
+ include Aws::Structure
875
+ end
876
+
877
+ # @!attribute [rw] tags
878
+ # The tags for the specified resource.
879
+ # @return [Hash<String,String>]
880
+ #
881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListTagsForResourceResponse AWS API Documentation
882
+ #
883
+ class ListTagsForResourceResponse < Struct.new(
884
+ :tags)
885
+ SENSITIVE = [:tags]
886
+ include Aws::Structure
887
+ end
888
+
469
889
  # @!attribute [rw] filters
470
- # An array of structures that you can use to filter the results to
471
- # those that match one or more sets of key-value pairs that you
472
- # specify.
890
+ # You can use the following filters to streamline results:
891
+ #
892
+ # * Status
893
+ #
894
+ # * Username
895
+ #
896
+ # * Domain
473
897
  # @return [Array<Types::Filter>]
474
898
  #
475
899
  # @!attribute [rw] identity_provider
@@ -481,11 +905,12 @@ module Aws::LicenseManagerUserSubscriptions
481
905
  # @return [String]
482
906
  #
483
907
  # @!attribute [rw] max_results
484
- # Maximum number of results to return in a single call.
908
+ # The maximum number of results to return from a single request.
485
909
  # @return [Integer]
486
910
  #
487
911
  # @!attribute [rw] next_token
488
- # Token for the next set of results.
912
+ # A token to specify where to start paginating. This is the nextToken
913
+ # from a previously truncated response.
489
914
  # @return [String]
490
915
  #
491
916
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListUserAssociationsRequest AWS API Documentation
@@ -505,7 +930,10 @@ module Aws::LicenseManagerUserSubscriptions
505
930
  # @return [Array<Types::InstanceUserSummary>]
506
931
  #
507
932
  # @!attribute [rw] next_token
508
- # Token for the next set of results.
933
+ # The next token used for paginated responses. When this field isn't
934
+ # empty, there are additional elements that the service hasn't
935
+ # included in this request. Use this token with the next request to
936
+ # retrieve additional objects.
509
937
  # @return [String]
510
938
  #
511
939
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListUserAssociationsResponse AWS API Documentation
@@ -517,10 +945,11 @@ module Aws::LicenseManagerUserSubscriptions
517
945
  include Aws::Structure
518
946
  end
519
947
 
520
- # The summary of the user-based subscription products for a user.
948
+ # A summary of the user-based subscription products for a specific user.
521
949
  #
522
950
  # @!attribute [rw] domain
523
- # The domain name of the user.
951
+ # The domain name of the Active Directory that contains the user
952
+ # information for the product subscription.
524
953
  # @return [String]
525
954
  #
526
955
  # @!attribute [rw] identity_provider
@@ -531,12 +960,16 @@ module Aws::LicenseManagerUserSubscriptions
531
960
  # The name of the user-based subscription product.
532
961
  # @return [String]
533
962
  #
963
+ # @!attribute [rw] product_user_arn
964
+ # The Amazon Resource Name (ARN) for this product user.
965
+ # @return [String]
966
+ #
534
967
  # @!attribute [rw] status
535
- # The status of a product for a user.
968
+ # The status of a product for this user.
536
969
  # @return [String]
537
970
  #
538
971
  # @!attribute [rw] status_message
539
- # The status message for a product for a user.
972
+ # The status message for a product for this user.
540
973
  # @return [String]
541
974
  #
542
975
  # @!attribute [rw] subscription_end_date
@@ -548,7 +981,7 @@ module Aws::LicenseManagerUserSubscriptions
548
981
  # @return [String]
549
982
  #
550
983
  # @!attribute [rw] username
551
- # The user name from the identity provider of the user.
984
+ # The user name from the identity provider for this product user.
552
985
  # @return [String]
553
986
  #
554
987
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ProductUserSummary AWS API Documentation
@@ -557,6 +990,7 @@ module Aws::LicenseManagerUserSubscriptions
557
990
  :domain,
558
991
  :identity_provider,
559
992
  :product,
993
+ :product_user_arn,
560
994
  :status,
561
995
  :status_message,
562
996
  :subscription_end_date,
@@ -566,12 +1000,33 @@ module Aws::LicenseManagerUserSubscriptions
566
1000
  include Aws::Structure
567
1001
  end
568
1002
 
1003
+ # Server settings that are specific to a Remote Desktop Services (RDS)
1004
+ # license server.
1005
+ #
1006
+ # @!attribute [rw] rds_sal_credentials_provider
1007
+ # The `CredentialsProvider` resource contains a reference to the
1008
+ # credentials provider that's used for RDS license server user
1009
+ # administration.
1010
+ # @return [Types::CredentialsProvider]
1011
+ #
1012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/RdsSalSettings AWS API Documentation
1013
+ #
1014
+ class RdsSalSettings < Struct.new(
1015
+ :rds_sal_credentials_provider)
1016
+ SENSITIVE = []
1017
+ include Aws::Structure
1018
+ end
1019
+
569
1020
  # @!attribute [rw] identity_provider
570
- # An object that specifies details for the identity provider.
1021
+ # An object that specifies details for the identity provider to
1022
+ # register.
571
1023
  # @return [Types::IdentityProvider]
572
1024
  #
573
1025
  # @!attribute [rw] product
574
1026
  # The name of the user-based subscription product.
1027
+ #
1028
+ # Valid values: `VISUAL_STUDIO_ENTERPRISE` \|
1029
+ # `VISUAL_STUDIO_PROFESSIONAL` \| `OFFICE_PROFESSIONAL_PLUS`
575
1030
  # @return [String]
576
1031
  #
577
1032
  # @!attribute [rw] settings
@@ -579,13 +1034,18 @@ module Aws::LicenseManagerUserSubscriptions
579
1034
  # settings such as the subnets to provision VPC endpoints.
580
1035
  # @return [Types::Settings]
581
1036
  #
1037
+ # @!attribute [rw] tags
1038
+ # The tags that apply to the identity provider's registration.
1039
+ # @return [Hash<String,String>]
1040
+ #
582
1041
  # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProviderRequest AWS API Documentation
583
1042
  #
584
1043
  class RegisterIdentityProviderRequest < Struct.new(
585
1044
  :identity_provider,
586
1045
  :product,
587
- :settings)
588
- SENSITIVE = []
1046
+ :settings,
1047
+ :tags)
1048
+ SENSITIVE = [:tags]
589
1049
  include Aws::Structure
590
1050
  end
591
1051
 
@@ -615,6 +1075,56 @@ module Aws::LicenseManagerUserSubscriptions
615
1075
  include Aws::Structure
616
1076
  end
617
1077
 
1078
+ # Contains a credentials secret that's stored in Secrets Manager.
1079
+ #
1080
+ # @!attribute [rw] secret_id
1081
+ # The ID of the Secrets Manager secret that contains credentials.
1082
+ # @return [String]
1083
+ #
1084
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/SecretsManagerCredentialsProvider AWS API Documentation
1085
+ #
1086
+ class SecretsManagerCredentialsProvider < Struct.new(
1087
+ :secret_id)
1088
+ SENSITIVE = []
1089
+ include Aws::Structure
1090
+ end
1091
+
1092
+ # A network endpoint through which you can access one or more servers.
1093
+ #
1094
+ # @!attribute [rw] endpoint
1095
+ # The network address of the endpoint.
1096
+ # @return [String]
1097
+ #
1098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ServerEndpoint AWS API Documentation
1099
+ #
1100
+ class ServerEndpoint < Struct.new(
1101
+ :endpoint)
1102
+ SENSITIVE = []
1103
+ include Aws::Structure
1104
+ end
1105
+
1106
+ # Contains settings for a specific server.
1107
+ #
1108
+ # @note ServerSettings is a union - when making an API calls you must set exactly one of the members.
1109
+ #
1110
+ # @!attribute [rw] rds_sal_settings
1111
+ # The `RdsSalSettings` resource contains settings to configure a
1112
+ # specific Remote Desktop Services (RDS) license server.
1113
+ # @return [Types::RdsSalSettings]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ServerSettings AWS API Documentation
1116
+ #
1117
+ class ServerSettings < Struct.new(
1118
+ :rds_sal_settings,
1119
+ :unknown)
1120
+ SENSITIVE = []
1121
+ include Aws::Structure
1122
+ include Aws::Structure::Union
1123
+
1124
+ class RdsSalSettings < ServerSettings; end
1125
+ class Unknown < ServerSettings; end
1126
+ end
1127
+
618
1128
  # The request failed because a service quota is exceeded.
619
1129
  #
620
1130
  # @!attribute [rw] message
@@ -654,7 +1164,8 @@ module Aws::LicenseManagerUserSubscriptions
654
1164
  end
655
1165
 
656
1166
  # @!attribute [rw] domain
657
- # The domain name of the user.
1167
+ # The domain name of the Active Directory that contains the user for
1168
+ # whom to start the product subscription.
658
1169
  # @return [String]
659
1170
  #
660
1171
  # @!attribute [rw] identity_provider
@@ -663,8 +1174,15 @@ module Aws::LicenseManagerUserSubscriptions
663
1174
  #
664
1175
  # @!attribute [rw] product
665
1176
  # The name of the user-based subscription product.
1177
+ #
1178
+ # Valid values: `VISUAL_STUDIO_ENTERPRISE` \|
1179
+ # `VISUAL_STUDIO_PROFESSIONAL` \| `OFFICE_PROFESSIONAL_PLUS`
666
1180
  # @return [String]
667
1181
  #
1182
+ # @!attribute [rw] tags
1183
+ # The tags that apply to the product subscription.
1184
+ # @return [Hash<String,String>]
1185
+ #
668
1186
  # @!attribute [rw] username
669
1187
  # The user name from the identity provider of the user.
670
1188
  # @return [String]
@@ -675,8 +1193,9 @@ module Aws::LicenseManagerUserSubscriptions
675
1193
  :domain,
676
1194
  :identity_provider,
677
1195
  :product,
1196
+ :tags,
678
1197
  :username)
679
- SENSITIVE = []
1198
+ SENSITIVE = [:tags]
680
1199
  include Aws::Structure
681
1200
  end
682
1201
 
@@ -693,7 +1212,8 @@ module Aws::LicenseManagerUserSubscriptions
693
1212
  end
694
1213
 
695
1214
  # @!attribute [rw] domain
696
- # The domain name of the user.
1215
+ # The domain name of the Active Directory that contains the user for
1216
+ # whom to stop the product subscription.
697
1217
  # @return [String]
698
1218
  #
699
1219
  # @!attribute [rw] identity_provider
@@ -702,6 +1222,13 @@ module Aws::LicenseManagerUserSubscriptions
702
1222
  #
703
1223
  # @!attribute [rw] product
704
1224
  # The name of the user-based subscription product.
1225
+ #
1226
+ # Valid values: `VISUAL_STUDIO_ENTERPRISE` \|
1227
+ # `VISUAL_STUDIO_PROFESSIONAL` \| `OFFICE_PROFESSIONAL_PLUS`
1228
+ # @return [String]
1229
+ #
1230
+ # @!attribute [rw] product_user_arn
1231
+ # The Amazon Resource Name (ARN) of the product user.
705
1232
  # @return [String]
706
1233
  #
707
1234
  # @!attribute [rw] username
@@ -714,6 +1241,7 @@ module Aws::LicenseManagerUserSubscriptions
714
1241
  :domain,
715
1242
  :identity_provider,
716
1243
  :product,
1244
+ :product_user_arn,
717
1245
  :username)
718
1246
  SENSITIVE = []
719
1247
  include Aws::Structure
@@ -731,6 +1259,27 @@ module Aws::LicenseManagerUserSubscriptions
731
1259
  include Aws::Structure
732
1260
  end
733
1261
 
1262
+ # @!attribute [rw] resource_arn
1263
+ # The Amazon Resource Name (ARN) of the resource that you want to tag.
1264
+ # @return [String]
1265
+ #
1266
+ # @!attribute [rw] tags
1267
+ # The tags to apply to the specified resource.
1268
+ # @return [Hash<String,String>]
1269
+ #
1270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/TagResourceRequest AWS API Documentation
1271
+ #
1272
+ class TagResourceRequest < Struct.new(
1273
+ :resource_arn,
1274
+ :tags)
1275
+ SENSITIVE = [:tags]
1276
+ include Aws::Structure
1277
+ end
1278
+
1279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/TagResourceResponse AWS API Documentation
1280
+ #
1281
+ class TagResourceResponse < Aws::EmptyStructure; end
1282
+
734
1283
  # The request was denied because of request throttling. Retry the
735
1284
  # request.
736
1285
  #
@@ -745,12 +1294,41 @@ module Aws::LicenseManagerUserSubscriptions
745
1294
  include Aws::Structure
746
1295
  end
747
1296
 
1297
+ # @!attribute [rw] resource_arn
1298
+ # The Amazon Resource Name (ARN) of the resource that you want to
1299
+ # remove tags from.
1300
+ # @return [String]
1301
+ #
1302
+ # @!attribute [rw] tag_keys
1303
+ # The tag keys to remove from the resource.
1304
+ # @return [Array<String>]
1305
+ #
1306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/UntagResourceRequest AWS API Documentation
1307
+ #
1308
+ class UntagResourceRequest < Struct.new(
1309
+ :resource_arn,
1310
+ :tag_keys)
1311
+ SENSITIVE = [:tag_keys]
1312
+ include Aws::Structure
1313
+ end
1314
+
1315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/UntagResourceResponse AWS API Documentation
1316
+ #
1317
+ class UntagResourceResponse < Aws::EmptyStructure; end
1318
+
748
1319
  # @!attribute [rw] identity_provider
749
- # Details about an identity provider.
1320
+ # Refers to an identity provider.
750
1321
  # @return [Types::IdentityProvider]
751
1322
  #
1323
+ # @!attribute [rw] identity_provider_arn
1324
+ # The Amazon Resource Name (ARN) of the identity provider to update.
1325
+ # @return [String]
1326
+ #
752
1327
  # @!attribute [rw] product
753
1328
  # The name of the user-based subscription product.
1329
+ #
1330
+ # Valid values: `VISUAL_STUDIO_ENTERPRISE` \|
1331
+ # `VISUAL_STUDIO_PROFESSIONAL` \| `OFFICE_PROFESSIONAL_PLUS`
754
1332
  # @return [String]
755
1333
  #
756
1334
  # @!attribute [rw] update_settings
@@ -769,6 +1347,7 @@ module Aws::LicenseManagerUserSubscriptions
769
1347
  #
770
1348
  class UpdateIdentityProviderSettingsRequest < Struct.new(
771
1349
  :identity_provider,
1350
+ :identity_provider_arn,
772
1351
  :product,
773
1352
  :update_settings)
774
1353
  SENSITIVE = []