aws-sdk-licensemanager 1.9.0 → 1.14.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 +5 -5
- data/lib/aws-sdk-licensemanager.rb +7 -4
- data/lib/aws-sdk-licensemanager/client.rb +308 -110
- data/lib/aws-sdk-licensemanager/client_api.rb +74 -0
- data/lib/aws-sdk-licensemanager/errors.rb +32 -10
- data/lib/aws-sdk-licensemanager/resource.rb +1 -0
- data/lib/aws-sdk-licensemanager/types.rb +430 -126
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 9980cf53ded64e66e70d1383d7e997b2d0c0631081871af7d2b24a439288ccaa
|
4
|
+
data.tar.gz: 371feafb605745939c8058b7cdaa7c7515858d6d63f4d79f426dd223278ad5fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ce5e9b8d8c6928f58e8d5411c92cb88d3b9700a7e7172701ffc949bd43c06e1d3034a6a43d566e2e1d566335eac3ad6cb7a3dca338328a9bec327cf3c65521ac
|
7
|
+
data.tar.gz: 7a6010cd4cbe24edfc242abf24f3a937fcd77b279e7d77393ebf20d7918518a87423f0c6dee4faabfb32509adc38cfbff5f5802f567d9d786a443d0f1653a7f9
|
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-licensemanager/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# license_manager = Aws::LicenseManager::Client.new
|
28
|
+
# resp = license_manager.create_license_configuration(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS License Manager
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS License Manager are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::LicenseManager::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS License Manager API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-licensemanager/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::LicenseManager
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.14.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:licensemanager)
|
31
31
|
|
32
32
|
module Aws::LicenseManager
|
33
|
+
# An API client for LicenseManager. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::LicenseManager::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::LicenseManager
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::LicenseManager
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::LicenseManager
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::LicenseManager
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::LicenseManager
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::LicenseManager
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::LicenseManager
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::LicenseManager
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::LicenseManager
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -264,39 +318,54 @@ module Aws::LicenseManager
|
|
264
318
|
|
265
319
|
# @!group API Operations
|
266
320
|
|
267
|
-
# Creates a
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
#
|
321
|
+
# Creates a license configuration.
|
322
|
+
#
|
323
|
+
# A license configuration is an abstraction of a customer license
|
324
|
+
# agreement that can be consumed and enforced by License Manager.
|
325
|
+
# Components include specifications for the license type (licensing by
|
326
|
+
# instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy,
|
327
|
+
# Dedicated Instance, Dedicated Host, or all of these), host affinity
|
328
|
+
# (how long a VM must be associated with a host), and the number of
|
329
|
+
# licenses purchased and used.
|
274
330
|
#
|
275
331
|
# @option params [required, String] :name
|
276
332
|
# Name of the license configuration.
|
277
333
|
#
|
278
334
|
# @option params [String] :description
|
279
|
-
#
|
335
|
+
# Description of the license configuration.
|
280
336
|
#
|
281
337
|
# @option params [required, String] :license_counting_type
|
282
|
-
# Dimension
|
338
|
+
# Dimension used to track the license inventory.
|
283
339
|
#
|
284
340
|
# @option params [Integer] :license_count
|
285
341
|
# Number of licenses managed by the license configuration.
|
286
342
|
#
|
287
343
|
# @option params [Boolean] :license_count_hard_limit
|
288
|
-
#
|
289
|
-
#
|
290
|
-
# instances.
|
344
|
+
# Indicates whether hard or soft license enforcement is used. Exceeding
|
345
|
+
# a hard limit blocks the launch of new instances.
|
291
346
|
#
|
292
347
|
# @option params [Array<String>] :license_rules
|
293
|
-
#
|
348
|
+
# License rules. The syntax is #name=value (for example,
|
349
|
+
# #allowedTenancy=EC2-DedicatedHost). Available rules vary by dimension.
|
350
|
+
#
|
351
|
+
# * `Cores` dimension: `allowedTenancy` \| `maximumCores` \|
|
352
|
+
# `minimumCores`
|
353
|
+
#
|
354
|
+
# * `Instances` dimension: `allowedTenancy` \| `maximumCores` \|
|
355
|
+
# `minimumCores` \| `maximumSockets` \| `minimumSockets` \|
|
356
|
+
# `maximumVcpus` \| `minimumVcpus`
|
357
|
+
#
|
358
|
+
# * `Sockets` dimension: `allowedTenancy` \| `maximumSockets` \|
|
359
|
+
# `minimumSockets`
|
360
|
+
#
|
361
|
+
# * `vCPUs` dimension: `allowedTenancy` \| `honorVcpuOptimization` \|
|
362
|
+
# `maximumVcpus` \| `minimumVcpus`
|
294
363
|
#
|
295
364
|
# @option params [Array<Types::Tag>] :tags
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
365
|
+
# Tags to add to the license configuration.
|
366
|
+
#
|
367
|
+
# @option params [Array<Types::ProductInformation>] :product_information_list
|
368
|
+
# Product information.
|
300
369
|
#
|
301
370
|
# @return [Types::CreateLicenseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
302
371
|
#
|
@@ -317,6 +386,18 @@ module Aws::LicenseManager
|
|
317
386
|
# value: "String",
|
318
387
|
# },
|
319
388
|
# ],
|
389
|
+
# product_information_list: [
|
390
|
+
# {
|
391
|
+
# resource_type: "String", # required
|
392
|
+
# product_information_filter_list: [ # required
|
393
|
+
# {
|
394
|
+
# product_information_filter_name: "String", # required
|
395
|
+
# product_information_filter_value: ["String"], # required
|
396
|
+
# product_information_filter_comparator: "String", # required
|
397
|
+
# },
|
398
|
+
# ],
|
399
|
+
# },
|
400
|
+
# ],
|
320
401
|
# })
|
321
402
|
#
|
322
403
|
# @example Response structure
|
@@ -332,11 +413,12 @@ module Aws::LicenseManager
|
|
332
413
|
req.send_request(options)
|
333
414
|
end
|
334
415
|
|
335
|
-
# Deletes
|
336
|
-
#
|
416
|
+
# Deletes the specified license configuration.
|
417
|
+
#
|
418
|
+
# You cannot delete a license configuration that is in use.
|
337
419
|
#
|
338
420
|
# @option params [required, String] :license_configuration_arn
|
339
|
-
#
|
421
|
+
# ID of the license configuration.
|
340
422
|
#
|
341
423
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
342
424
|
#
|
@@ -355,10 +437,10 @@ module Aws::LicenseManager
|
|
355
437
|
req.send_request(options)
|
356
438
|
end
|
357
439
|
|
358
|
-
#
|
440
|
+
# Gets detailed information about the specified license configuration.
|
359
441
|
#
|
360
442
|
# @option params [required, String] :license_configuration_arn
|
361
|
-
# ARN of the license configuration
|
443
|
+
# Amazon Resource Name (ARN) of the license configuration.
|
362
444
|
#
|
363
445
|
# @return [Types::GetLicenseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
364
446
|
#
|
@@ -376,6 +458,8 @@ module Aws::LicenseManager
|
|
376
458
|
# * {Types::GetLicenseConfigurationResponse#consumed_license_summary_list #consumed_license_summary_list} => Array<Types::ConsumedLicenseSummary>
|
377
459
|
# * {Types::GetLicenseConfigurationResponse#managed_resource_summary_list #managed_resource_summary_list} => Array<Types::ManagedResourceSummary>
|
378
460
|
# * {Types::GetLicenseConfigurationResponse#tags #tags} => Array<Types::Tag>
|
461
|
+
# * {Types::GetLicenseConfigurationResponse#product_information_list #product_information_list} => Array<Types::ProductInformation>
|
462
|
+
# * {Types::GetLicenseConfigurationResponse#automated_discovery_information #automated_discovery_information} => Types::AutomatedDiscoveryInformation
|
379
463
|
#
|
380
464
|
# @example Request syntax with placeholder values
|
381
465
|
#
|
@@ -398,14 +482,22 @@ module Aws::LicenseManager
|
|
398
482
|
# resp.status #=> String
|
399
483
|
# resp.owner_account_id #=> String
|
400
484
|
# resp.consumed_license_summary_list #=> Array
|
401
|
-
# resp.consumed_license_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
485
|
+
# resp.consumed_license_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
402
486
|
# resp.consumed_license_summary_list[0].consumed_licenses #=> Integer
|
403
487
|
# resp.managed_resource_summary_list #=> Array
|
404
|
-
# resp.managed_resource_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
488
|
+
# resp.managed_resource_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
405
489
|
# resp.managed_resource_summary_list[0].association_count #=> Integer
|
406
490
|
# resp.tags #=> Array
|
407
491
|
# resp.tags[0].key #=> String
|
408
492
|
# resp.tags[0].value #=> String
|
493
|
+
# resp.product_information_list #=> Array
|
494
|
+
# resp.product_information_list[0].resource_type #=> String
|
495
|
+
# resp.product_information_list[0].product_information_filter_list #=> Array
|
496
|
+
# resp.product_information_list[0].product_information_filter_list[0].product_information_filter_name #=> String
|
497
|
+
# resp.product_information_list[0].product_information_filter_list[0].product_information_filter_value #=> Array
|
498
|
+
# resp.product_information_list[0].product_information_filter_list[0].product_information_filter_value[0] #=> String
|
499
|
+
# resp.product_information_list[0].product_information_filter_list[0].product_information_filter_comparator #=> String
|
500
|
+
# resp.automated_discovery_information.last_run_time #=> Time
|
409
501
|
#
|
410
502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetLicenseConfiguration AWS API Documentation
|
411
503
|
#
|
@@ -416,8 +508,7 @@ module Aws::LicenseManager
|
|
416
508
|
req.send_request(options)
|
417
509
|
end
|
418
510
|
|
419
|
-
# Gets License Manager settings for
|
420
|
-
# bucket, SNS topic, etc., for inspection.
|
511
|
+
# Gets the License Manager settings for the current Region.
|
421
512
|
#
|
422
513
|
# @return [Types::GetServiceSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
514
|
#
|
@@ -425,6 +516,7 @@ module Aws::LicenseManager
|
|
425
516
|
# * {Types::GetServiceSettingsResponse#sns_topic_arn #sns_topic_arn} => String
|
426
517
|
# * {Types::GetServiceSettingsResponse#organization_configuration #organization_configuration} => Types::OrganizationConfiguration
|
427
518
|
# * {Types::GetServiceSettingsResponse#enable_cross_accounts_discovery #enable_cross_accounts_discovery} => Boolean
|
519
|
+
# * {Types::GetServiceSettingsResponse#license_manager_resource_share_arn #license_manager_resource_share_arn} => String
|
428
520
|
#
|
429
521
|
# @example Response structure
|
430
522
|
#
|
@@ -432,6 +524,7 @@ module Aws::LicenseManager
|
|
432
524
|
# resp.sns_topic_arn #=> String
|
433
525
|
# resp.organization_configuration.enable_integration #=> Boolean
|
434
526
|
# resp.enable_cross_accounts_discovery #=> Boolean
|
527
|
+
# resp.license_manager_resource_share_arn #=> String
|
435
528
|
#
|
436
529
|
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetServiceSettings AWS API Documentation
|
437
530
|
#
|
@@ -442,19 +535,18 @@ module Aws::LicenseManager
|
|
442
535
|
req.send_request(options)
|
443
536
|
end
|
444
537
|
|
445
|
-
# Lists the resource associations for
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
538
|
+
# Lists the resource associations for the specified license
|
539
|
+
# configuration.
|
540
|
+
#
|
541
|
+
# Resource associations need not consume licenses from a license
|
542
|
+
# configuration. For example, an AMI or a stopped instance might not
|
543
|
+
# consume a license (depending on the license rules).
|
450
544
|
#
|
451
545
|
# @option params [required, String] :license_configuration_arn
|
452
|
-
# ARN of a
|
546
|
+
# Amazon Resource Name (ARN) of a license configuration.
|
453
547
|
#
|
454
548
|
# @option params [Integer] :max_results
|
455
|
-
# Maximum number of results to return in a single call.
|
456
|
-
# remaining results, make another call with the returned `NextToken`
|
457
|
-
# value.
|
549
|
+
# Maximum number of results to return in a single call.
|
458
550
|
#
|
459
551
|
# @option params [String] :next_token
|
460
552
|
# Token for the next set of results.
|
@@ -476,7 +568,7 @@ module Aws::LicenseManager
|
|
476
568
|
#
|
477
569
|
# resp.license_configuration_associations #=> Array
|
478
570
|
# resp.license_configuration_associations[0].resource_arn #=> String
|
479
|
-
# resp.license_configuration_associations[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
571
|
+
# resp.license_configuration_associations[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
480
572
|
# resp.license_configuration_associations[0].resource_owner_id #=> String
|
481
573
|
# resp.license_configuration_associations[0].association_time #=> Time
|
482
574
|
# resp.next_token #=> String
|
@@ -490,23 +582,79 @@ module Aws::LicenseManager
|
|
490
582
|
req.send_request(options)
|
491
583
|
end
|
492
584
|
|
493
|
-
# Lists license configuration
|
494
|
-
#
|
495
|
-
#
|
585
|
+
# Lists the license configuration operations that failed.
|
586
|
+
#
|
587
|
+
# @option params [required, String] :license_configuration_arn
|
588
|
+
# Amazon Resource Name of the license configuration.
|
589
|
+
#
|
590
|
+
# @option params [Integer] :max_results
|
591
|
+
# Maximum number of results to return in a single call.
|
592
|
+
#
|
593
|
+
# @option params [String] :next_token
|
594
|
+
# Token for the next set of results.
|
595
|
+
#
|
596
|
+
# @return [Types::ListFailuresForLicenseConfigurationOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
597
|
+
#
|
598
|
+
# * {Types::ListFailuresForLicenseConfigurationOperationsResponse#license_operation_failure_list #license_operation_failure_list} => Array<Types::LicenseOperationFailure>
|
599
|
+
# * {Types::ListFailuresForLicenseConfigurationOperationsResponse#next_token #next_token} => String
|
600
|
+
#
|
601
|
+
# @example Request syntax with placeholder values
|
602
|
+
#
|
603
|
+
# resp = client.list_failures_for_license_configuration_operations({
|
604
|
+
# license_configuration_arn: "String", # required
|
605
|
+
# max_results: 1,
|
606
|
+
# next_token: "String",
|
607
|
+
# })
|
608
|
+
#
|
609
|
+
# @example Response structure
|
610
|
+
#
|
611
|
+
# resp.license_operation_failure_list #=> Array
|
612
|
+
# resp.license_operation_failure_list[0].resource_arn #=> String
|
613
|
+
# resp.license_operation_failure_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
614
|
+
# resp.license_operation_failure_list[0].error_message #=> String
|
615
|
+
# resp.license_operation_failure_list[0].failure_time #=> Time
|
616
|
+
# resp.license_operation_failure_list[0].operation_name #=> String
|
617
|
+
# resp.license_operation_failure_list[0].resource_owner_id #=> String
|
618
|
+
# resp.license_operation_failure_list[0].operation_requested_by #=> String
|
619
|
+
# resp.license_operation_failure_list[0].metadata_list #=> Array
|
620
|
+
# resp.license_operation_failure_list[0].metadata_list[0].name #=> String
|
621
|
+
# resp.license_operation_failure_list[0].metadata_list[0].value #=> String
|
622
|
+
# resp.next_token #=> String
|
623
|
+
#
|
624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListFailuresForLicenseConfigurationOperations AWS API Documentation
|
625
|
+
#
|
626
|
+
# @overload list_failures_for_license_configuration_operations(params = {})
|
627
|
+
# @param [Hash] params ({})
|
628
|
+
def list_failures_for_license_configuration_operations(params = {}, options = {})
|
629
|
+
req = build_request(:list_failures_for_license_configuration_operations, params)
|
630
|
+
req.send_request(options)
|
631
|
+
end
|
632
|
+
|
633
|
+
# Lists the license configurations for your account.
|
496
634
|
#
|
497
635
|
# @option params [Array<String>] :license_configuration_arns
|
498
|
-
#
|
636
|
+
# Amazon Resource Names (ARN) of the license configurations.
|
499
637
|
#
|
500
638
|
# @option params [Integer] :max_results
|
501
|
-
# Maximum number of results to return in a single call.
|
502
|
-
# remaining results, make another call with the returned `NextToken`
|
503
|
-
# value.
|
639
|
+
# Maximum number of results to return in a single call.
|
504
640
|
#
|
505
641
|
# @option params [String] :next_token
|
506
642
|
# Token for the next set of results.
|
507
643
|
#
|
508
644
|
# @option params [Array<Types::Filter>] :filters
|
509
|
-
#
|
645
|
+
# Filters to scope the results. The following filters and logical
|
646
|
+
# operators are supported:
|
647
|
+
#
|
648
|
+
# * `licenseCountingType` - The dimension on which licenses are counted
|
649
|
+
# (vCPU). Logical operators are `EQUALS` \| `NOT_EQUALS`.
|
650
|
+
#
|
651
|
+
# * `enforceLicenseCount` - A Boolean value that indicates whether hard
|
652
|
+
# license enforcement is used. Logical operators are `EQUALS` \|
|
653
|
+
# `NOT_EQUALS`.
|
654
|
+
#
|
655
|
+
# * `usagelimitExceeded` - A Boolean value that indicates whether the
|
656
|
+
# available licenses have been exceeded. Logical operators are
|
657
|
+
# `EQUALS` \| `NOT_EQUALS`.
|
510
658
|
#
|
511
659
|
# @return [Types::ListLicenseConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
512
660
|
#
|
@@ -543,11 +691,19 @@ module Aws::LicenseManager
|
|
543
691
|
# resp.license_configurations[0].status #=> String
|
544
692
|
# resp.license_configurations[0].owner_account_id #=> String
|
545
693
|
# resp.license_configurations[0].consumed_license_summary_list #=> Array
|
546
|
-
# resp.license_configurations[0].consumed_license_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
694
|
+
# resp.license_configurations[0].consumed_license_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
547
695
|
# resp.license_configurations[0].consumed_license_summary_list[0].consumed_licenses #=> Integer
|
548
696
|
# resp.license_configurations[0].managed_resource_summary_list #=> Array
|
549
|
-
# resp.license_configurations[0].managed_resource_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
697
|
+
# resp.license_configurations[0].managed_resource_summary_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
550
698
|
# resp.license_configurations[0].managed_resource_summary_list[0].association_count #=> Integer
|
699
|
+
# resp.license_configurations[0].product_information_list #=> Array
|
700
|
+
# resp.license_configurations[0].product_information_list[0].resource_type #=> String
|
701
|
+
# resp.license_configurations[0].product_information_list[0].product_information_filter_list #=> Array
|
702
|
+
# resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_name #=> String
|
703
|
+
# resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_value #=> Array
|
704
|
+
# resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_value[0] #=> String
|
705
|
+
# resp.license_configurations[0].product_information_list[0].product_information_filter_list[0].product_information_filter_comparator #=> String
|
706
|
+
# resp.license_configurations[0].automated_discovery_information.last_run_time #=> Time
|
551
707
|
# resp.next_token #=> String
|
552
708
|
#
|
553
709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListLicenseConfigurations AWS API Documentation
|
@@ -559,16 +715,14 @@ module Aws::LicenseManager
|
|
559
715
|
req.send_request(options)
|
560
716
|
end
|
561
717
|
|
562
|
-
#
|
718
|
+
# Describes the license configurations for the specified resource.
|
563
719
|
#
|
564
720
|
# @option params [required, String] :resource_arn
|
565
|
-
#
|
566
|
-
# configuration.
|
721
|
+
# Amazon Resource Name (ARN) of a resource that has an associated
|
722
|
+
# license configuration.
|
567
723
|
#
|
568
724
|
# @option params [Integer] :max_results
|
569
|
-
# Maximum number of results to return in a single call.
|
570
|
-
# remaining results, make another call with the returned `NextToken`
|
571
|
-
# value.
|
725
|
+
# Maximum number of results to return in a single call.
|
572
726
|
#
|
573
727
|
# @option params [String] :next_token
|
574
728
|
# Token for the next set of results.
|
@@ -601,18 +755,34 @@ module Aws::LicenseManager
|
|
601
755
|
req.send_request(options)
|
602
756
|
end
|
603
757
|
|
604
|
-
#
|
758
|
+
# Lists resources managed using Systems Manager inventory.
|
605
759
|
#
|
606
760
|
# @option params [Integer] :max_results
|
607
|
-
# Maximum number of results to return in a single call.
|
608
|
-
# remaining results, make another call with the returned `NextToken`
|
609
|
-
# value.
|
761
|
+
# Maximum number of results to return in a single call.
|
610
762
|
#
|
611
763
|
# @option params [String] :next_token
|
612
764
|
# Token for the next set of results.
|
613
765
|
#
|
614
766
|
# @option params [Array<Types::InventoryFilter>] :filters
|
615
|
-
#
|
767
|
+
# Filters to scope the results. The following filters and logical
|
768
|
+
# operators are supported:
|
769
|
+
#
|
770
|
+
# * `account_id` - The ID of the AWS account that owns the resource.
|
771
|
+
# Logical operators are `EQUALS` \| `NOT_EQUALS`.
|
772
|
+
#
|
773
|
+
# * `application_name` - The name of the application. Logical operators
|
774
|
+
# are `EQUALS` \| `BEGINS_WITH`.
|
775
|
+
#
|
776
|
+
# * `license_included` - The type of license included. Logical operators
|
777
|
+
# are `EQUALS` \| `NOT_EQUALS`. Possible values are
|
778
|
+
# `sql-server-enterprise` \| `sql-server-standard` \| `sql-server-web`
|
779
|
+
# \| `windows-server-datacenter`.
|
780
|
+
#
|
781
|
+
# * `platform` - The platform of the resource. Logical operators are
|
782
|
+
# `EQUALS` \| `BEGINS_WITH`.
|
783
|
+
#
|
784
|
+
# * `resource_id` - The ID of the resource. Logical operators are
|
785
|
+
# `EQUALS` \| `NOT_EQUALS`.
|
616
786
|
#
|
617
787
|
# @return [Types::ListResourceInventoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
618
788
|
#
|
@@ -637,7 +807,7 @@ module Aws::LicenseManager
|
|
637
807
|
#
|
638
808
|
# resp.resource_inventory_list #=> Array
|
639
809
|
# resp.resource_inventory_list[0].resource_id #=> String
|
640
|
-
# resp.resource_inventory_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
810
|
+
# resp.resource_inventory_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
641
811
|
# resp.resource_inventory_list[0].resource_arn #=> String
|
642
812
|
# resp.resource_inventory_list[0].platform #=> String
|
643
813
|
# resp.resource_inventory_list[0].platform_version #=> String
|
@@ -653,10 +823,10 @@ module Aws::LicenseManager
|
|
653
823
|
req.send_request(options)
|
654
824
|
end
|
655
825
|
|
656
|
-
# Lists tags
|
826
|
+
# Lists the tags for the specified license configuration.
|
657
827
|
#
|
658
828
|
# @option params [required, String] :resource_arn
|
659
|
-
# ARN
|
829
|
+
# Amazon Resource Name (ARN) of the license configuration.
|
660
830
|
#
|
661
831
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
662
832
|
#
|
@@ -689,18 +859,27 @@ module Aws::LicenseManager
|
|
689
859
|
# any license inventory and configuration.
|
690
860
|
#
|
691
861
|
# @option params [required, String] :license_configuration_arn
|
692
|
-
# ARN of the
|
862
|
+
# Amazon Resource Name (ARN) of the license configuration.
|
693
863
|
#
|
694
864
|
# @option params [Integer] :max_results
|
695
|
-
# Maximum number of results to return in a single call.
|
696
|
-
# remaining results, make another call with the returned `NextToken`
|
697
|
-
# value.
|
865
|
+
# Maximum number of results to return in a single call.
|
698
866
|
#
|
699
867
|
# @option params [String] :next_token
|
700
868
|
# Token for the next set of results.
|
701
869
|
#
|
702
870
|
# @option params [Array<Types::Filter>] :filters
|
703
|
-
#
|
871
|
+
# Filters to scope the results. The following filters and logical
|
872
|
+
# operators are supported:
|
873
|
+
#
|
874
|
+
# * `resourceArn` - The ARN of the license configuration resource.
|
875
|
+
# Logical operators are `EQUALS` \| `NOT_EQUALS`.
|
876
|
+
#
|
877
|
+
# * `resourceType` - The resource type (EC2\_INSTANCE \| EC2\_HOST \|
|
878
|
+
# EC2\_AMI \| SYSTEMS\_MANAGER\_MANAGED\_INSTANCE). Logical operators
|
879
|
+
# are `EQUALS` \| `NOT_EQUALS`.
|
880
|
+
#
|
881
|
+
# * `resourceAccount` - The ID of the account that owns the resource.
|
882
|
+
# Logical operators are `EQUALS` \| `NOT_EQUALS`.
|
704
883
|
#
|
705
884
|
# @return [Types::ListUsageForLicenseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
706
885
|
#
|
@@ -725,7 +904,7 @@ module Aws::LicenseManager
|
|
725
904
|
#
|
726
905
|
# resp.license_configuration_usage_list #=> Array
|
727
906
|
# resp.license_configuration_usage_list[0].resource_arn #=> String
|
728
|
-
# resp.license_configuration_usage_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI"
|
907
|
+
# resp.license_configuration_usage_list[0].resource_type #=> String, one of "EC2_INSTANCE", "EC2_HOST", "EC2_AMI", "RDS", "SYSTEMS_MANAGER_MANAGED_INSTANCE"
|
729
908
|
# resp.license_configuration_usage_list[0].resource_status #=> String
|
730
909
|
# resp.license_configuration_usage_list[0].resource_owner_id #=> String
|
731
910
|
# resp.license_configuration_usage_list[0].association_time #=> Time
|
@@ -741,13 +920,13 @@ module Aws::LicenseManager
|
|
741
920
|
req.send_request(options)
|
742
921
|
end
|
743
922
|
|
744
|
-
#
|
923
|
+
# Adds the specified tags to the specified license configuration.
|
745
924
|
#
|
746
925
|
# @option params [required, String] :resource_arn
|
747
|
-
# Resource of the
|
926
|
+
# Amazon Resource Name (ARN) of the license configuration.
|
748
927
|
#
|
749
928
|
# @option params [required, Array<Types::Tag>] :tags
|
750
|
-
#
|
929
|
+
# One or more tags.
|
751
930
|
#
|
752
931
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
753
932
|
#
|
@@ -772,13 +951,13 @@ module Aws::LicenseManager
|
|
772
951
|
req.send_request(options)
|
773
952
|
end
|
774
953
|
|
775
|
-
#
|
954
|
+
# Removes the specified tags from the specified license configuration.
|
776
955
|
#
|
777
956
|
# @option params [required, String] :resource_arn
|
778
|
-
# ARN of the
|
957
|
+
# Amazon Resource Name (ARN) of the license configuration.
|
779
958
|
#
|
780
959
|
# @option params [required, Array<String>] :tag_keys
|
781
|
-
#
|
960
|
+
# Keys identifying the tags to remove.
|
782
961
|
#
|
783
962
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
784
963
|
#
|
@@ -798,34 +977,39 @@ module Aws::LicenseManager
|
|
798
977
|
req.send_request(options)
|
799
978
|
end
|
800
979
|
|
801
|
-
# Modifies the attributes of an existing license configuration
|
802
|
-
#
|
980
|
+
# Modifies the attributes of an existing license configuration.
|
981
|
+
#
|
982
|
+
# A license configuration is an abstraction of a customer license
|
803
983
|
# agreement that can be consumed and enforced by License Manager.
|
804
|
-
# Components include specifications for the license type (
|
805
|
-
#
|
806
|
-
#
|
984
|
+
# Components include specifications for the license type (licensing by
|
985
|
+
# instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy,
|
986
|
+
# Dedicated Instance, Dedicated Host, or all of these), host affinity
|
987
|
+
# (how long a VM must be associated with a host), and the number of
|
807
988
|
# licenses purchased and used.
|
808
989
|
#
|
809
990
|
# @option params [required, String] :license_configuration_arn
|
810
|
-
# ARN
|
991
|
+
# Amazon Resource Name (ARN) of the license configuration.
|
811
992
|
#
|
812
993
|
# @option params [String] :license_configuration_status
|
813
|
-
# New status of the license configuration
|
994
|
+
# New status of the license configuration.
|
814
995
|
#
|
815
996
|
# @option params [Array<String>] :license_rules
|
816
|
-
#
|
997
|
+
# New license rules.
|
817
998
|
#
|
818
999
|
# @option params [Integer] :license_count
|
819
1000
|
# New number of licenses managed by the license configuration.
|
820
1001
|
#
|
821
1002
|
# @option params [Boolean] :license_count_hard_limit
|
822
|
-
#
|
1003
|
+
# New hard limit of the number of available licenses.
|
823
1004
|
#
|
824
1005
|
# @option params [String] :name
|
825
1006
|
# New name of the license configuration.
|
826
1007
|
#
|
827
1008
|
# @option params [String] :description
|
828
|
-
# New
|
1009
|
+
# New description of the license configuration.
|
1010
|
+
#
|
1011
|
+
# @option params [Array<Types::ProductInformation>] :product_information_list
|
1012
|
+
# New product information.
|
829
1013
|
#
|
830
1014
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
831
1015
|
#
|
@@ -839,6 +1023,18 @@ module Aws::LicenseManager
|
|
839
1023
|
# license_count_hard_limit: false,
|
840
1024
|
# name: "String",
|
841
1025
|
# description: "String",
|
1026
|
+
# product_information_list: [
|
1027
|
+
# {
|
1028
|
+
# resource_type: "String", # required
|
1029
|
+
# product_information_filter_list: [ # required
|
1030
|
+
# {
|
1031
|
+
# product_information_filter_name: "String", # required
|
1032
|
+
# product_information_filter_value: ["String"], # required
|
1033
|
+
# product_information_filter_comparator: "String", # required
|
1034
|
+
# },
|
1035
|
+
# ],
|
1036
|
+
# },
|
1037
|
+
# ],
|
842
1038
|
# })
|
843
1039
|
#
|
844
1040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/UpdateLicenseConfiguration AWS API Documentation
|
@@ -850,21 +1046,22 @@ module Aws::LicenseManager
|
|
850
1046
|
req.send_request(options)
|
851
1047
|
end
|
852
1048
|
|
853
|
-
# Adds or removes license configurations for
|
854
|
-
#
|
855
|
-
#
|
856
|
-
#
|
857
|
-
#
|
858
|
-
#
|
1049
|
+
# Adds or removes the specified license configurations for the specified
|
1050
|
+
# AWS resource.
|
1051
|
+
#
|
1052
|
+
# You can update the license specifications of AMIs, instances, and
|
1053
|
+
# hosts. You cannot update the license specifications for launch
|
1054
|
+
# templates and AWS CloudFormation templates, as they send license
|
1055
|
+
# configurations to the operation that creates the resource.
|
859
1056
|
#
|
860
1057
|
# @option params [required, String] :resource_arn
|
861
|
-
# ARN
|
1058
|
+
# Amazon Resource Name (ARN) of the AWS resource.
|
862
1059
|
#
|
863
1060
|
# @option params [Array<Types::LicenseSpecification>] :add_license_specifications
|
864
|
-
#
|
1061
|
+
# ARNs of the license configurations to add.
|
865
1062
|
#
|
866
1063
|
# @option params [Array<Types::LicenseSpecification>] :remove_license_specifications
|
867
|
-
#
|
1064
|
+
# ARNs of the license configurations to remove.
|
868
1065
|
#
|
869
1066
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
870
1067
|
#
|
@@ -893,17 +1090,18 @@ module Aws::LicenseManager
|
|
893
1090
|
req.send_request(options)
|
894
1091
|
end
|
895
1092
|
|
896
|
-
# Updates License Manager
|
1093
|
+
# Updates License Manager settings for the current Region.
|
897
1094
|
#
|
898
1095
|
# @option params [String] :s3_bucket_arn
|
899
|
-
# ARN of the Amazon S3 bucket where License
|
900
|
-
# stored.
|
1096
|
+
# Amazon Resource Name (ARN) of the Amazon S3 bucket where the License
|
1097
|
+
# Manager information is stored.
|
901
1098
|
#
|
902
1099
|
# @option params [String] :sns_topic_arn
|
903
|
-
# ARN of the Amazon SNS topic used for License
|
1100
|
+
# Amazon Resource Name (ARN) of the Amazon SNS topic used for License
|
1101
|
+
# Manager alerts.
|
904
1102
|
#
|
905
1103
|
# @option params [Types::OrganizationConfiguration] :organization_configuration
|
906
|
-
#
|
1104
|
+
# Enables integration with AWS Organizations for cross-account
|
907
1105
|
# discovery.
|
908
1106
|
#
|
909
1107
|
# @option params [Boolean] :enable_cross_accounts_discovery
|
@@ -944,7 +1142,7 @@ module Aws::LicenseManager
|
|
944
1142
|
params: params,
|
945
1143
|
config: config)
|
946
1144
|
context[:gem_name] = 'aws-sdk-licensemanager'
|
947
|
-
context[:gem_version] = '1.
|
1145
|
+
context[:gem_version] = '1.14.0'
|
948
1146
|
Seahorse::Client::Request.new(handlers, context)
|
949
1147
|
end
|
950
1148
|
|