aws-sdk-licensemanagerusersubscriptions 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,904 @@
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
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/signature_v4.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:licensemanagerusersubscriptions)
37
+
38
+ module Aws::LicenseManagerUserSubscriptions
39
+ # An API client for LicenseManagerUserSubscriptions. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::LicenseManagerUserSubscriptions::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :licensemanagerusersubscriptions
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::SignatureV4)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+
85
+ # @overload initialize(options)
86
+ # @param [Hash] options
87
+ # @option options [required, Aws::CredentialProvider] :credentials
88
+ # Your AWS credentials. This can be an instance of any one of the
89
+ # following classes:
90
+ #
91
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
92
+ # credentials.
93
+ #
94
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
95
+ # shared file, such as `~/.aws/config`.
96
+ #
97
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
98
+ #
99
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
100
+ # assume a role after providing credentials via the web.
101
+ #
102
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
103
+ # access token generated from `aws login`.
104
+ #
105
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
106
+ # process that outputs to stdout.
107
+ #
108
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
109
+ # from an EC2 IMDS on an EC2 instance.
110
+ #
111
+ # * `Aws::ECSCredentials` - Used for loading credentials from
112
+ # instances running in ECS.
113
+ #
114
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
115
+ # from the Cognito Identity service.
116
+ #
117
+ # When `:credentials` are not configured directly, the following
118
+ # locations will be searched for credentials:
119
+ #
120
+ # * `Aws.config[:credentials]`
121
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
122
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
123
+ # * `~/.aws/credentials`
124
+ # * `~/.aws/config`
125
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
126
+ # are very aggressive. Construct and pass an instance of
127
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
128
+ # enable retries and extended timeouts. Instance profile credential
129
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
130
+ # to true.
131
+ #
132
+ # @option options [required, String] :region
133
+ # The AWS region to connect to. The configured `:region` is
134
+ # used to determine the service `:endpoint`. When not passed,
135
+ # a default `:region` is searched for in the following locations:
136
+ #
137
+ # * `Aws.config[:region]`
138
+ # * `ENV['AWS_REGION']`
139
+ # * `ENV['AMAZON_REGION']`
140
+ # * `ENV['AWS_DEFAULT_REGION']`
141
+ # * `~/.aws/credentials`
142
+ # * `~/.aws/config`
143
+ #
144
+ # @option options [String] :access_key_id
145
+ #
146
+ # @option options [Boolean] :active_endpoint_cache (false)
147
+ # When set to `true`, a thread polling for endpoints will be running in
148
+ # the background every 60 secs (default). Defaults to `false`.
149
+ #
150
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
151
+ # Used only in `adaptive` retry mode. When true, the request will sleep
152
+ # until there is sufficent client side capacity to retry the request.
153
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
154
+ # not retry instead of sleeping.
155
+ #
156
+ # @option options [Boolean] :client_side_monitoring (false)
157
+ # When `true`, client-side metrics will be collected for all API requests from
158
+ # this client.
159
+ #
160
+ # @option options [String] :client_side_monitoring_client_id ("")
161
+ # Allows you to provide an identifier for this client which will be attached to
162
+ # all generated client side metrics. Defaults to an empty string.
163
+ #
164
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
165
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
166
+ # side monitoring agent is running on, where client metrics will be published via UDP.
167
+ #
168
+ # @option options [Integer] :client_side_monitoring_port (31000)
169
+ # Required for publishing client metrics. The port that the client side monitoring
170
+ # agent is running on, where client metrics will be published via UDP.
171
+ #
172
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
173
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
174
+ # will use the Client Side Monitoring Agent Publisher.
175
+ #
176
+ # @option options [Boolean] :convert_params (true)
177
+ # When `true`, an attempt is made to coerce request parameters into
178
+ # the required types.
179
+ #
180
+ # @option options [Boolean] :correct_clock_skew (true)
181
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
182
+ # a clock skew correction and retry requests with skewed client clocks.
183
+ #
184
+ # @option options [String] :defaults_mode ("legacy")
185
+ # See {Aws::DefaultsModeConfiguration} for a list of the
186
+ # accepted modes and the configuration defaults that are included.
187
+ #
188
+ # @option options [Boolean] :disable_host_prefix_injection (false)
189
+ # Set to true to disable SDK automatically adding host prefix
190
+ # to default service endpoint when available.
191
+ #
192
+ # @option options [String] :endpoint
193
+ # The client endpoint is normally constructed from the `:region`
194
+ # option. You should only configure an `:endpoint` when connecting
195
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
196
+ #
197
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
198
+ # Used for the maximum size limit of the LRU cache storing endpoints data
199
+ # for endpoint discovery enabled operations. Defaults to 1000.
200
+ #
201
+ # @option options [Integer] :endpoint_cache_max_threads (10)
202
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
203
+ #
204
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
205
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
206
+ # Use this option to config the time interval in seconds for making
207
+ # requests fetching endpoints information. Defaults to 60 sec.
208
+ #
209
+ # @option options [Boolean] :endpoint_discovery (false)
210
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
211
+ #
212
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
213
+ # The log formatter.
214
+ #
215
+ # @option options [Symbol] :log_level (:info)
216
+ # The log level to send messages to the `:logger` at.
217
+ #
218
+ # @option options [Logger] :logger
219
+ # The Logger instance to send log messages to. If this option
220
+ # is not set, logging will be disabled.
221
+ #
222
+ # @option options [Integer] :max_attempts (3)
223
+ # An integer representing the maximum number attempts that will be made for
224
+ # a single request, including the initial attempt. For example,
225
+ # setting this value to 5 will result in a request being retried up to
226
+ # 4 times. Used in `standard` and `adaptive` retry modes.
227
+ #
228
+ # @option options [String] :profile ("default")
229
+ # Used when loading credentials from the shared credentials file
230
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
231
+ #
232
+ # @option options [Proc] :retry_backoff
233
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
234
+ # This option is only used in the `legacy` retry mode.
235
+ #
236
+ # @option options [Float] :retry_base_delay (0.3)
237
+ # The base delay in seconds used by the default backoff function. This option
238
+ # is only used in the `legacy` retry mode.
239
+ #
240
+ # @option options [Symbol] :retry_jitter (:none)
241
+ # A delay randomiser function used by the default backoff function.
242
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
243
+ # otherwise a Proc that takes and returns a number. This option is only used
244
+ # in the `legacy` retry mode.
245
+ #
246
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
247
+ #
248
+ # @option options [Integer] :retry_limit (3)
249
+ # The maximum number of times to retry failed requests. Only
250
+ # ~ 500 level server errors and certain ~ 400 level client errors
251
+ # are retried. Generally, these are throttling errors, data
252
+ # checksum errors, networking errors, timeout errors, auth errors,
253
+ # endpoint discovery, and errors from expired credentials.
254
+ # This option is only used in the `legacy` retry mode.
255
+ #
256
+ # @option options [Integer] :retry_max_delay (0)
257
+ # The maximum number of seconds to delay between retries (0 for no limit)
258
+ # used by the default backoff function. This option is only used in the
259
+ # `legacy` retry mode.
260
+ #
261
+ # @option options [String] :retry_mode ("legacy")
262
+ # Specifies which retry algorithm to use. Values are:
263
+ #
264
+ # * `legacy` - The pre-existing retry behavior. This is default value if
265
+ # no retry mode is provided.
266
+ #
267
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
268
+ # This includes support for retry quotas, which limit the number of
269
+ # unsuccessful retries a client can make.
270
+ #
271
+ # * `adaptive` - An experimental retry mode that includes all the
272
+ # functionality of `standard` mode along with automatic client side
273
+ # throttling. This is a provisional mode that may change behavior
274
+ # in the future.
275
+ #
276
+ #
277
+ # @option options [String] :secret_access_key
278
+ #
279
+ # @option options [String] :session_token
280
+ #
281
+ # @option options [Boolean] :stub_responses (false)
282
+ # Causes the client to return stubbed responses. By default
283
+ # fake responses are generated and returned. You can specify
284
+ # the response data to return or errors to raise by calling
285
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
286
+ #
287
+ # ** Please note ** When response stubbing is enabled, no HTTP
288
+ # requests are made, and retries are disabled.
289
+ #
290
+ # @option options [Boolean] :use_dualstack_endpoint
291
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
292
+ # will be used if available.
293
+ #
294
+ # @option options [Boolean] :use_fips_endpoint
295
+ # When set to `true`, fips compatible endpoints will be used if available.
296
+ # When a `fips` region is used, the region is normalized and this config
297
+ # is set to `true`.
298
+ #
299
+ # @option options [Boolean] :validate_params (true)
300
+ # When `true`, request parameters are validated before
301
+ # sending the request.
302
+ #
303
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
304
+ # requests through. Formatted like 'http://proxy.com:123'.
305
+ #
306
+ # @option options [Float] :http_open_timeout (15) The number of
307
+ # seconds to wait when opening a HTTP session before raising a
308
+ # `Timeout::Error`.
309
+ #
310
+ # @option options [Float] :http_read_timeout (60) The default
311
+ # number of seconds to wait for response data. This value can
312
+ # safely be set per-request on the session.
313
+ #
314
+ # @option options [Float] :http_idle_timeout (5) The number of
315
+ # seconds a connection is allowed to sit idle before it is
316
+ # considered stale. Stale connections are closed and removed
317
+ # from the pool before making a request.
318
+ #
319
+ # @option options [Float] :http_continue_timeout (1) The number of
320
+ # seconds to wait for a 100-continue response before sending the
321
+ # request body. This option has no effect unless the request has
322
+ # "Expect" header set to "100-continue". Defaults to `nil` which
323
+ # disables this behaviour. This value can safely be set per
324
+ # request on the session.
325
+ #
326
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
327
+ # in seconds.
328
+ #
329
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
330
+ # HTTP debug output will be sent to the `:logger`.
331
+ #
332
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
333
+ # SSL peer certificates are verified when establishing a
334
+ # connection.
335
+ #
336
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
337
+ # certificate authority bundle file that should be used when
338
+ # verifying peer certificates. If you do not pass
339
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
340
+ # will be used if available.
341
+ #
342
+ # @option options [String] :ssl_ca_directory Full path of the
343
+ # directory that contains the unbundled SSL certificate
344
+ # authority files for verifying peer certificates. If you do
345
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
346
+ # system default will be used if available.
347
+ #
348
+ def initialize(*args)
349
+ super
350
+ end
351
+
352
+ # @!group API Operations
353
+
354
+ # Associates the user to an EC2 instance to utilize user-based
355
+ # subscriptions.
356
+ #
357
+ # @option params [String] :domain
358
+ # The domain name of the user.
359
+ #
360
+ # @option params [required, Types::IdentityProvider] :identity_provider
361
+ # The identity provider of the user.
362
+ #
363
+ # @option params [required, String] :instance_id
364
+ # The ID of the EC2 instance, which provides user-based subscriptions.
365
+ #
366
+ # @option params [required, String] :username
367
+ # The user name from the identity provider for the user.
368
+ #
369
+ # @return [Types::AssociateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
370
+ #
371
+ # * {Types::AssociateUserResponse#instance_user_summary #instance_user_summary} => Types::InstanceUserSummary
372
+ #
373
+ # @example Request syntax with placeholder values
374
+ #
375
+ # resp = client.associate_user({
376
+ # domain: "String",
377
+ # identity_provider: { # required
378
+ # active_directory_identity_provider: {
379
+ # directory_id: "String",
380
+ # },
381
+ # },
382
+ # instance_id: "String", # required
383
+ # username: "String", # required
384
+ # })
385
+ #
386
+ # @example Response structure
387
+ #
388
+ # resp.instance_user_summary.association_date #=> String
389
+ # resp.instance_user_summary.disassociation_date #=> String
390
+ # resp.instance_user_summary.domain #=> String
391
+ # resp.instance_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
392
+ # resp.instance_user_summary.instance_id #=> String
393
+ # resp.instance_user_summary.status #=> String
394
+ # resp.instance_user_summary.status_message #=> String
395
+ # resp.instance_user_summary.username #=> String
396
+ #
397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/AssociateUser AWS API Documentation
398
+ #
399
+ # @overload associate_user(params = {})
400
+ # @param [Hash] params ({})
401
+ def associate_user(params = {}, options = {})
402
+ req = build_request(:associate_user, params)
403
+ req.send_request(options)
404
+ end
405
+
406
+ # Deregisters the identity provider from providing user-based
407
+ # subscriptions.
408
+ #
409
+ # @option params [required, Types::IdentityProvider] :identity_provider
410
+ # An object that specifies details for the identity provider.
411
+ #
412
+ # @option params [required, String] :product
413
+ # The name of the user-based subscription product.
414
+ #
415
+ # @return [Types::DeregisterIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
416
+ #
417
+ # * {Types::DeregisterIdentityProviderResponse#identity_provider_summary #identity_provider_summary} => Types::IdentityProviderSummary
418
+ #
419
+ # @example Request syntax with placeholder values
420
+ #
421
+ # resp = client.deregister_identity_provider({
422
+ # identity_provider: { # required
423
+ # active_directory_identity_provider: {
424
+ # directory_id: "String",
425
+ # },
426
+ # },
427
+ # product: "String", # required
428
+ # })
429
+ #
430
+ # @example Response structure
431
+ #
432
+ # resp.identity_provider_summary.failure_message #=> String
433
+ # resp.identity_provider_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
434
+ # resp.identity_provider_summary.product #=> String
435
+ # resp.identity_provider_summary.status #=> String
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DeregisterIdentityProvider AWS API Documentation
438
+ #
439
+ # @overload deregister_identity_provider(params = {})
440
+ # @param [Hash] params ({})
441
+ def deregister_identity_provider(params = {}, options = {})
442
+ req = build_request(:deregister_identity_provider, params)
443
+ req.send_request(options)
444
+ end
445
+
446
+ # Disassociates the user from an EC2 instance providing user-based
447
+ # subscriptions.
448
+ #
449
+ # @option params [String] :domain
450
+ # The domain name of the user.
451
+ #
452
+ # @option params [required, Types::IdentityProvider] :identity_provider
453
+ # An object that specifies details for the identity provider.
454
+ #
455
+ # @option params [required, String] :instance_id
456
+ # The ID of the EC2 instance, which provides user-based subscriptions.
457
+ #
458
+ # @option params [required, String] :username
459
+ # The user name from the identity provider for the user.
460
+ #
461
+ # @return [Types::DisassociateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
462
+ #
463
+ # * {Types::DisassociateUserResponse#instance_user_summary #instance_user_summary} => Types::InstanceUserSummary
464
+ #
465
+ # @example Request syntax with placeholder values
466
+ #
467
+ # resp = client.disassociate_user({
468
+ # domain: "String",
469
+ # identity_provider: { # required
470
+ # active_directory_identity_provider: {
471
+ # directory_id: "String",
472
+ # },
473
+ # },
474
+ # instance_id: "String", # required
475
+ # username: "String", # required
476
+ # })
477
+ #
478
+ # @example Response structure
479
+ #
480
+ # resp.instance_user_summary.association_date #=> String
481
+ # resp.instance_user_summary.disassociation_date #=> String
482
+ # resp.instance_user_summary.domain #=> String
483
+ # resp.instance_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
484
+ # resp.instance_user_summary.instance_id #=> String
485
+ # resp.instance_user_summary.status #=> String
486
+ # resp.instance_user_summary.status_message #=> String
487
+ # resp.instance_user_summary.username #=> String
488
+ #
489
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/DisassociateUser AWS API Documentation
490
+ #
491
+ # @overload disassociate_user(params = {})
492
+ # @param [Hash] params ({})
493
+ def disassociate_user(params = {}, options = {})
494
+ req = build_request(:disassociate_user, params)
495
+ req.send_request(options)
496
+ end
497
+
498
+ # Lists the identity providers for user-based subscriptions.
499
+ #
500
+ # @option params [Integer] :max_results
501
+ # Maximum number of results to return in a single call.
502
+ #
503
+ # @option params [String] :next_token
504
+ # Token for the next set of results.
505
+ #
506
+ # @return [Types::ListIdentityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
507
+ #
508
+ # * {Types::ListIdentityProvidersResponse#identity_provider_summaries #identity_provider_summaries} => Array&lt;Types::IdentityProviderSummary&gt;
509
+ # * {Types::ListIdentityProvidersResponse#next_token #next_token} => String
510
+ #
511
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
512
+ #
513
+ # @example Request syntax with placeholder values
514
+ #
515
+ # resp = client.list_identity_providers({
516
+ # max_results: 1,
517
+ # next_token: "String",
518
+ # })
519
+ #
520
+ # @example Response structure
521
+ #
522
+ # resp.identity_provider_summaries #=> Array
523
+ # resp.identity_provider_summaries[0].failure_message #=> String
524
+ # resp.identity_provider_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
525
+ # resp.identity_provider_summaries[0].product #=> String
526
+ # resp.identity_provider_summaries[0].status #=> String
527
+ # resp.next_token #=> String
528
+ #
529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListIdentityProviders AWS API Documentation
530
+ #
531
+ # @overload list_identity_providers(params = {})
532
+ # @param [Hash] params ({})
533
+ def list_identity_providers(params = {}, options = {})
534
+ req = build_request(:list_identity_providers, params)
535
+ req.send_request(options)
536
+ end
537
+
538
+ # Lists the EC2 instances providing user-based subscriptions.
539
+ #
540
+ # @option params [Array<Types::Filter>] :filters
541
+ # An array of structures that you can use to filter the results to those
542
+ # that match one or more sets of key-value pairs that you specify.
543
+ #
544
+ # @option params [Integer] :max_results
545
+ # Maximum number of results to return in a single call.
546
+ #
547
+ # @option params [String] :next_token
548
+ # Token for the next set of results.
549
+ #
550
+ # @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
551
+ #
552
+ # * {Types::ListInstancesResponse#instance_summaries #instance_summaries} => Array&lt;Types::InstanceSummary&gt;
553
+ # * {Types::ListInstancesResponse#next_token #next_token} => String
554
+ #
555
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
556
+ #
557
+ # @example Request syntax with placeholder values
558
+ #
559
+ # resp = client.list_instances({
560
+ # filters: [
561
+ # {
562
+ # attribute: "String",
563
+ # operation: "String",
564
+ # value: "String",
565
+ # },
566
+ # ],
567
+ # max_results: 1,
568
+ # next_token: "String",
569
+ # })
570
+ #
571
+ # @example Response structure
572
+ #
573
+ # resp.instance_summaries #=> Array
574
+ # resp.instance_summaries[0].instance_id #=> String
575
+ # resp.instance_summaries[0].last_status_check_date #=> String
576
+ # resp.instance_summaries[0].products #=> Array
577
+ # resp.instance_summaries[0].products[0] #=> String
578
+ # resp.instance_summaries[0].status #=> String
579
+ # resp.instance_summaries[0].status_message #=> String
580
+ # resp.next_token #=> String
581
+ #
582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListInstances AWS API Documentation
583
+ #
584
+ # @overload list_instances(params = {})
585
+ # @param [Hash] params ({})
586
+ def list_instances(params = {}, options = {})
587
+ req = build_request(:list_instances, params)
588
+ req.send_request(options)
589
+ end
590
+
591
+ # Lists the user-based subscription products available from an identity
592
+ # provider.
593
+ #
594
+ # @option params [Array<Types::Filter>] :filters
595
+ # An array of structures that you can use to filter the results to those
596
+ # that match one or more sets of key-value pairs that you specify.
597
+ #
598
+ # @option params [required, Types::IdentityProvider] :identity_provider
599
+ # An object that specifies details for the identity provider.
600
+ #
601
+ # @option params [Integer] :max_results
602
+ # Maximum number of results to return in a single call.
603
+ #
604
+ # @option params [String] :next_token
605
+ # Token for the next set of results.
606
+ #
607
+ # @option params [required, String] :product
608
+ # The name of the user-based subscription product.
609
+ #
610
+ # @return [Types::ListProductSubscriptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
611
+ #
612
+ # * {Types::ListProductSubscriptionsResponse#next_token #next_token} => String
613
+ # * {Types::ListProductSubscriptionsResponse#product_user_summaries #product_user_summaries} => Array&lt;Types::ProductUserSummary&gt;
614
+ #
615
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
616
+ #
617
+ # @example Request syntax with placeholder values
618
+ #
619
+ # resp = client.list_product_subscriptions({
620
+ # filters: [
621
+ # {
622
+ # attribute: "String",
623
+ # operation: "String",
624
+ # value: "String",
625
+ # },
626
+ # ],
627
+ # identity_provider: { # required
628
+ # active_directory_identity_provider: {
629
+ # directory_id: "String",
630
+ # },
631
+ # },
632
+ # max_results: 1,
633
+ # next_token: "String",
634
+ # product: "String", # required
635
+ # })
636
+ #
637
+ # @example Response structure
638
+ #
639
+ # resp.next_token #=> String
640
+ # resp.product_user_summaries #=> Array
641
+ # resp.product_user_summaries[0].domain #=> String
642
+ # resp.product_user_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
643
+ # resp.product_user_summaries[0].product #=> String
644
+ # resp.product_user_summaries[0].status #=> String
645
+ # resp.product_user_summaries[0].status_message #=> String
646
+ # resp.product_user_summaries[0].subscription_end_date #=> String
647
+ # resp.product_user_summaries[0].subscription_start_date #=> String
648
+ # resp.product_user_summaries[0].username #=> String
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListProductSubscriptions AWS API Documentation
651
+ #
652
+ # @overload list_product_subscriptions(params = {})
653
+ # @param [Hash] params ({})
654
+ def list_product_subscriptions(params = {}, options = {})
655
+ req = build_request(:list_product_subscriptions, params)
656
+ req.send_request(options)
657
+ end
658
+
659
+ # Lists user associations for an identity provider.
660
+ #
661
+ # @option params [Array<Types::Filter>] :filters
662
+ # An array of structures that you can use to filter the results to those
663
+ # that match one or more sets of key-value pairs that you specify.
664
+ #
665
+ # @option params [required, Types::IdentityProvider] :identity_provider
666
+ # An object that specifies details for the identity provider.
667
+ #
668
+ # @option params [required, String] :instance_id
669
+ # The ID of the EC2 instance, which provides user-based subscriptions.
670
+ #
671
+ # @option params [Integer] :max_results
672
+ # Maximum number of results to return in a single call.
673
+ #
674
+ # @option params [String] :next_token
675
+ # Token for the next set of results.
676
+ #
677
+ # @return [Types::ListUserAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
678
+ #
679
+ # * {Types::ListUserAssociationsResponse#instance_user_summaries #instance_user_summaries} => Array&lt;Types::InstanceUserSummary&gt;
680
+ # * {Types::ListUserAssociationsResponse#next_token #next_token} => String
681
+ #
682
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
683
+ #
684
+ # @example Request syntax with placeholder values
685
+ #
686
+ # resp = client.list_user_associations({
687
+ # filters: [
688
+ # {
689
+ # attribute: "String",
690
+ # operation: "String",
691
+ # value: "String",
692
+ # },
693
+ # ],
694
+ # identity_provider: { # required
695
+ # active_directory_identity_provider: {
696
+ # directory_id: "String",
697
+ # },
698
+ # },
699
+ # instance_id: "String", # required
700
+ # max_results: 1,
701
+ # next_token: "String",
702
+ # })
703
+ #
704
+ # @example Response structure
705
+ #
706
+ # resp.instance_user_summaries #=> Array
707
+ # resp.instance_user_summaries[0].association_date #=> String
708
+ # resp.instance_user_summaries[0].disassociation_date #=> String
709
+ # resp.instance_user_summaries[0].domain #=> String
710
+ # resp.instance_user_summaries[0].identity_provider.active_directory_identity_provider.directory_id #=> String
711
+ # resp.instance_user_summaries[0].instance_id #=> String
712
+ # resp.instance_user_summaries[0].status #=> String
713
+ # resp.instance_user_summaries[0].status_message #=> String
714
+ # resp.instance_user_summaries[0].username #=> String
715
+ # resp.next_token #=> String
716
+ #
717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/ListUserAssociations AWS API Documentation
718
+ #
719
+ # @overload list_user_associations(params = {})
720
+ # @param [Hash] params ({})
721
+ def list_user_associations(params = {}, options = {})
722
+ req = build_request(:list_user_associations, params)
723
+ req.send_request(options)
724
+ end
725
+
726
+ # Registers an identity provider for user-based subscriptions.
727
+ #
728
+ # @option params [required, Types::IdentityProvider] :identity_provider
729
+ # An object that specifies details for the identity provider.
730
+ #
731
+ # @option params [required, String] :product
732
+ # The name of the user-based subscription product.
733
+ #
734
+ # @return [Types::RegisterIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
735
+ #
736
+ # * {Types::RegisterIdentityProviderResponse#identity_provider_summary #identity_provider_summary} => Types::IdentityProviderSummary
737
+ #
738
+ # @example Request syntax with placeholder values
739
+ #
740
+ # resp = client.register_identity_provider({
741
+ # identity_provider: { # required
742
+ # active_directory_identity_provider: {
743
+ # directory_id: "String",
744
+ # },
745
+ # },
746
+ # product: "String", # required
747
+ # })
748
+ #
749
+ # @example Response structure
750
+ #
751
+ # resp.identity_provider_summary.failure_message #=> String
752
+ # resp.identity_provider_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
753
+ # resp.identity_provider_summary.product #=> String
754
+ # resp.identity_provider_summary.status #=> String
755
+ #
756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/RegisterIdentityProvider AWS API Documentation
757
+ #
758
+ # @overload register_identity_provider(params = {})
759
+ # @param [Hash] params ({})
760
+ def register_identity_provider(params = {}, options = {})
761
+ req = build_request(:register_identity_provider, params)
762
+ req.send_request(options)
763
+ end
764
+
765
+ # Starts a product subscription for a user with the specified identity
766
+ # provider.
767
+ #
768
+ # @option params [String] :domain
769
+ # The domain name of the user.
770
+ #
771
+ # @option params [required, Types::IdentityProvider] :identity_provider
772
+ # An object that specifies details for the identity provider.
773
+ #
774
+ # @option params [required, String] :product
775
+ # The name of the user-based subscription product.
776
+ #
777
+ # @option params [required, String] :username
778
+ # The user name from the identity provider of the user.
779
+ #
780
+ # @return [Types::StartProductSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
781
+ #
782
+ # * {Types::StartProductSubscriptionResponse#product_user_summary #product_user_summary} => Types::ProductUserSummary
783
+ #
784
+ # @example Request syntax with placeholder values
785
+ #
786
+ # resp = client.start_product_subscription({
787
+ # domain: "String",
788
+ # identity_provider: { # required
789
+ # active_directory_identity_provider: {
790
+ # directory_id: "String",
791
+ # },
792
+ # },
793
+ # product: "String", # required
794
+ # username: "String", # required
795
+ # })
796
+ #
797
+ # @example Response structure
798
+ #
799
+ # resp.product_user_summary.domain #=> String
800
+ # resp.product_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
801
+ # resp.product_user_summary.product #=> String
802
+ # resp.product_user_summary.status #=> String
803
+ # resp.product_user_summary.status_message #=> String
804
+ # resp.product_user_summary.subscription_end_date #=> String
805
+ # resp.product_user_summary.subscription_start_date #=> String
806
+ # resp.product_user_summary.username #=> String
807
+ #
808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/StartProductSubscription AWS API Documentation
809
+ #
810
+ # @overload start_product_subscription(params = {})
811
+ # @param [Hash] params ({})
812
+ def start_product_subscription(params = {}, options = {})
813
+ req = build_request(:start_product_subscription, params)
814
+ req.send_request(options)
815
+ end
816
+
817
+ # Stops a product subscription for a user with the specified identity
818
+ # provider.
819
+ #
820
+ # @option params [String] :domain
821
+ # The domain name of the user.
822
+ #
823
+ # @option params [required, Types::IdentityProvider] :identity_provider
824
+ # An object that specifies details for the identity provider.
825
+ #
826
+ # @option params [required, String] :product
827
+ # The name of the user-based subscription product.
828
+ #
829
+ # @option params [required, String] :username
830
+ # The user name from the identity provider for the user.
831
+ #
832
+ # @return [Types::StopProductSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
833
+ #
834
+ # * {Types::StopProductSubscriptionResponse#product_user_summary #product_user_summary} => Types::ProductUserSummary
835
+ #
836
+ # @example Request syntax with placeholder values
837
+ #
838
+ # resp = client.stop_product_subscription({
839
+ # domain: "String",
840
+ # identity_provider: { # required
841
+ # active_directory_identity_provider: {
842
+ # directory_id: "String",
843
+ # },
844
+ # },
845
+ # product: "String", # required
846
+ # username: "String", # required
847
+ # })
848
+ #
849
+ # @example Response structure
850
+ #
851
+ # resp.product_user_summary.domain #=> String
852
+ # resp.product_user_summary.identity_provider.active_directory_identity_provider.directory_id #=> String
853
+ # resp.product_user_summary.product #=> String
854
+ # resp.product_user_summary.status #=> String
855
+ # resp.product_user_summary.status_message #=> String
856
+ # resp.product_user_summary.subscription_end_date #=> String
857
+ # resp.product_user_summary.subscription_start_date #=> String
858
+ # resp.product_user_summary.username #=> String
859
+ #
860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-user-subscriptions-2018-05-10/StopProductSubscription AWS API Documentation
861
+ #
862
+ # @overload stop_product_subscription(params = {})
863
+ # @param [Hash] params ({})
864
+ def stop_product_subscription(params = {}, options = {})
865
+ req = build_request(:stop_product_subscription, params)
866
+ req.send_request(options)
867
+ end
868
+
869
+ # @!endgroup
870
+
871
+ # @param params ({})
872
+ # @api private
873
+ def build_request(operation_name, params = {})
874
+ handlers = @handlers.for(operation_name)
875
+ context = Seahorse::Client::RequestContext.new(
876
+ operation_name: operation_name,
877
+ operation: config.api.operation(operation_name),
878
+ client: self,
879
+ params: params,
880
+ config: config)
881
+ context[:gem_name] = 'aws-sdk-licensemanagerusersubscriptions'
882
+ context[:gem_version] = '1.0.0'
883
+ Seahorse::Client::Request.new(handlers, context)
884
+ end
885
+
886
+ # @api private
887
+ # @deprecated
888
+ def waiter_names
889
+ []
890
+ end
891
+
892
+ class << self
893
+
894
+ # @api private
895
+ attr_reader :identifier
896
+
897
+ # @api private
898
+ def errors_module
899
+ Errors
900
+ end
901
+
902
+ end
903
+ end
904
+ end