aws-sdk-licensemanager 1.21.0 → 1.22.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 +4 -4
- data/lib/aws-sdk-licensemanager.rb +2 -2
- data/lib/aws-sdk-licensemanager/client.rb +1365 -18
- data/lib/aws-sdk-licensemanager/client_api.rb +864 -0
- data/lib/aws-sdk-licensemanager/errors.rb +122 -0
- data/lib/aws-sdk-licensemanager/types.rb +2269 -89
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d64d35689030f89de4afd2664daa2a48f613f893c0c1740197df0a15a5bf87db
|
4
|
+
data.tar.gz: 343bda3e0e2f927e80954661a222a6c524bf1f269f1f20deaa99d7101ab5e94d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b25e25fa6716ce1f2ccc9282755e1ba55fcfa7b85c75d5aa8437dd5cd60327bb774a693ab91ff2b6fafa9264fc59ebc5d5d5784c383439ef05e7b8eca998e700
|
7
|
+
data.tar.gz: be5ea8d071f97c90dbc7600390c325914ab0c482195625dc67434055c5e0ee98a209204492c42d6abc5f1c2d55ce287cf31817f9906212a15bcf9ba812e463c7
|
@@ -28,7 +28,7 @@ require_relative 'aws-sdk-licensemanager/customizations'
|
|
28
28
|
# structure.
|
29
29
|
#
|
30
30
|
# license_manager = Aws::LicenseManager::Client.new
|
31
|
-
# resp = license_manager.
|
31
|
+
# resp = license_manager.accept_grant(params)
|
32
32
|
#
|
33
33
|
# See {Client} for more information.
|
34
34
|
#
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-licensemanager/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::LicenseManager
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.22.0'
|
52
52
|
|
53
53
|
end
|
@@ -337,6 +337,437 @@ module Aws::LicenseManager
|
|
337
337
|
|
338
338
|
# @!group API Operations
|
339
339
|
|
340
|
+
# Accepts the specified grant.
|
341
|
+
#
|
342
|
+
# @option params [required, String] :grant_arn
|
343
|
+
# Amazon Resource Name (ARN) of the grant.
|
344
|
+
#
|
345
|
+
# @return [Types::AcceptGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
346
|
+
#
|
347
|
+
# * {Types::AcceptGrantResponse#grant_arn #grant_arn} => String
|
348
|
+
# * {Types::AcceptGrantResponse#status #status} => String
|
349
|
+
# * {Types::AcceptGrantResponse#version #version} => String
|
350
|
+
#
|
351
|
+
# @example Request syntax with placeholder values
|
352
|
+
#
|
353
|
+
# resp = client.accept_grant({
|
354
|
+
# grant_arn: "Arn", # required
|
355
|
+
# })
|
356
|
+
#
|
357
|
+
# @example Response structure
|
358
|
+
#
|
359
|
+
# resp.grant_arn #=> String
|
360
|
+
# resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
361
|
+
# resp.version #=> String
|
362
|
+
#
|
363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/AcceptGrant AWS API Documentation
|
364
|
+
#
|
365
|
+
# @overload accept_grant(params = {})
|
366
|
+
# @param [Hash] params ({})
|
367
|
+
def accept_grant(params = {}, options = {})
|
368
|
+
req = build_request(:accept_grant, params)
|
369
|
+
req.send_request(options)
|
370
|
+
end
|
371
|
+
|
372
|
+
# Checks in the specified license. Check in a license when it is no
|
373
|
+
# longer in use.
|
374
|
+
#
|
375
|
+
# @option params [required, String] :license_consumption_token
|
376
|
+
# License consumption token.
|
377
|
+
#
|
378
|
+
# @option params [String] :beneficiary
|
379
|
+
# License beneficiary.
|
380
|
+
#
|
381
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
382
|
+
#
|
383
|
+
# @example Request syntax with placeholder values
|
384
|
+
#
|
385
|
+
# resp = client.check_in_license({
|
386
|
+
# license_consumption_token: "String", # required
|
387
|
+
# beneficiary: "String",
|
388
|
+
# })
|
389
|
+
#
|
390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CheckInLicense AWS API Documentation
|
391
|
+
#
|
392
|
+
# @overload check_in_license(params = {})
|
393
|
+
# @param [Hash] params ({})
|
394
|
+
def check_in_license(params = {}, options = {})
|
395
|
+
req = build_request(:check_in_license, params)
|
396
|
+
req.send_request(options)
|
397
|
+
end
|
398
|
+
|
399
|
+
# Checks out the specified license for offline use.
|
400
|
+
#
|
401
|
+
# @option params [required, String] :license_arn
|
402
|
+
# Amazon Resource Name (ARN) of the license. The license must use the
|
403
|
+
# borrow consumption configuration.
|
404
|
+
#
|
405
|
+
# @option params [required, Array<Types::EntitlementData>] :entitlements
|
406
|
+
# License entitlements. Partial checkouts are not supported.
|
407
|
+
#
|
408
|
+
# @option params [required, String] :digital_signature_method
|
409
|
+
# Digital signature method. The possible value is JSON Web Signature
|
410
|
+
# (JWS) algorithm PS384. For more information, see [RFC 7518 Digital
|
411
|
+
# Signature with RSASSA-PSS][1].
|
412
|
+
#
|
413
|
+
#
|
414
|
+
#
|
415
|
+
# [1]: https://tools.ietf.org/html/rfc7518#section-3.5
|
416
|
+
#
|
417
|
+
# @option params [String] :node_id
|
418
|
+
# Node ID.
|
419
|
+
#
|
420
|
+
# @option params [Array<Types::Metadata>] :checkout_metadata
|
421
|
+
# Information about constraints.
|
422
|
+
#
|
423
|
+
# @option params [required, String] :client_token
|
424
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
425
|
+
# idempotency of the request.
|
426
|
+
#
|
427
|
+
# @return [Types::CheckoutBorrowLicenseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
|
+
#
|
429
|
+
# * {Types::CheckoutBorrowLicenseResponse#license_arn #license_arn} => String
|
430
|
+
# * {Types::CheckoutBorrowLicenseResponse#license_consumption_token #license_consumption_token} => String
|
431
|
+
# * {Types::CheckoutBorrowLicenseResponse#entitlements_allowed #entitlements_allowed} => Array<Types::EntitlementData>
|
432
|
+
# * {Types::CheckoutBorrowLicenseResponse#node_id #node_id} => String
|
433
|
+
# * {Types::CheckoutBorrowLicenseResponse#signed_token #signed_token} => String
|
434
|
+
# * {Types::CheckoutBorrowLicenseResponse#issued_at #issued_at} => String
|
435
|
+
# * {Types::CheckoutBorrowLicenseResponse#expiration #expiration} => String
|
436
|
+
# * {Types::CheckoutBorrowLicenseResponse#checkout_metadata #checkout_metadata} => Array<Types::Metadata>
|
437
|
+
#
|
438
|
+
# @example Request syntax with placeholder values
|
439
|
+
#
|
440
|
+
# resp = client.checkout_borrow_license({
|
441
|
+
# license_arn: "Arn", # required
|
442
|
+
# entitlements: [ # required
|
443
|
+
# {
|
444
|
+
# name: "String", # required
|
445
|
+
# value: "String",
|
446
|
+
# unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
|
447
|
+
# },
|
448
|
+
# ],
|
449
|
+
# digital_signature_method: "JWT_PS384", # required, accepts JWT_PS384
|
450
|
+
# node_id: "String",
|
451
|
+
# checkout_metadata: [
|
452
|
+
# {
|
453
|
+
# name: "String",
|
454
|
+
# value: "String",
|
455
|
+
# },
|
456
|
+
# ],
|
457
|
+
# client_token: "ClientToken", # required
|
458
|
+
# })
|
459
|
+
#
|
460
|
+
# @example Response structure
|
461
|
+
#
|
462
|
+
# resp.license_arn #=> String
|
463
|
+
# resp.license_consumption_token #=> String
|
464
|
+
# resp.entitlements_allowed #=> Array
|
465
|
+
# resp.entitlements_allowed[0].name #=> String
|
466
|
+
# resp.entitlements_allowed[0].value #=> String
|
467
|
+
# resp.entitlements_allowed[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
468
|
+
# resp.node_id #=> String
|
469
|
+
# resp.signed_token #=> String
|
470
|
+
# resp.issued_at #=> String
|
471
|
+
# resp.expiration #=> String
|
472
|
+
# resp.checkout_metadata #=> Array
|
473
|
+
# resp.checkout_metadata[0].name #=> String
|
474
|
+
# resp.checkout_metadata[0].value #=> String
|
475
|
+
#
|
476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CheckoutBorrowLicense AWS API Documentation
|
477
|
+
#
|
478
|
+
# @overload checkout_borrow_license(params = {})
|
479
|
+
# @param [Hash] params ({})
|
480
|
+
def checkout_borrow_license(params = {}, options = {})
|
481
|
+
req = build_request(:checkout_borrow_license, params)
|
482
|
+
req.send_request(options)
|
483
|
+
end
|
484
|
+
|
485
|
+
# Checks out the specified license.
|
486
|
+
#
|
487
|
+
# @option params [required, String] :product_sku
|
488
|
+
# Product SKU.
|
489
|
+
#
|
490
|
+
# @option params [required, String] :checkout_type
|
491
|
+
# Checkout type.
|
492
|
+
#
|
493
|
+
# @option params [required, String] :key_fingerprint
|
494
|
+
# Key fingerprint identifying the license.
|
495
|
+
#
|
496
|
+
# @option params [required, Array<Types::EntitlementData>] :entitlements
|
497
|
+
# License entitlements.
|
498
|
+
#
|
499
|
+
# @option params [required, String] :client_token
|
500
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
501
|
+
# idempotency of the request.
|
502
|
+
#
|
503
|
+
# @option params [String] :beneficiary
|
504
|
+
# License beneficiary.
|
505
|
+
#
|
506
|
+
# @option params [String] :node_id
|
507
|
+
# Node ID.
|
508
|
+
#
|
509
|
+
# @return [Types::CheckoutLicenseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
510
|
+
#
|
511
|
+
# * {Types::CheckoutLicenseResponse#checkout_type #checkout_type} => String
|
512
|
+
# * {Types::CheckoutLicenseResponse#license_consumption_token #license_consumption_token} => String
|
513
|
+
# * {Types::CheckoutLicenseResponse#entitlements_allowed #entitlements_allowed} => Array<Types::EntitlementData>
|
514
|
+
# * {Types::CheckoutLicenseResponse#signed_token #signed_token} => String
|
515
|
+
# * {Types::CheckoutLicenseResponse#node_id #node_id} => String
|
516
|
+
# * {Types::CheckoutLicenseResponse#issued_at #issued_at} => String
|
517
|
+
# * {Types::CheckoutLicenseResponse#expiration #expiration} => String
|
518
|
+
#
|
519
|
+
# @example Request syntax with placeholder values
|
520
|
+
#
|
521
|
+
# resp = client.checkout_license({
|
522
|
+
# product_sku: "String", # required
|
523
|
+
# checkout_type: "PROVISIONAL", # required, accepts PROVISIONAL
|
524
|
+
# key_fingerprint: "String", # required
|
525
|
+
# entitlements: [ # required
|
526
|
+
# {
|
527
|
+
# name: "String", # required
|
528
|
+
# value: "String",
|
529
|
+
# unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
|
530
|
+
# },
|
531
|
+
# ],
|
532
|
+
# client_token: "ClientToken", # required
|
533
|
+
# beneficiary: "String",
|
534
|
+
# node_id: "String",
|
535
|
+
# })
|
536
|
+
#
|
537
|
+
# @example Response structure
|
538
|
+
#
|
539
|
+
# resp.checkout_type #=> String, one of "PROVISIONAL"
|
540
|
+
# resp.license_consumption_token #=> String
|
541
|
+
# resp.entitlements_allowed #=> Array
|
542
|
+
# resp.entitlements_allowed[0].name #=> String
|
543
|
+
# resp.entitlements_allowed[0].value #=> String
|
544
|
+
# resp.entitlements_allowed[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
545
|
+
# resp.signed_token #=> String
|
546
|
+
# resp.node_id #=> String
|
547
|
+
# resp.issued_at #=> String
|
548
|
+
# resp.expiration #=> String
|
549
|
+
#
|
550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CheckoutLicense AWS API Documentation
|
551
|
+
#
|
552
|
+
# @overload checkout_license(params = {})
|
553
|
+
# @param [Hash] params ({})
|
554
|
+
def checkout_license(params = {}, options = {})
|
555
|
+
req = build_request(:checkout_license, params)
|
556
|
+
req.send_request(options)
|
557
|
+
end
|
558
|
+
|
559
|
+
# Creates a grant for the specified license. A grant shares the use of
|
560
|
+
# license entitlements with specific AWS accounts.
|
561
|
+
#
|
562
|
+
# @option params [required, String] :client_token
|
563
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
564
|
+
# idempotency of the request.
|
565
|
+
#
|
566
|
+
# @option params [required, String] :grant_name
|
567
|
+
# Grant name.
|
568
|
+
#
|
569
|
+
# @option params [required, String] :license_arn
|
570
|
+
# Amazon Resource Name (ARN) of the license.
|
571
|
+
#
|
572
|
+
# @option params [required, Array<String>] :principals
|
573
|
+
# The grant principals.
|
574
|
+
#
|
575
|
+
# @option params [required, String] :home_region
|
576
|
+
# Home Region of the grant.
|
577
|
+
#
|
578
|
+
# @option params [required, Array<String>] :allowed_operations
|
579
|
+
# Allowed operations for the grant.
|
580
|
+
#
|
581
|
+
# @return [Types::CreateGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
582
|
+
#
|
583
|
+
# * {Types::CreateGrantResponse#grant_arn #grant_arn} => String
|
584
|
+
# * {Types::CreateGrantResponse#status #status} => String
|
585
|
+
# * {Types::CreateGrantResponse#version #version} => String
|
586
|
+
#
|
587
|
+
# @example Request syntax with placeholder values
|
588
|
+
#
|
589
|
+
# resp = client.create_grant({
|
590
|
+
# client_token: "String", # required
|
591
|
+
# grant_name: "String", # required
|
592
|
+
# license_arn: "Arn", # required
|
593
|
+
# principals: ["Arn"], # required
|
594
|
+
# home_region: "String", # required
|
595
|
+
# allowed_operations: ["CreateGrant"], # required, accepts CreateGrant, CheckoutLicense, CheckoutBorrowLicense, CheckInLicense, ExtendConsumptionLicense, ListPurchasedLicenses, CreateToken
|
596
|
+
# })
|
597
|
+
#
|
598
|
+
# @example Response structure
|
599
|
+
#
|
600
|
+
# resp.grant_arn #=> String
|
601
|
+
# resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
602
|
+
# resp.version #=> String
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateGrant AWS API Documentation
|
605
|
+
#
|
606
|
+
# @overload create_grant(params = {})
|
607
|
+
# @param [Hash] params ({})
|
608
|
+
def create_grant(params = {}, options = {})
|
609
|
+
req = build_request(:create_grant, params)
|
610
|
+
req.send_request(options)
|
611
|
+
end
|
612
|
+
|
613
|
+
# Creates a new version of the specified grant.
|
614
|
+
#
|
615
|
+
# @option params [required, String] :client_token
|
616
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
617
|
+
# idempotency of the request.
|
618
|
+
#
|
619
|
+
# @option params [required, String] :grant_arn
|
620
|
+
# Amazon Resource Name (ARN) of the grant.
|
621
|
+
#
|
622
|
+
# @option params [String] :grant_name
|
623
|
+
# Grant name.
|
624
|
+
#
|
625
|
+
# @option params [Array<String>] :allowed_operations
|
626
|
+
# Allowed operations for the grant.
|
627
|
+
#
|
628
|
+
# @option params [String] :status
|
629
|
+
# Grant status.
|
630
|
+
#
|
631
|
+
# @option params [String] :source_version
|
632
|
+
# Current version of the grant.
|
633
|
+
#
|
634
|
+
# @return [Types::CreateGrantVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
635
|
+
#
|
636
|
+
# * {Types::CreateGrantVersionResponse#grant_arn #grant_arn} => String
|
637
|
+
# * {Types::CreateGrantVersionResponse#status #status} => String
|
638
|
+
# * {Types::CreateGrantVersionResponse#version #version} => String
|
639
|
+
#
|
640
|
+
# @example Request syntax with placeholder values
|
641
|
+
#
|
642
|
+
# resp = client.create_grant_version({
|
643
|
+
# client_token: "String", # required
|
644
|
+
# grant_arn: "Arn", # required
|
645
|
+
# grant_name: "String",
|
646
|
+
# allowed_operations: ["CreateGrant"], # accepts CreateGrant, CheckoutLicense, CheckoutBorrowLicense, CheckInLicense, ExtendConsumptionLicense, ListPurchasedLicenses, CreateToken
|
647
|
+
# status: "PENDING_WORKFLOW", # accepts PENDING_WORKFLOW, PENDING_ACCEPT, REJECTED, ACTIVE, FAILED_WORKFLOW, DELETED, PENDING_DELETE, DISABLED
|
648
|
+
# source_version: "String",
|
649
|
+
# })
|
650
|
+
#
|
651
|
+
# @example Response structure
|
652
|
+
#
|
653
|
+
# resp.grant_arn #=> String
|
654
|
+
# resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
655
|
+
# resp.version #=> String
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateGrantVersion AWS API Documentation
|
658
|
+
#
|
659
|
+
# @overload create_grant_version(params = {})
|
660
|
+
# @param [Hash] params ({})
|
661
|
+
def create_grant_version(params = {}, options = {})
|
662
|
+
req = build_request(:create_grant_version, params)
|
663
|
+
req.send_request(options)
|
664
|
+
end
|
665
|
+
|
666
|
+
# Creates a license.
|
667
|
+
#
|
668
|
+
# @option params [required, String] :license_name
|
669
|
+
# License name.
|
670
|
+
#
|
671
|
+
# @option params [required, String] :product_name
|
672
|
+
# Product name.
|
673
|
+
#
|
674
|
+
# @option params [required, String] :product_sku
|
675
|
+
# Product SKU.
|
676
|
+
#
|
677
|
+
# @option params [required, Types::Issuer] :issuer
|
678
|
+
# License issuer.
|
679
|
+
#
|
680
|
+
# @option params [required, String] :home_region
|
681
|
+
# Home Region for the license.
|
682
|
+
#
|
683
|
+
# @option params [required, Types::DatetimeRange] :validity
|
684
|
+
# Date and time range during which the license is valid, in ISO8601-UTC
|
685
|
+
# format.
|
686
|
+
#
|
687
|
+
# @option params [required, Array<Types::Entitlement>] :entitlements
|
688
|
+
# License entitlements.
|
689
|
+
#
|
690
|
+
# @option params [required, String] :beneficiary
|
691
|
+
# License beneficiary.
|
692
|
+
#
|
693
|
+
# @option params [required, Types::ConsumptionConfiguration] :consumption_configuration
|
694
|
+
# Configuration for consumption of the license. Choose a provisional
|
695
|
+
# configuration for workloads running with continuous connectivity.
|
696
|
+
# Choose a borrow configuration for workloads with offline usage.
|
697
|
+
#
|
698
|
+
# @option params [Array<Types::Metadata>] :license_metadata
|
699
|
+
# Information about the license.
|
700
|
+
#
|
701
|
+
# @option params [required, String] :client_token
|
702
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
703
|
+
# idempotency of the request.
|
704
|
+
#
|
705
|
+
# @return [Types::CreateLicenseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
706
|
+
#
|
707
|
+
# * {Types::CreateLicenseResponse#license_arn #license_arn} => String
|
708
|
+
# * {Types::CreateLicenseResponse#status #status} => String
|
709
|
+
# * {Types::CreateLicenseResponse#version #version} => String
|
710
|
+
#
|
711
|
+
# @example Request syntax with placeholder values
|
712
|
+
#
|
713
|
+
# resp = client.create_license({
|
714
|
+
# license_name: "String", # required
|
715
|
+
# product_name: "String", # required
|
716
|
+
# product_sku: "String", # required
|
717
|
+
# issuer: { # required
|
718
|
+
# name: "String", # required
|
719
|
+
# sign_key: "String",
|
720
|
+
# },
|
721
|
+
# home_region: "String", # required
|
722
|
+
# validity: { # required
|
723
|
+
# begin: "ISO8601DateTime", # required
|
724
|
+
# end: "ISO8601DateTime",
|
725
|
+
# },
|
726
|
+
# entitlements: [ # required
|
727
|
+
# {
|
728
|
+
# name: "String", # required
|
729
|
+
# value: "String",
|
730
|
+
# max_count: 1,
|
731
|
+
# overage: false,
|
732
|
+
# unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
|
733
|
+
# allow_check_in: false,
|
734
|
+
# },
|
735
|
+
# ],
|
736
|
+
# beneficiary: "String", # required
|
737
|
+
# consumption_configuration: { # required
|
738
|
+
# renew_type: "None", # accepts None, Weekly, Monthly
|
739
|
+
# provisional_configuration: {
|
740
|
+
# max_time_to_live_in_minutes: 1, # required
|
741
|
+
# },
|
742
|
+
# borrow_configuration: {
|
743
|
+
# allow_early_check_in: false, # required
|
744
|
+
# max_time_to_live_in_minutes: 1, # required
|
745
|
+
# },
|
746
|
+
# },
|
747
|
+
# license_metadata: [
|
748
|
+
# {
|
749
|
+
# name: "String",
|
750
|
+
# value: "String",
|
751
|
+
# },
|
752
|
+
# ],
|
753
|
+
# client_token: "String", # required
|
754
|
+
# })
|
755
|
+
#
|
756
|
+
# @example Response structure
|
757
|
+
#
|
758
|
+
# resp.license_arn #=> String
|
759
|
+
# resp.status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
|
760
|
+
# resp.version #=> String
|
761
|
+
#
|
762
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicense AWS API Documentation
|
763
|
+
#
|
764
|
+
# @overload create_license(params = {})
|
765
|
+
# @param [Hash] params ({})
|
766
|
+
def create_license(params = {}, options = {})
|
767
|
+
req = build_request(:create_license, params)
|
768
|
+
req.send_request(options)
|
769
|
+
end
|
770
|
+
|
340
771
|
# Creates a license configuration.
|
341
772
|
#
|
342
773
|
# A license configuration is an abstraction of a customer license
|
@@ -429,36 +860,465 @@ module Aws::LicenseManager
|
|
429
860
|
#
|
430
861
|
# resp.license_configuration_arn #=> String
|
431
862
|
#
|
432
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicenseConfiguration AWS API Documentation
|
863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicenseConfiguration AWS API Documentation
|
864
|
+
#
|
865
|
+
# @overload create_license_configuration(params = {})
|
866
|
+
# @param [Hash] params ({})
|
867
|
+
def create_license_configuration(params = {}, options = {})
|
868
|
+
req = build_request(:create_license_configuration, params)
|
869
|
+
req.send_request(options)
|
870
|
+
end
|
871
|
+
|
872
|
+
# Creates a new version of the specified license.
|
873
|
+
#
|
874
|
+
# @option params [required, String] :license_arn
|
875
|
+
# Amazon Resource Name (ARN) of the license.
|
876
|
+
#
|
877
|
+
# @option params [required, String] :license_name
|
878
|
+
# License name.
|
879
|
+
#
|
880
|
+
# @option params [required, String] :product_name
|
881
|
+
# Product name.
|
882
|
+
#
|
883
|
+
# @option params [required, Types::Issuer] :issuer
|
884
|
+
# License issuer.
|
885
|
+
#
|
886
|
+
# @option params [required, String] :home_region
|
887
|
+
# Home Region of the license.
|
888
|
+
#
|
889
|
+
# @option params [required, Types::DatetimeRange] :validity
|
890
|
+
# Date and time range during which the license is valid, in ISO8601-UTC
|
891
|
+
# format.
|
892
|
+
#
|
893
|
+
# @option params [Array<Types::Metadata>] :license_metadata
|
894
|
+
# Information about the license.
|
895
|
+
#
|
896
|
+
# @option params [required, Array<Types::Entitlement>] :entitlements
|
897
|
+
# License entitlements.
|
898
|
+
#
|
899
|
+
# @option params [required, Types::ConsumptionConfiguration] :consumption_configuration
|
900
|
+
# Configuration for consumption of the license. Choose a provisional
|
901
|
+
# configuration for workloads running with continuous connectivity.
|
902
|
+
# Choose a borrow configuration for workloads with offline usage.
|
903
|
+
#
|
904
|
+
# @option params [required, String] :status
|
905
|
+
# License status.
|
906
|
+
#
|
907
|
+
# @option params [required, String] :client_token
|
908
|
+
# Unique, case-sensitive identifier that you provide to ensure the
|
909
|
+
# idempotency of the request.
|
910
|
+
#
|
911
|
+
# @option params [String] :source_version
|
912
|
+
# Current version of the license.
|
913
|
+
#
|
914
|
+
# @return [Types::CreateLicenseVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
915
|
+
#
|
916
|
+
# * {Types::CreateLicenseVersionResponse#license_arn #license_arn} => String
|
917
|
+
# * {Types::CreateLicenseVersionResponse#version #version} => String
|
918
|
+
# * {Types::CreateLicenseVersionResponse#status #status} => String
|
919
|
+
#
|
920
|
+
# @example Request syntax with placeholder values
|
921
|
+
#
|
922
|
+
# resp = client.create_license_version({
|
923
|
+
# license_arn: "Arn", # required
|
924
|
+
# license_name: "String", # required
|
925
|
+
# product_name: "String", # required
|
926
|
+
# issuer: { # required
|
927
|
+
# name: "String", # required
|
928
|
+
# sign_key: "String",
|
929
|
+
# },
|
930
|
+
# home_region: "String", # required
|
931
|
+
# validity: { # required
|
932
|
+
# begin: "ISO8601DateTime", # required
|
933
|
+
# end: "ISO8601DateTime",
|
934
|
+
# },
|
935
|
+
# license_metadata: [
|
936
|
+
# {
|
937
|
+
# name: "String",
|
938
|
+
# value: "String",
|
939
|
+
# },
|
940
|
+
# ],
|
941
|
+
# entitlements: [ # required
|
942
|
+
# {
|
943
|
+
# name: "String", # required
|
944
|
+
# value: "String",
|
945
|
+
# max_count: 1,
|
946
|
+
# overage: false,
|
947
|
+
# unit: "Count", # required, accepts Count, None, Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second
|
948
|
+
# allow_check_in: false,
|
949
|
+
# },
|
950
|
+
# ],
|
951
|
+
# consumption_configuration: { # required
|
952
|
+
# renew_type: "None", # accepts None, Weekly, Monthly
|
953
|
+
# provisional_configuration: {
|
954
|
+
# max_time_to_live_in_minutes: 1, # required
|
955
|
+
# },
|
956
|
+
# borrow_configuration: {
|
957
|
+
# allow_early_check_in: false, # required
|
958
|
+
# max_time_to_live_in_minutes: 1, # required
|
959
|
+
# },
|
960
|
+
# },
|
961
|
+
# status: "AVAILABLE", # required, accepts AVAILABLE, PENDING_AVAILABLE, DEACTIVATED, SUSPENDED, EXPIRED, PENDING_DELETE, DELETED
|
962
|
+
# client_token: "String", # required
|
963
|
+
# source_version: "String",
|
964
|
+
# })
|
965
|
+
#
|
966
|
+
# @example Response structure
|
967
|
+
#
|
968
|
+
# resp.license_arn #=> String
|
969
|
+
# resp.version #=> String
|
970
|
+
# resp.status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
|
971
|
+
#
|
972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateLicenseVersion AWS API Documentation
|
973
|
+
#
|
974
|
+
# @overload create_license_version(params = {})
|
975
|
+
# @param [Hash] params ({})
|
976
|
+
def create_license_version(params = {}, options = {})
|
977
|
+
req = build_request(:create_license_version, params)
|
978
|
+
req.send_request(options)
|
979
|
+
end
|
980
|
+
|
981
|
+
# Creates a long-lived token.
|
982
|
+
#
|
983
|
+
# A refresh token is a JWT token used to get an access token. With an
|
984
|
+
# access token, you can call AssumeRoleWithWebIdentity to get role
|
985
|
+
# credentials that you can use to call License Manager to manage the
|
986
|
+
# specified license.
|
987
|
+
#
|
988
|
+
# @option params [required, String] :license_arn
|
989
|
+
# Amazon Resource Name (ARN) of the license. The ARN is mapped to the
|
990
|
+
# aud claim of the JWT token.
|
991
|
+
#
|
992
|
+
# @option params [Array<String>] :role_arns
|
993
|
+
# Amazon Resource Name (ARN) of the IAM roles to embed in the token.
|
994
|
+
# License Manager does not check whether the roles are in use.
|
995
|
+
#
|
996
|
+
# @option params [Integer] :expiration_in_days
|
997
|
+
# Token expiration, in days, counted from token creation. The default is
|
998
|
+
# 365 days.
|
999
|
+
#
|
1000
|
+
# @option params [Array<String>] :token_properties
|
1001
|
+
# Data specified by the caller to be included in the JWT token. The data
|
1002
|
+
# is mapped to the amr claim of the JWT token.
|
1003
|
+
#
|
1004
|
+
# @option params [required, String] :client_token
|
1005
|
+
# Idempotency token, valid for 10 minutes.
|
1006
|
+
#
|
1007
|
+
# @return [Types::CreateTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1008
|
+
#
|
1009
|
+
# * {Types::CreateTokenResponse#token_id #token_id} => String
|
1010
|
+
# * {Types::CreateTokenResponse#token_type #token_type} => String
|
1011
|
+
# * {Types::CreateTokenResponse#token #token} => String
|
1012
|
+
#
|
1013
|
+
# @example Request syntax with placeholder values
|
1014
|
+
#
|
1015
|
+
# resp = client.create_token({
|
1016
|
+
# license_arn: "Arn", # required
|
1017
|
+
# role_arns: ["Arn"],
|
1018
|
+
# expiration_in_days: 1,
|
1019
|
+
# token_properties: ["String"],
|
1020
|
+
# client_token: "IdempotencyToken", # required
|
1021
|
+
# })
|
1022
|
+
#
|
1023
|
+
# @example Response structure
|
1024
|
+
#
|
1025
|
+
# resp.token_id #=> String
|
1026
|
+
# resp.token_type #=> String, one of "REFRESH_TOKEN"
|
1027
|
+
# resp.token #=> String
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CreateToken AWS API Documentation
|
1030
|
+
#
|
1031
|
+
# @overload create_token(params = {})
|
1032
|
+
# @param [Hash] params ({})
|
1033
|
+
def create_token(params = {}, options = {})
|
1034
|
+
req = build_request(:create_token, params)
|
1035
|
+
req.send_request(options)
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# Deletes the specified grant.
|
1039
|
+
#
|
1040
|
+
# @option params [required, String] :grant_arn
|
1041
|
+
# Amazon Resource Name (ARN) of the grant.
|
1042
|
+
#
|
1043
|
+
# @option params [required, String] :version
|
1044
|
+
# Current version of the grant.
|
1045
|
+
#
|
1046
|
+
# @return [Types::DeleteGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1047
|
+
#
|
1048
|
+
# * {Types::DeleteGrantResponse#grant_arn #grant_arn} => String
|
1049
|
+
# * {Types::DeleteGrantResponse#status #status} => String
|
1050
|
+
# * {Types::DeleteGrantResponse#version #version} => String
|
1051
|
+
#
|
1052
|
+
# @example Request syntax with placeholder values
|
1053
|
+
#
|
1054
|
+
# resp = client.delete_grant({
|
1055
|
+
# grant_arn: "Arn", # required
|
1056
|
+
# version: "String", # required
|
1057
|
+
# })
|
1058
|
+
#
|
1059
|
+
# @example Response structure
|
1060
|
+
#
|
1061
|
+
# resp.grant_arn #=> String
|
1062
|
+
# resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
1063
|
+
# resp.version #=> String
|
1064
|
+
#
|
1065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/DeleteGrant AWS API Documentation
|
1066
|
+
#
|
1067
|
+
# @overload delete_grant(params = {})
|
1068
|
+
# @param [Hash] params ({})
|
1069
|
+
def delete_grant(params = {}, options = {})
|
1070
|
+
req = build_request(:delete_grant, params)
|
1071
|
+
req.send_request(options)
|
1072
|
+
end
|
1073
|
+
|
1074
|
+
# Deletes the specified license.
|
1075
|
+
#
|
1076
|
+
# @option params [required, String] :license_arn
|
1077
|
+
# Amazon Resource Name (ARN) of the license.
|
1078
|
+
#
|
1079
|
+
# @option params [required, String] :source_version
|
1080
|
+
# Current version of the license.
|
1081
|
+
#
|
1082
|
+
# @return [Types::DeleteLicenseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1083
|
+
#
|
1084
|
+
# * {Types::DeleteLicenseResponse#status #status} => String
|
1085
|
+
# * {Types::DeleteLicenseResponse#deletion_date #deletion_date} => String
|
1086
|
+
#
|
1087
|
+
# @example Request syntax with placeholder values
|
1088
|
+
#
|
1089
|
+
# resp = client.delete_license({
|
1090
|
+
# license_arn: "Arn", # required
|
1091
|
+
# source_version: "String", # required
|
1092
|
+
# })
|
1093
|
+
#
|
1094
|
+
# @example Response structure
|
1095
|
+
#
|
1096
|
+
# resp.status #=> String, one of "PENDING_DELETE", "DELETED"
|
1097
|
+
# resp.deletion_date #=> String
|
1098
|
+
#
|
1099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/DeleteLicense AWS API Documentation
|
1100
|
+
#
|
1101
|
+
# @overload delete_license(params = {})
|
1102
|
+
# @param [Hash] params ({})
|
1103
|
+
def delete_license(params = {}, options = {})
|
1104
|
+
req = build_request(:delete_license, params)
|
1105
|
+
req.send_request(options)
|
1106
|
+
end
|
1107
|
+
|
1108
|
+
# Deletes the specified license configuration.
|
1109
|
+
#
|
1110
|
+
# You cannot delete a license configuration that is in use.
|
1111
|
+
#
|
1112
|
+
# @option params [required, String] :license_configuration_arn
|
1113
|
+
# ID of the license configuration.
|
1114
|
+
#
|
1115
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1116
|
+
#
|
1117
|
+
# @example Request syntax with placeholder values
|
1118
|
+
#
|
1119
|
+
# resp = client.delete_license_configuration({
|
1120
|
+
# license_configuration_arn: "String", # required
|
1121
|
+
# })
|
1122
|
+
#
|
1123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/DeleteLicenseConfiguration AWS API Documentation
|
1124
|
+
#
|
1125
|
+
# @overload delete_license_configuration(params = {})
|
1126
|
+
# @param [Hash] params ({})
|
1127
|
+
def delete_license_configuration(params = {}, options = {})
|
1128
|
+
req = build_request(:delete_license_configuration, params)
|
1129
|
+
req.send_request(options)
|
1130
|
+
end
|
1131
|
+
|
1132
|
+
# Deletes the specified token. Must be called in the license home
|
1133
|
+
# Region.
|
1134
|
+
#
|
1135
|
+
# @option params [required, String] :token_id
|
1136
|
+
# Token ID.
|
1137
|
+
#
|
1138
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1139
|
+
#
|
1140
|
+
# @example Request syntax with placeholder values
|
1141
|
+
#
|
1142
|
+
# resp = client.delete_token({
|
1143
|
+
# token_id: "String", # required
|
1144
|
+
# })
|
1145
|
+
#
|
1146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/DeleteToken AWS API Documentation
|
1147
|
+
#
|
1148
|
+
# @overload delete_token(params = {})
|
1149
|
+
# @param [Hash] params ({})
|
1150
|
+
def delete_token(params = {}, options = {})
|
1151
|
+
req = build_request(:delete_token, params)
|
1152
|
+
req.send_request(options)
|
1153
|
+
end
|
1154
|
+
|
1155
|
+
# Extends the expiration date for license consumption.
|
1156
|
+
#
|
1157
|
+
# @option params [required, String] :license_consumption_token
|
1158
|
+
# License consumption token.
|
1159
|
+
#
|
1160
|
+
# @option params [Boolean] :dry_run
|
1161
|
+
# Checks whether you have the required permissions for the action,
|
1162
|
+
# without actually making the request. Provides an error response if you
|
1163
|
+
# do not have the required permissions.
|
1164
|
+
#
|
1165
|
+
# @return [Types::ExtendLicenseConsumptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1166
|
+
#
|
1167
|
+
# * {Types::ExtendLicenseConsumptionResponse#license_consumption_token #license_consumption_token} => String
|
1168
|
+
# * {Types::ExtendLicenseConsumptionResponse#expiration #expiration} => String
|
1169
|
+
#
|
1170
|
+
# @example Request syntax with placeholder values
|
1171
|
+
#
|
1172
|
+
# resp = client.extend_license_consumption({
|
1173
|
+
# license_consumption_token: "String", # required
|
1174
|
+
# dry_run: false,
|
1175
|
+
# })
|
1176
|
+
#
|
1177
|
+
# @example Response structure
|
1178
|
+
#
|
1179
|
+
# resp.license_consumption_token #=> String
|
1180
|
+
# resp.expiration #=> String
|
1181
|
+
#
|
1182
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ExtendLicenseConsumption AWS API Documentation
|
1183
|
+
#
|
1184
|
+
# @overload extend_license_consumption(params = {})
|
1185
|
+
# @param [Hash] params ({})
|
1186
|
+
def extend_license_consumption(params = {}, options = {})
|
1187
|
+
req = build_request(:extend_license_consumption, params)
|
1188
|
+
req.send_request(options)
|
1189
|
+
end
|
1190
|
+
|
1191
|
+
# Gets a temporary access token to use with AssumeRoleWithWebIdentity.
|
1192
|
+
# Access tokens are valid for one hour.
|
1193
|
+
#
|
1194
|
+
# @option params [required, String] :token
|
1195
|
+
# Refresh token, encoded as a JWT token.
|
1196
|
+
#
|
1197
|
+
# @option params [Array<String>] :token_properties
|
1198
|
+
# Token properties to validate against those present in the JWT token.
|
1199
|
+
#
|
1200
|
+
# @return [Types::GetAccessTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1201
|
+
#
|
1202
|
+
# * {Types::GetAccessTokenResponse#access_token #access_token} => String
|
1203
|
+
#
|
1204
|
+
# @example Request syntax with placeholder values
|
1205
|
+
#
|
1206
|
+
# resp = client.get_access_token({
|
1207
|
+
# token: "TokenString", # required
|
1208
|
+
# token_properties: ["String"],
|
1209
|
+
# })
|
1210
|
+
#
|
1211
|
+
# @example Response structure
|
1212
|
+
#
|
1213
|
+
# resp.access_token #=> String
|
1214
|
+
#
|
1215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetAccessToken AWS API Documentation
|
1216
|
+
#
|
1217
|
+
# @overload get_access_token(params = {})
|
1218
|
+
# @param [Hash] params ({})
|
1219
|
+
def get_access_token(params = {}, options = {})
|
1220
|
+
req = build_request(:get_access_token, params)
|
1221
|
+
req.send_request(options)
|
1222
|
+
end
|
1223
|
+
|
1224
|
+
# Gets detailed information about the specified grant.
|
1225
|
+
#
|
1226
|
+
# @option params [required, String] :grant_arn
|
1227
|
+
# Amazon Resource Name (ARN) of the grant.
|
1228
|
+
#
|
1229
|
+
# @option params [String] :version
|
1230
|
+
# Grant version.
|
1231
|
+
#
|
1232
|
+
# @return [Types::GetGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1233
|
+
#
|
1234
|
+
# * {Types::GetGrantResponse#grant #grant} => Types::Grant
|
1235
|
+
#
|
1236
|
+
# @example Request syntax with placeholder values
|
1237
|
+
#
|
1238
|
+
# resp = client.get_grant({
|
1239
|
+
# grant_arn: "Arn", # required
|
1240
|
+
# version: "String",
|
1241
|
+
# })
|
1242
|
+
#
|
1243
|
+
# @example Response structure
|
433
1244
|
#
|
434
|
-
#
|
1245
|
+
# resp.grant.grant_arn #=> String
|
1246
|
+
# resp.grant.grant_name #=> String
|
1247
|
+
# resp.grant.parent_arn #=> String
|
1248
|
+
# resp.grant.license_arn #=> String
|
1249
|
+
# resp.grant.grantee_principal_arn #=> String
|
1250
|
+
# resp.grant.home_region #=> String
|
1251
|
+
# resp.grant.grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
1252
|
+
# resp.grant.status_reason #=> String
|
1253
|
+
# resp.grant.version #=> String
|
1254
|
+
# resp.grant.granted_operations #=> Array
|
1255
|
+
# resp.grant.granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
|
1256
|
+
#
|
1257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetGrant AWS API Documentation
|
1258
|
+
#
|
1259
|
+
# @overload get_grant(params = {})
|
435
1260
|
# @param [Hash] params ({})
|
436
|
-
def
|
437
|
-
req = build_request(:
|
1261
|
+
def get_grant(params = {}, options = {})
|
1262
|
+
req = build_request(:get_grant, params)
|
438
1263
|
req.send_request(options)
|
439
1264
|
end
|
440
1265
|
|
441
|
-
#
|
1266
|
+
# Gets detailed information about the specified license.
|
442
1267
|
#
|
443
|
-
#
|
1268
|
+
# @option params [required, String] :license_arn
|
1269
|
+
# Amazon Resource Name (ARN) of the license.
|
444
1270
|
#
|
445
|
-
# @option params [
|
446
|
-
#
|
1271
|
+
# @option params [String] :version
|
1272
|
+
# License version.
|
447
1273
|
#
|
448
|
-
# @return [
|
1274
|
+
# @return [Types::GetLicenseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1275
|
+
#
|
1276
|
+
# * {Types::GetLicenseResponse#license #license} => Types::License
|
449
1277
|
#
|
450
1278
|
# @example Request syntax with placeholder values
|
451
1279
|
#
|
452
|
-
# resp = client.
|
453
|
-
#
|
1280
|
+
# resp = client.get_license({
|
1281
|
+
# license_arn: "Arn", # required
|
1282
|
+
# version: "String",
|
454
1283
|
# })
|
455
1284
|
#
|
456
|
-
# @
|
1285
|
+
# @example Response structure
|
457
1286
|
#
|
458
|
-
#
|
1287
|
+
# resp.license.license_arn #=> String
|
1288
|
+
# resp.license.license_name #=> String
|
1289
|
+
# resp.license.product_name #=> String
|
1290
|
+
# resp.license.product_sku #=> String
|
1291
|
+
# resp.license.issuer.name #=> String
|
1292
|
+
# resp.license.issuer.sign_key #=> String
|
1293
|
+
# resp.license.issuer.key_fingerprint #=> String
|
1294
|
+
# resp.license.home_region #=> String
|
1295
|
+
# resp.license.status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
|
1296
|
+
# resp.license.validity.begin #=> String
|
1297
|
+
# resp.license.validity.end #=> String
|
1298
|
+
# resp.license.beneficiary #=> String
|
1299
|
+
# resp.license.entitlements #=> Array
|
1300
|
+
# resp.license.entitlements[0].name #=> String
|
1301
|
+
# resp.license.entitlements[0].value #=> String
|
1302
|
+
# resp.license.entitlements[0].max_count #=> Integer
|
1303
|
+
# resp.license.entitlements[0].overage #=> Boolean
|
1304
|
+
# resp.license.entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
1305
|
+
# resp.license.entitlements[0].allow_check_in #=> Boolean
|
1306
|
+
# resp.license.consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
|
1307
|
+
# resp.license.consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
|
1308
|
+
# resp.license.consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
|
1309
|
+
# resp.license.consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
|
1310
|
+
# resp.license.license_metadata #=> Array
|
1311
|
+
# resp.license.license_metadata[0].name #=> String
|
1312
|
+
# resp.license.license_metadata[0].value #=> String
|
1313
|
+
# resp.license.create_time #=> String
|
1314
|
+
# resp.license.version #=> String
|
1315
|
+
#
|
1316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetLicense AWS API Documentation
|
1317
|
+
#
|
1318
|
+
# @overload get_license(params = {})
|
459
1319
|
# @param [Hash] params ({})
|
460
|
-
def
|
461
|
-
req = build_request(:
|
1320
|
+
def get_license(params = {}, options = {})
|
1321
|
+
req = build_request(:get_license, params)
|
462
1322
|
req.send_request(options)
|
463
1323
|
end
|
464
1324
|
|
@@ -533,6 +1393,38 @@ module Aws::LicenseManager
|
|
533
1393
|
req.send_request(options)
|
534
1394
|
end
|
535
1395
|
|
1396
|
+
# Gets detailed information about the usage of the specified license.
|
1397
|
+
#
|
1398
|
+
# @option params [required, String] :license_arn
|
1399
|
+
# Amazon Resource Name (ARN) of the license.
|
1400
|
+
#
|
1401
|
+
# @return [Types::GetLicenseUsageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1402
|
+
#
|
1403
|
+
# * {Types::GetLicenseUsageResponse#license_usage #license_usage} => Types::LicenseUsage
|
1404
|
+
#
|
1405
|
+
# @example Request syntax with placeholder values
|
1406
|
+
#
|
1407
|
+
# resp = client.get_license_usage({
|
1408
|
+
# license_arn: "Arn", # required
|
1409
|
+
# })
|
1410
|
+
#
|
1411
|
+
# @example Response structure
|
1412
|
+
#
|
1413
|
+
# resp.license_usage.entitlement_usages #=> Array
|
1414
|
+
# resp.license_usage.entitlement_usages[0].name #=> String
|
1415
|
+
# resp.license_usage.entitlement_usages[0].consumed_value #=> String
|
1416
|
+
# resp.license_usage.entitlement_usages[0].max_count #=> String
|
1417
|
+
# resp.license_usage.entitlement_usages[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
1418
|
+
#
|
1419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/GetLicenseUsage AWS API Documentation
|
1420
|
+
#
|
1421
|
+
# @overload get_license_usage(params = {})
|
1422
|
+
# @param [Hash] params ({})
|
1423
|
+
def get_license_usage(params = {}, options = {})
|
1424
|
+
req = build_request(:get_license_usage, params)
|
1425
|
+
req.send_request(options)
|
1426
|
+
end
|
1427
|
+
|
536
1428
|
# Gets the License Manager settings for the current Region.
|
537
1429
|
#
|
538
1430
|
# @return [Types::GetServiceSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -608,6 +1500,72 @@ module Aws::LicenseManager
|
|
608
1500
|
req.send_request(options)
|
609
1501
|
end
|
610
1502
|
|
1503
|
+
# Lists the grants distributed for the specified license.
|
1504
|
+
#
|
1505
|
+
# @option params [Array<String>] :grant_arns
|
1506
|
+
# Amazon Resource Names (ARNs) of the grants.
|
1507
|
+
#
|
1508
|
+
# @option params [Array<Types::Filter>] :filters
|
1509
|
+
# Filters to scope the results. The following filters are supported:
|
1510
|
+
#
|
1511
|
+
# * `LicenseARN`
|
1512
|
+
#
|
1513
|
+
# * `Status`
|
1514
|
+
#
|
1515
|
+
# * `PrincipalARN`
|
1516
|
+
#
|
1517
|
+
# * `ParentARN`
|
1518
|
+
#
|
1519
|
+
# @option params [String] :next_token
|
1520
|
+
# Token for the next set of results.
|
1521
|
+
#
|
1522
|
+
# @option params [Integer] :max_results
|
1523
|
+
# Maximum number of results to return in a single call.
|
1524
|
+
#
|
1525
|
+
# @return [Types::ListDistributedGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1526
|
+
#
|
1527
|
+
# * {Types::ListDistributedGrantsResponse#grants #grants} => Array<Types::Grant>
|
1528
|
+
# * {Types::ListDistributedGrantsResponse#next_token #next_token} => String
|
1529
|
+
#
|
1530
|
+
# @example Request syntax with placeholder values
|
1531
|
+
#
|
1532
|
+
# resp = client.list_distributed_grants({
|
1533
|
+
# grant_arns: ["Arn"],
|
1534
|
+
# filters: [
|
1535
|
+
# {
|
1536
|
+
# name: "FilterName",
|
1537
|
+
# values: ["FilterValue"],
|
1538
|
+
# },
|
1539
|
+
# ],
|
1540
|
+
# next_token: "String",
|
1541
|
+
# max_results: 1,
|
1542
|
+
# })
|
1543
|
+
#
|
1544
|
+
# @example Response structure
|
1545
|
+
#
|
1546
|
+
# resp.grants #=> Array
|
1547
|
+
# resp.grants[0].grant_arn #=> String
|
1548
|
+
# resp.grants[0].grant_name #=> String
|
1549
|
+
# resp.grants[0].parent_arn #=> String
|
1550
|
+
# resp.grants[0].license_arn #=> String
|
1551
|
+
# resp.grants[0].grantee_principal_arn #=> String
|
1552
|
+
# resp.grants[0].home_region #=> String
|
1553
|
+
# resp.grants[0].grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
1554
|
+
# resp.grants[0].status_reason #=> String
|
1555
|
+
# resp.grants[0].version #=> String
|
1556
|
+
# resp.grants[0].granted_operations #=> Array
|
1557
|
+
# resp.grants[0].granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
|
1558
|
+
# resp.next_token #=> String
|
1559
|
+
#
|
1560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListDistributedGrants AWS API Documentation
|
1561
|
+
#
|
1562
|
+
# @overload list_distributed_grants(params = {})
|
1563
|
+
# @param [Hash] params ({})
|
1564
|
+
def list_distributed_grants(params = {}, options = {})
|
1565
|
+
req = build_request(:list_distributed_grants, params)
|
1566
|
+
req.send_request(options)
|
1567
|
+
end
|
1568
|
+
|
611
1569
|
# Lists the license configuration operations that failed.
|
612
1570
|
#
|
613
1571
|
# @option params [required, String] :license_configuration_arn
|
@@ -783,6 +1741,303 @@ module Aws::LicenseManager
|
|
783
1741
|
req.send_request(options)
|
784
1742
|
end
|
785
1743
|
|
1744
|
+
# Lists all versions of the specified license.
|
1745
|
+
#
|
1746
|
+
# @option params [required, String] :license_arn
|
1747
|
+
# Amazon Resource Name (ARN) of the license.
|
1748
|
+
#
|
1749
|
+
# @option params [String] :next_token
|
1750
|
+
# Token for the next set of results.
|
1751
|
+
#
|
1752
|
+
# @option params [Integer] :max_results
|
1753
|
+
# Maximum number of results to return in a single call.
|
1754
|
+
#
|
1755
|
+
# @return [Types::ListLicenseVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1756
|
+
#
|
1757
|
+
# * {Types::ListLicenseVersionsResponse#licenses #licenses} => Array<Types::License>
|
1758
|
+
# * {Types::ListLicenseVersionsResponse#next_token #next_token} => String
|
1759
|
+
#
|
1760
|
+
# @example Request syntax with placeholder values
|
1761
|
+
#
|
1762
|
+
# resp = client.list_license_versions({
|
1763
|
+
# license_arn: "Arn", # required
|
1764
|
+
# next_token: "String",
|
1765
|
+
# max_results: 1,
|
1766
|
+
# })
|
1767
|
+
#
|
1768
|
+
# @example Response structure
|
1769
|
+
#
|
1770
|
+
# resp.licenses #=> Array
|
1771
|
+
# resp.licenses[0].license_arn #=> String
|
1772
|
+
# resp.licenses[0].license_name #=> String
|
1773
|
+
# resp.licenses[0].product_name #=> String
|
1774
|
+
# resp.licenses[0].product_sku #=> String
|
1775
|
+
# resp.licenses[0].issuer.name #=> String
|
1776
|
+
# resp.licenses[0].issuer.sign_key #=> String
|
1777
|
+
# resp.licenses[0].issuer.key_fingerprint #=> String
|
1778
|
+
# resp.licenses[0].home_region #=> String
|
1779
|
+
# resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
|
1780
|
+
# resp.licenses[0].validity.begin #=> String
|
1781
|
+
# resp.licenses[0].validity.end #=> String
|
1782
|
+
# resp.licenses[0].beneficiary #=> String
|
1783
|
+
# resp.licenses[0].entitlements #=> Array
|
1784
|
+
# resp.licenses[0].entitlements[0].name #=> String
|
1785
|
+
# resp.licenses[0].entitlements[0].value #=> String
|
1786
|
+
# resp.licenses[0].entitlements[0].max_count #=> Integer
|
1787
|
+
# resp.licenses[0].entitlements[0].overage #=> Boolean
|
1788
|
+
# resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
1789
|
+
# resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
|
1790
|
+
# resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
|
1791
|
+
# resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
|
1792
|
+
# resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
|
1793
|
+
# resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
|
1794
|
+
# resp.licenses[0].license_metadata #=> Array
|
1795
|
+
# resp.licenses[0].license_metadata[0].name #=> String
|
1796
|
+
# resp.licenses[0].license_metadata[0].value #=> String
|
1797
|
+
# resp.licenses[0].create_time #=> String
|
1798
|
+
# resp.licenses[0].version #=> String
|
1799
|
+
# resp.next_token #=> String
|
1800
|
+
#
|
1801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListLicenseVersions AWS API Documentation
|
1802
|
+
#
|
1803
|
+
# @overload list_license_versions(params = {})
|
1804
|
+
# @param [Hash] params ({})
|
1805
|
+
def list_license_versions(params = {}, options = {})
|
1806
|
+
req = build_request(:list_license_versions, params)
|
1807
|
+
req.send_request(options)
|
1808
|
+
end
|
1809
|
+
|
1810
|
+
# Lists the licenses for your account.
|
1811
|
+
#
|
1812
|
+
# @option params [Array<String>] :license_arns
|
1813
|
+
# Amazon Resource Names (ARNs) of the licenses.
|
1814
|
+
#
|
1815
|
+
# @option params [Array<Types::Filter>] :filters
|
1816
|
+
# Filters to scope the results. The following filters are supported:
|
1817
|
+
#
|
1818
|
+
# * `Beneficiary`
|
1819
|
+
#
|
1820
|
+
# * `ProductSKU`
|
1821
|
+
#
|
1822
|
+
# * `KeyFingerprint`
|
1823
|
+
#
|
1824
|
+
# * `Status`
|
1825
|
+
#
|
1826
|
+
# @option params [String] :next_token
|
1827
|
+
# Token for the next set of results.
|
1828
|
+
#
|
1829
|
+
# @option params [Integer] :max_results
|
1830
|
+
# Maximum number of results to return in a single call.
|
1831
|
+
#
|
1832
|
+
# @return [Types::ListLicensesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1833
|
+
#
|
1834
|
+
# * {Types::ListLicensesResponse#licenses #licenses} => Array<Types::License>
|
1835
|
+
# * {Types::ListLicensesResponse#next_token #next_token} => String
|
1836
|
+
#
|
1837
|
+
# @example Request syntax with placeholder values
|
1838
|
+
#
|
1839
|
+
# resp = client.list_licenses({
|
1840
|
+
# license_arns: ["Arn"],
|
1841
|
+
# filters: [
|
1842
|
+
# {
|
1843
|
+
# name: "FilterName",
|
1844
|
+
# values: ["FilterValue"],
|
1845
|
+
# },
|
1846
|
+
# ],
|
1847
|
+
# next_token: "String",
|
1848
|
+
# max_results: 1,
|
1849
|
+
# })
|
1850
|
+
#
|
1851
|
+
# @example Response structure
|
1852
|
+
#
|
1853
|
+
# resp.licenses #=> Array
|
1854
|
+
# resp.licenses[0].license_arn #=> String
|
1855
|
+
# resp.licenses[0].license_name #=> String
|
1856
|
+
# resp.licenses[0].product_name #=> String
|
1857
|
+
# resp.licenses[0].product_sku #=> String
|
1858
|
+
# resp.licenses[0].issuer.name #=> String
|
1859
|
+
# resp.licenses[0].issuer.sign_key #=> String
|
1860
|
+
# resp.licenses[0].issuer.key_fingerprint #=> String
|
1861
|
+
# resp.licenses[0].home_region #=> String
|
1862
|
+
# resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
|
1863
|
+
# resp.licenses[0].validity.begin #=> String
|
1864
|
+
# resp.licenses[0].validity.end #=> String
|
1865
|
+
# resp.licenses[0].beneficiary #=> String
|
1866
|
+
# resp.licenses[0].entitlements #=> Array
|
1867
|
+
# resp.licenses[0].entitlements[0].name #=> String
|
1868
|
+
# resp.licenses[0].entitlements[0].value #=> String
|
1869
|
+
# resp.licenses[0].entitlements[0].max_count #=> Integer
|
1870
|
+
# resp.licenses[0].entitlements[0].overage #=> Boolean
|
1871
|
+
# resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
1872
|
+
# resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
|
1873
|
+
# resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
|
1874
|
+
# resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
|
1875
|
+
# resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
|
1876
|
+
# resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
|
1877
|
+
# resp.licenses[0].license_metadata #=> Array
|
1878
|
+
# resp.licenses[0].license_metadata[0].name #=> String
|
1879
|
+
# resp.licenses[0].license_metadata[0].value #=> String
|
1880
|
+
# resp.licenses[0].create_time #=> String
|
1881
|
+
# resp.licenses[0].version #=> String
|
1882
|
+
# resp.next_token #=> String
|
1883
|
+
#
|
1884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListLicenses AWS API Documentation
|
1885
|
+
#
|
1886
|
+
# @overload list_licenses(params = {})
|
1887
|
+
# @param [Hash] params ({})
|
1888
|
+
def list_licenses(params = {}, options = {})
|
1889
|
+
req = build_request(:list_licenses, params)
|
1890
|
+
req.send_request(options)
|
1891
|
+
end
|
1892
|
+
|
1893
|
+
# Lists grants that are received but not accepted.
|
1894
|
+
#
|
1895
|
+
# @option params [Array<String>] :grant_arns
|
1896
|
+
# Amazon Resource Names (ARNs) of the grants.
|
1897
|
+
#
|
1898
|
+
# @option params [Array<Types::Filter>] :filters
|
1899
|
+
# Filters to scope the results. The following filters are supported:
|
1900
|
+
#
|
1901
|
+
# * `LicenseARN`
|
1902
|
+
#
|
1903
|
+
# * `Status`
|
1904
|
+
#
|
1905
|
+
# @option params [String] :next_token
|
1906
|
+
# Token for the next set of results.
|
1907
|
+
#
|
1908
|
+
# @option params [Integer] :max_results
|
1909
|
+
# Maximum number of results to return in a single call.
|
1910
|
+
#
|
1911
|
+
# @return [Types::ListReceivedGrantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1912
|
+
#
|
1913
|
+
# * {Types::ListReceivedGrantsResponse#grants #grants} => Array<Types::Grant>
|
1914
|
+
# * {Types::ListReceivedGrantsResponse#next_token #next_token} => String
|
1915
|
+
#
|
1916
|
+
# @example Request syntax with placeholder values
|
1917
|
+
#
|
1918
|
+
# resp = client.list_received_grants({
|
1919
|
+
# grant_arns: ["Arn"],
|
1920
|
+
# filters: [
|
1921
|
+
# {
|
1922
|
+
# name: "FilterName",
|
1923
|
+
# values: ["FilterValue"],
|
1924
|
+
# },
|
1925
|
+
# ],
|
1926
|
+
# next_token: "String",
|
1927
|
+
# max_results: 1,
|
1928
|
+
# })
|
1929
|
+
#
|
1930
|
+
# @example Response structure
|
1931
|
+
#
|
1932
|
+
# resp.grants #=> Array
|
1933
|
+
# resp.grants[0].grant_arn #=> String
|
1934
|
+
# resp.grants[0].grant_name #=> String
|
1935
|
+
# resp.grants[0].parent_arn #=> String
|
1936
|
+
# resp.grants[0].license_arn #=> String
|
1937
|
+
# resp.grants[0].grantee_principal_arn #=> String
|
1938
|
+
# resp.grants[0].home_region #=> String
|
1939
|
+
# resp.grants[0].grant_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
1940
|
+
# resp.grants[0].status_reason #=> String
|
1941
|
+
# resp.grants[0].version #=> String
|
1942
|
+
# resp.grants[0].granted_operations #=> Array
|
1943
|
+
# resp.grants[0].granted_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
|
1944
|
+
# resp.next_token #=> String
|
1945
|
+
#
|
1946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListReceivedGrants AWS API Documentation
|
1947
|
+
#
|
1948
|
+
# @overload list_received_grants(params = {})
|
1949
|
+
# @param [Hash] params ({})
|
1950
|
+
def list_received_grants(params = {}, options = {})
|
1951
|
+
req = build_request(:list_received_grants, params)
|
1952
|
+
req.send_request(options)
|
1953
|
+
end
|
1954
|
+
|
1955
|
+
# Lists received licenses.
|
1956
|
+
#
|
1957
|
+
# @option params [Array<String>] :license_arns
|
1958
|
+
# Amazon Resource Names (ARNs) of the licenses.
|
1959
|
+
#
|
1960
|
+
# @option params [Array<Types::Filter>] :filters
|
1961
|
+
# Filters to scope the results. The following filters are supported:
|
1962
|
+
#
|
1963
|
+
# * `ProductSKU`
|
1964
|
+
#
|
1965
|
+
# * `Status`
|
1966
|
+
#
|
1967
|
+
# * `KeyFingerprint`
|
1968
|
+
#
|
1969
|
+
# * `Issuer`
|
1970
|
+
#
|
1971
|
+
# @option params [String] :next_token
|
1972
|
+
# Token for the next set of results.
|
1973
|
+
#
|
1974
|
+
# @option params [Integer] :max_results
|
1975
|
+
# Maximum number of results to return in a single call.
|
1976
|
+
#
|
1977
|
+
# @return [Types::ListReceivedLicensesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1978
|
+
#
|
1979
|
+
# * {Types::ListReceivedLicensesResponse#licenses #licenses} => Array<Types::GrantedLicense>
|
1980
|
+
# * {Types::ListReceivedLicensesResponse#next_token #next_token} => String
|
1981
|
+
#
|
1982
|
+
# @example Request syntax with placeholder values
|
1983
|
+
#
|
1984
|
+
# resp = client.list_received_licenses({
|
1985
|
+
# license_arns: ["Arn"],
|
1986
|
+
# filters: [
|
1987
|
+
# {
|
1988
|
+
# name: "FilterName",
|
1989
|
+
# values: ["FilterValue"],
|
1990
|
+
# },
|
1991
|
+
# ],
|
1992
|
+
# next_token: "String",
|
1993
|
+
# max_results: 1,
|
1994
|
+
# })
|
1995
|
+
#
|
1996
|
+
# @example Response structure
|
1997
|
+
#
|
1998
|
+
# resp.licenses #=> Array
|
1999
|
+
# resp.licenses[0].license_arn #=> String
|
2000
|
+
# resp.licenses[0].license_name #=> String
|
2001
|
+
# resp.licenses[0].product_name #=> String
|
2002
|
+
# resp.licenses[0].product_sku #=> String
|
2003
|
+
# resp.licenses[0].issuer.name #=> String
|
2004
|
+
# resp.licenses[0].issuer.sign_key #=> String
|
2005
|
+
# resp.licenses[0].issuer.key_fingerprint #=> String
|
2006
|
+
# resp.licenses[0].home_region #=> String
|
2007
|
+
# resp.licenses[0].status #=> String, one of "AVAILABLE", "PENDING_AVAILABLE", "DEACTIVATED", "SUSPENDED", "EXPIRED", "PENDING_DELETE", "DELETED"
|
2008
|
+
# resp.licenses[0].validity.begin #=> String
|
2009
|
+
# resp.licenses[0].validity.end #=> String
|
2010
|
+
# resp.licenses[0].beneficiary #=> String
|
2011
|
+
# resp.licenses[0].entitlements #=> Array
|
2012
|
+
# resp.licenses[0].entitlements[0].name #=> String
|
2013
|
+
# resp.licenses[0].entitlements[0].value #=> String
|
2014
|
+
# resp.licenses[0].entitlements[0].max_count #=> Integer
|
2015
|
+
# resp.licenses[0].entitlements[0].overage #=> Boolean
|
2016
|
+
# resp.licenses[0].entitlements[0].unit #=> String, one of "Count", "None", "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second"
|
2017
|
+
# resp.licenses[0].entitlements[0].allow_check_in #=> Boolean
|
2018
|
+
# resp.licenses[0].consumption_configuration.renew_type #=> String, one of "None", "Weekly", "Monthly"
|
2019
|
+
# resp.licenses[0].consumption_configuration.provisional_configuration.max_time_to_live_in_minutes #=> Integer
|
2020
|
+
# resp.licenses[0].consumption_configuration.borrow_configuration.allow_early_check_in #=> Boolean
|
2021
|
+
# resp.licenses[0].consumption_configuration.borrow_configuration.max_time_to_live_in_minutes #=> Integer
|
2022
|
+
# resp.licenses[0].license_metadata #=> Array
|
2023
|
+
# resp.licenses[0].license_metadata[0].name #=> String
|
2024
|
+
# resp.licenses[0].license_metadata[0].value #=> String
|
2025
|
+
# resp.licenses[0].create_time #=> String
|
2026
|
+
# resp.licenses[0].version #=> String
|
2027
|
+
# resp.licenses[0].received_metadata.received_status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "DISABLED"
|
2028
|
+
# resp.licenses[0].received_metadata.allowed_operations #=> Array
|
2029
|
+
# resp.licenses[0].received_metadata.allowed_operations[0] #=> String, one of "CreateGrant", "CheckoutLicense", "CheckoutBorrowLicense", "CheckInLicense", "ExtendConsumptionLicense", "ListPurchasedLicenses", "CreateToken"
|
2030
|
+
# resp.next_token #=> String
|
2031
|
+
#
|
2032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListReceivedLicenses AWS API Documentation
|
2033
|
+
#
|
2034
|
+
# @overload list_received_licenses(params = {})
|
2035
|
+
# @param [Hash] params ({})
|
2036
|
+
def list_received_licenses(params = {}, options = {})
|
2037
|
+
req = build_request(:list_received_licenses, params)
|
2038
|
+
req.send_request(options)
|
2039
|
+
end
|
2040
|
+
|
786
2041
|
# Lists resources managed using Systems Manager inventory.
|
787
2042
|
#
|
788
2043
|
# @option params [Integer] :max_results
|
@@ -881,6 +2136,66 @@ module Aws::LicenseManager
|
|
881
2136
|
req.send_request(options)
|
882
2137
|
end
|
883
2138
|
|
2139
|
+
# Lists your tokens.
|
2140
|
+
#
|
2141
|
+
# @option params [Array<String>] :token_ids
|
2142
|
+
# Token IDs.
|
2143
|
+
#
|
2144
|
+
# @option params [Array<Types::Filter>] :filters
|
2145
|
+
# Filters to scope the results. The following filter is supported:
|
2146
|
+
#
|
2147
|
+
# * `licenseArns`
|
2148
|
+
#
|
2149
|
+
# ^
|
2150
|
+
#
|
2151
|
+
# @option params [String] :next_token
|
2152
|
+
# Token for the next set of results.
|
2153
|
+
#
|
2154
|
+
# @option params [Integer] :max_results
|
2155
|
+
# Maximum number of results to return in a single call.
|
2156
|
+
#
|
2157
|
+
# @return [Types::ListTokensResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2158
|
+
#
|
2159
|
+
# * {Types::ListTokensResponse#tokens #tokens} => Array<Types::TokenData>
|
2160
|
+
# * {Types::ListTokensResponse#next_token #next_token} => String
|
2161
|
+
#
|
2162
|
+
# @example Request syntax with placeholder values
|
2163
|
+
#
|
2164
|
+
# resp = client.list_tokens({
|
2165
|
+
# token_ids: ["String"],
|
2166
|
+
# filters: [
|
2167
|
+
# {
|
2168
|
+
# name: "FilterName",
|
2169
|
+
# values: ["FilterValue"],
|
2170
|
+
# },
|
2171
|
+
# ],
|
2172
|
+
# next_token: "String",
|
2173
|
+
# max_results: 1,
|
2174
|
+
# })
|
2175
|
+
#
|
2176
|
+
# @example Response structure
|
2177
|
+
#
|
2178
|
+
# resp.tokens #=> Array
|
2179
|
+
# resp.tokens[0].token_id #=> String
|
2180
|
+
# resp.tokens[0].token_type #=> String
|
2181
|
+
# resp.tokens[0].license_arn #=> String
|
2182
|
+
# resp.tokens[0].expiration_time #=> String
|
2183
|
+
# resp.tokens[0].token_properties #=> Array
|
2184
|
+
# resp.tokens[0].token_properties[0] #=> String
|
2185
|
+
# resp.tokens[0].role_arns #=> Array
|
2186
|
+
# resp.tokens[0].role_arns[0] #=> String
|
2187
|
+
# resp.tokens[0].status #=> String
|
2188
|
+
# resp.next_token #=> String
|
2189
|
+
#
|
2190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/ListTokens AWS API Documentation
|
2191
|
+
#
|
2192
|
+
# @overload list_tokens(params = {})
|
2193
|
+
# @param [Hash] params ({})
|
2194
|
+
def list_tokens(params = {}, options = {})
|
2195
|
+
req = build_request(:list_tokens, params)
|
2196
|
+
req.send_request(options)
|
2197
|
+
end
|
2198
|
+
|
884
2199
|
# Lists all license usage records for a license configuration,
|
885
2200
|
# displaying license consumption details by resource at a selected point
|
886
2201
|
# in time. Use this action to audit the current license consumption for
|
@@ -902,8 +2217,8 @@ module Aws::LicenseManager
|
|
902
2217
|
# * `resourceArn` - The ARN of the license configuration resource.
|
903
2218
|
# Logical operators are `EQUALS` \| `NOT_EQUALS`.
|
904
2219
|
#
|
905
|
-
# * `resourceType` - The resource type (
|
906
|
-
#
|
2220
|
+
# * `resourceType` - The resource type (`EC2_INSTANCE` \| `EC2_HOST` \|
|
2221
|
+
# `EC2_AMI` \| `SYSTEMS_MANAGER_MANAGED_INSTANCE`). Logical operators
|
907
2222
|
# are `EQUALS` \| `NOT_EQUALS`.
|
908
2223
|
#
|
909
2224
|
# * `resourceAccount` - The ID of the account that owns the resource.
|
@@ -948,6 +2263,38 @@ module Aws::LicenseManager
|
|
948
2263
|
req.send_request(options)
|
949
2264
|
end
|
950
2265
|
|
2266
|
+
# Rejects the specified grant.
|
2267
|
+
#
|
2268
|
+
# @option params [required, String] :grant_arn
|
2269
|
+
# Amazon Resource Name (ARN) of the grant.
|
2270
|
+
#
|
2271
|
+
# @return [Types::RejectGrantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2272
|
+
#
|
2273
|
+
# * {Types::RejectGrantResponse#grant_arn #grant_arn} => String
|
2274
|
+
# * {Types::RejectGrantResponse#status #status} => String
|
2275
|
+
# * {Types::RejectGrantResponse#version #version} => String
|
2276
|
+
#
|
2277
|
+
# @example Request syntax with placeholder values
|
2278
|
+
#
|
2279
|
+
# resp = client.reject_grant({
|
2280
|
+
# grant_arn: "Arn", # required
|
2281
|
+
# })
|
2282
|
+
#
|
2283
|
+
# @example Response structure
|
2284
|
+
#
|
2285
|
+
# resp.grant_arn #=> String
|
2286
|
+
# resp.status #=> String, one of "PENDING_WORKFLOW", "PENDING_ACCEPT", "REJECTED", "ACTIVE", "FAILED_WORKFLOW", "DELETED", "PENDING_DELETE", "DISABLED"
|
2287
|
+
# resp.version #=> String
|
2288
|
+
#
|
2289
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/RejectGrant AWS API Documentation
|
2290
|
+
#
|
2291
|
+
# @overload reject_grant(params = {})
|
2292
|
+
# @param [Hash] params ({})
|
2293
|
+
def reject_grant(params = {}, options = {})
|
2294
|
+
req = build_request(:reject_grant, params)
|
2295
|
+
req.send_request(options)
|
2296
|
+
end
|
2297
|
+
|
951
2298
|
# Adds the specified tags to the specified license configuration.
|
952
2299
|
#
|
953
2300
|
# @option params [required, String] :resource_arn
|
@@ -1165,7 +2512,7 @@ module Aws::LicenseManager
|
|
1165
2512
|
params: params,
|
1166
2513
|
config: config)
|
1167
2514
|
context[:gem_name] = 'aws-sdk-licensemanager'
|
1168
|
-
context[:gem_version] = '1.
|
2515
|
+
context[:gem_version] = '1.22.0'
|
1169
2516
|
Seahorse::Client::Request.new(handlers, context)
|
1170
2517
|
end
|
1171
2518
|
|