78
AWS License Manager API Reference API Version 2018-08-01

AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

  • Upload
    others

  • View
    38

  • Download
    0

Embed Size (px)

Citation preview

Page 1: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License ManagerAPI Reference

API Version 2018-08-01

Page 2: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

AWS License Manager : API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.

Page 3: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CreateLicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

DeleteLicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

GetLicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

GetServiceSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

ListAssociationsForLicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

ListFailuresForLicenseConfigurationOperations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

ListLicenseConfigurations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

ListLicenseSpecificationsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

API Version 2018-08-01iii

Page 4: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26ListResourceInventory .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

ListUsageForLicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

UpdateLicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

UpdateLicenseSpecificationsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

UpdateServiceSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48AutomatedDiscoveryInformation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

ConsumedLicenseSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

API Version 2018-08-01iv

Page 5: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Filter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

InventoryFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

LicenseConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

LicenseConfigurationAssociation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

LicenseConfigurationUsage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

LicenseOperationFailure .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

LicenseSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

ManagedResourceSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Metadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

OrganizationConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

ProductInformation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

ProductInformationFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

ResourceInventory .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

API Version 2018-08-01v

Page 6: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

WelcomeAWS License Manager makes it easier to manage licenses from software vendors across multiple AWSaccounts and on-premises servers.

This document was last published on August 13, 2020.

API Version 2018-08-011

Page 7: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

ActionsThe following actions are supported:

• CreateLicenseConfiguration (p. 3)• DeleteLicenseConfiguration (p. 7)• GetLicenseConfiguration (p. 9)• GetServiceSettings (p. 13)• ListAssociationsForLicenseConfiguration (p. 15)• ListFailuresForLicenseConfigurationOperations (p. 18)• ListLicenseConfigurations (p. 21)• ListLicenseSpecificationsForResource (p. 25)• ListResourceInventory (p. 28)• ListTagsForResource (p. 31)• ListUsageForLicenseConfiguration (p. 33)• TagResource (p. 36)• UntagResource (p. 38)• UpdateLicenseConfiguration (p. 40)• UpdateLicenseSpecificationsForResource (p. 43)• UpdateServiceSettings (p. 46)

API Version 2018-08-012

Page 8: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceCreateLicenseConfiguration

CreateLicenseConfigurationCreates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed andenforced by License Manager. Components include specifications for the license type (licensing byinstance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host,or all of these), host affinity (how long a VM must be associated with a host), and the number of licensespurchased and used.

Request Syntax{ "Description": "string", "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseCountingType": "string", "LicenseRules": [ "string" ], "Name": "string", "ProductInformationList": [ { "ProductInformationFilterList": [ { "ProductInformationFilterComparator": "string", "ProductInformationFilterName": "string", "ProductInformationFilterValue": [ "string" ] } ], "ResourceType": "string" } ], "Tags": [ { "Key": "string", "Value": "string" } ]}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

Description (p. 3)

Description of the license configuration.

Type: String

Required: NoLicenseCount (p. 3)

Number of licenses managed by the license configuration.

Type: Long

API Version 2018-08-013

Page 9: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Syntax

Required: NoLicenseCountHardLimit (p. 3)

Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launchof new instances.

Type: Boolean

Required: NoLicenseCountingType (p. 3)

Dimension used to track the license inventory.

Type: String

Valid Values: vCPU | Instance | Core | Socket

Required: YesLicenseRules (p. 3)

License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost).Available rules vary by dimension.• Cores dimension: allowedTenancy | maximumCores | minimumCores• Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets

| minimumSockets | maximumVcpus | minimumVcpus• Sockets dimension: allowedTenancy | maximumSockets | minimumSockets• vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus |minimumVcpus

Type: Array of strings

Required: NoName (p. 3)

Name of the license configuration.

Type: String

Required: YesProductInformationList (p. 3)

Product information.

Type: Array of ProductInformation (p. 65) objects

Required: NoTags (p. 3)

Tags to add to the license configuration.

Type: Array of Tag (p. 69) objects

Required: No

Response Syntax{

API Version 2018-08-014

Page 10: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Elements

"LicenseConfigurationArn": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LicenseConfigurationArn (p. 4)

Amazon Resource Name (ARN) of the license configuration.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2018-08-015

Page 12: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceDeleteLicenseConfiguration

DeleteLicenseConfigurationDeletes the specified license configuration.

You cannot delete a license configuration that is in use.

Request Syntax{ "LicenseConfigurationArn": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

LicenseConfigurationArn (p. 7)

ID of the license configuration.

Type: String

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

API Version 2018-08-017

Page 14: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceGetLicenseConfiguration

GetLicenseConfigurationGets detailed information about the specified license configuration.

Request Syntax{ "LicenseConfigurationArn": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

LicenseConfigurationArn (p. 9)

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: Yes

Response Syntax{ "AutomatedDiscoveryInformation": { "LastRunTime": number }, "ConsumedLicenses": number, "ConsumedLicenseSummaryList": [ { "ConsumedLicenses": number, "ResourceType": "string" } ], "Description": "string", "LicenseConfigurationArn": "string", "LicenseConfigurationId": "string", "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseCountingType": "string", "LicenseRules": [ "string" ], "ManagedResourceSummaryList": [ { "AssociationCount": number, "ResourceType": "string" } ], "Name": "string", "OwnerAccountId": "string", "ProductInformationList": [ { "ProductInformationFilterList": [ {

API Version 2018-08-019

Page 15: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Elements

"ProductInformationFilterComparator": "string", "ProductInformationFilterName": "string", "ProductInformationFilterValue": [ "string" ] } ], "ResourceType": "string" } ], "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AutomatedDiscoveryInformation (p. 9)

Automated discovery information.

Type: AutomatedDiscoveryInformation (p. 49) object

ConsumedLicenses (p. 9)

Number of licenses assigned to resources.

Type: Long

ConsumedLicenseSummaryList (p. 9)

Summaries of the licenses consumed by resources.

Type: Array of ConsumedLicenseSummary (p. 50) objects

Description (p. 9)

Description of the license configuration.

Type: String

LicenseConfigurationArn (p. 9)

Amazon Resource Name (ARN) of the license configuration.

Type: String

LicenseConfigurationId (p. 9)

Unique ID for the license configuration.

Type: String

LicenseCount (p. 9)

Number of available licenses.

Type: Long

API Version 2018-08-0110

Page 16: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceErrors

LicenseCountHardLimit (p. 9)

Sets the number of available licenses as a hard limit.

Type: BooleanLicenseCountingType (p. 9)

Dimension on which the licenses are counted.

Type: String

Valid Values: vCPU | Instance | Core | SocketLicenseRules (p. 9)

License rules.

Type: Array of stringsManagedResourceSummaryList (p. 9)

Summaries of the managed resources.

Type: Array of ManagedResourceSummary (p. 62) objectsName (p. 9)

Name of the license configuration.

Type: StringOwnerAccountId (p. 9)

Account ID of the owner of the license configuration.

Type: StringProductInformationList (p. 9)

Product information.

Type: Array of ProductInformation (p. 65) objectsStatus (p. 9)

License configuration status.

Type: StringTags (p. 9)

Tags for the license configuration.

Type: Array of Tag (p. 69) objects

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400

API Version 2018-08-0111

Page 17: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0112

Page 18: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceGetServiceSettings

GetServiceSettingsGets the License Manager settings for the current Region.

Response Syntax{ "EnableCrossAccountsDiscovery": boolean, "LicenseManagerResourceShareArn": "string", "OrganizationConfiguration": { "EnableIntegration": boolean }, "S3BucketArn": "string", "SnsTopicArn": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EnableCrossAccountsDiscovery (p. 13)

Indicates whether cross-account discovery has been enabled.

Type: Boolean

LicenseManagerResourceShareArn (p. 13)

Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account willprovide member accounts with access to this share.

Type: String

OrganizationConfiguration (p. 13)

Indicates whether AWS Organizations has been integrated with License Manager for cross-accountdiscovery.

Type: OrganizationConfiguration (p. 64) object

S3BucketArn (p. 13)

Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

Type: String

SnsTopicArn (p. 13)

SNS topic configured to receive notifications from License Manager.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

API Version 2018-08-0113

Page 19: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0114

Page 20: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListAssociationsForLicenseConfiguration

ListAssociationsForLicenseConfigurationLists the resource associations for the specified license configuration.

Resource associations need not consume licenses from a license configuration. For example, an AMI or astopped instance might not consume a license (depending on the license rules).

Request Syntax{ "LicenseConfigurationArn": "string", "MaxResults": number, "NextToken": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

LicenseConfigurationArn (p. 15)

Amazon Resource Name (ARN) of a license configuration.

Type: String

Required: YesMaxResults (p. 15)

Maximum number of results to return in a single call.

Type: Integer

Required: NoNextToken (p. 15)

Token for the next set of results.

Type: String

Required: No

Response Syntax{ "LicenseConfigurationAssociations": [ { "AssociationTime": number, "ResourceArn": "string", "ResourceOwnerId": "string", "ResourceType": "string" } ],

API Version 2018-08-0115

Page 21: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Elements

"NextToken": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LicenseConfigurationAssociations (p. 15)

Information about the associations for the license configuration.

Type: Array of LicenseConfigurationAssociation (p. 56) objects

NextToken (p. 15)

Token for the next set of results.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400

AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400

FilterLimitExceededException

The request uses too many filters or too many filter values.

HTTP Status Code: 400

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

API Version 2018-08-0116

Page 23: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListFailuresForLicenseConfigurationOperations

ListFailuresForLicenseConfigurationOperationsLists the license configuration operations that failed.

Request Syntax{ "LicenseConfigurationArn": "string", "MaxResults": number, "NextToken": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

LicenseConfigurationArn (p. 18)

Amazon Resource Name of the license configuration.

Type: String

Required: YesMaxResults (p. 18)

Maximum number of results to return in a single call.

Type: Integer

Required: NoNextToken (p. 18)

Token for the next set of results.

Type: String

Required: No

Response Syntax{ "LicenseOperationFailureList": [ { "ErrorMessage": "string", "FailureTime": number, "MetadataList": [ { "Name": "string", "Value": "string" } ], "OperationName": "string",

API Version 2018-08-0118

Page 24: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Elements

"OperationRequestedBy": "string", "ResourceArn": "string", "ResourceOwnerId": "string", "ResourceType": "string" } ], "NextToken": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LicenseOperationFailureList (p. 18)

License configuration operations that failed.

Type: Array of LicenseOperationFailure (p. 59) objects

NextToken (p. 18)

Token for the next set of results.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400

AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400

InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400

RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

API Version 2018-08-0119

Page 26: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListLicenseConfigurations

ListLicenseConfigurationsLists the license configurations for your account.

Request Syntax{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "LicenseConfigurationArns": [ "string" ], "MaxResults": number, "NextToken": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

Filters (p. 21)

Filters to scope the results. The following filters and logical operators are supported:• licenseCountingType - The dimension on which licenses are counted. Possible values are vCPU

| Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.• enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is

used. Logical operators are EQUALS | NOT_EQUALS.• usagelimitExceeded - A Boolean value that indicates whether the available licenses have been

exceeded. Logical operators are EQUALS | NOT_EQUALS.

Type: Array of Filter (p. 51) objects

Required: NoLicenseConfigurationArns (p. 21)

Amazon Resource Names (ARN) of the license configurations.

Type: Array of strings

Required: NoMaxResults (p. 21)

Maximum number of results to return in a single call.

Type: Integer

Required: NoNextToken (p. 21)

Token for the next set of results.

API Version 2018-08-0121

Page 27: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Syntax

Type: String

Required: No

Response Syntax{ "LicenseConfigurations": [ { "AutomatedDiscoveryInformation": { "LastRunTime": number }, "ConsumedLicenses": number, "ConsumedLicenseSummaryList": [ { "ConsumedLicenses": number, "ResourceType": "string" } ], "Description": "string", "LicenseConfigurationArn": "string", "LicenseConfigurationId": "string", "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseCountingType": "string", "LicenseRules": [ "string" ], "ManagedResourceSummaryList": [ { "AssociationCount": number, "ResourceType": "string" } ], "Name": "string", "OwnerAccountId": "string", "ProductInformationList": [ { "ProductInformationFilterList": [ { "ProductInformationFilterComparator": "string", "ProductInformationFilterName": "string", "ProductInformationFilterValue": [ "string" ] } ], "ResourceType": "string" } ], "Status": "string" } ], "NextToken": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LicenseConfigurations (p. 22)

Information about the license configurations.

API Version 2018-08-0122

Page 28: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceErrors

Type: Array of LicenseConfiguration (p. 53) objectsNextToken (p. 22)

Token for the next set of results.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400FilterLimitExceededException

The request uses too many filters or too many filter values.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3

API Version 2018-08-0123

Page 30: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListLicenseSpecificationsForResource

ListLicenseSpecificationsForResourceDescribes the license configurations for the specified resource.

Request Syntax{ "MaxResults": number, "NextToken": "string", "ResourceArn": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

MaxResults (p. 25)

Maximum number of results to return in a single call.

Type: Integer

Required: NoNextToken (p. 25)

Token for the next set of results.

Type: String

Required: NoResourceArn (p. 25)

Amazon Resource Name (ARN) of a resource that has an associated license configuration.

Type: String

Required: Yes

Response Syntax{ "LicenseSpecifications": [ { "LicenseConfigurationArn": "string" } ], "NextToken": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

API Version 2018-08-0125

Page 31: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceErrors

The following data is returned in JSON format by the service.

LicenseSpecifications (p. 25)

License configurations associated with a resource.

Type: Array of LicenseSpecification (p. 61) objectsNextToken (p. 25)

Token for the next set of results.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3

API Version 2018-08-0126

Page 33: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListResourceInventory

ListResourceInventoryLists resources managed using Systems Manager inventory.

Request Syntax{ "Filters": [ { "Condition": "string", "Name": "string", "Value": "string" } ], "MaxResults": number, "NextToken": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

Filters (p. 28)

Filters to scope the results. The following filters and logical operators are supported:• account_id - The ID of the AWS account that owns the resource. Logical operators are EQUALS |NOT_EQUALS.

• application_name - The name of the application. Logical operators are EQUALS |BEGINS_WITH.

• license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS.Possible values are sql-server-enterprise | sql-server-standard | sql-server-web |windows-server-datacenter.

• platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.• resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.

Type: Array of InventoryFilter (p. 52) objects

Required: NoMaxResults (p. 28)

Maximum number of results to return in a single call.

Type: Integer

Required: NoNextToken (p. 28)

Token for the next set of results.

Type: String

Required: No

API Version 2018-08-0128

Page 34: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Syntax

Response Syntax{ "NextToken": "string", "ResourceInventoryList": [ { "Platform": "string", "PlatformVersion": "string", "ResourceArn": "string", "ResourceId": "string", "ResourceOwningAccountId": "string", "ResourceType": "string" } ]}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 29)

Token for the next set of results.

Type: StringResourceInventoryList (p. 29)

Information about the resources.

Type: Array of ResourceInventory (p. 67) objects

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400FailedDependencyException

A dependency required to run the API is missing.

HTTP Status Code: 400FilterLimitExceededException

The request uses too many filters or too many filter values.

API Version 2018-08-0129

Page 35: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0130

Page 36: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListTagsForResource

ListTagsForResourceLists the tags for the specified license configuration.

Request Syntax{ "ResourceArn": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

ResourceArn (p. 31)

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: Yes

Response Syntax{ "Tags": [ { "Key": "string", "Value": "string" } ]}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 31)

Information about the tags.

Type: Array of Tag (p. 69) objects

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

API Version 2018-08-0131

Page 37: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0132

Page 38: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceListUsageForLicenseConfiguration

ListUsageForLicenseConfigurationLists all license usage records for a license configuration, displaying license consumption details byresource at a selected point in time. Use this action to audit the current license consumption for anylicense inventory and configuration.

Request Syntax{ "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "LicenseConfigurationArn": "string", "MaxResults": number, "NextToken": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

Filters (p. 33)

Filters to scope the results. The following filters and logical operators are supported:• resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS |NOT_EQUALS.

• resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI |SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.

• resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS| NOT_EQUALS.

Type: Array of Filter (p. 51) objects

Required: NoLicenseConfigurationArn (p. 33)

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: YesMaxResults (p. 33)

Maximum number of results to return in a single call.

Type: Integer

Required: NoNextToken (p. 33)

Token for the next set of results.

API Version 2018-08-0133

Page 39: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Syntax

Type: String

Required: No

Response Syntax{ "LicenseConfigurationUsageList": [ { "AssociationTime": number, "ConsumedLicenses": number, "ResourceArn": "string", "ResourceOwnerId": "string", "ResourceStatus": "string", "ResourceType": "string" } ], "NextToken": "string"}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LicenseConfigurationUsageList (p. 34)

Information about the license configurations.

Type: Array of LicenseConfigurationUsage (p. 57) objectsNextToken (p. 34)

Token for the next set of results.

Type: String

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400FilterLimitExceededException

The request uses too many filters or too many filter values.

API Version 2018-08-0134

Page 40: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0135

Page 41: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceTagResource

TagResourceAdds the specified tags to the specified license configuration.

Request Syntax{ "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

ResourceArn (p. 36)

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: YesTags (p. 36)

One or more tags.

Type: Array of Tag (p. 69) objects

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

API Version 2018-08-0136

Page 42: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0137

Page 43: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceUntagResource

UntagResourceRemoves the specified tags from the specified license configuration.

Request Syntax{ "ResourceArn": "string", "TagKeys": [ "string" ]}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

ResourceArn (p. 38)

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: YesTagKeys (p. 38)

Keys identifying the tags to remove.

Type: Array of strings

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

API Version 2018-08-0138

Page 44: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0139

Page 45: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceUpdateLicenseConfiguration

UpdateLicenseConfigurationModifies the attributes of an existing license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed andenforced by License Manager. Components include specifications for the license type (licensing byinstance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host,or all of these), host affinity (how long a VM must be associated with a host), and the number of licensespurchased and used.

Request Syntax{ "Description": "string", "LicenseConfigurationArn": "string", "LicenseConfigurationStatus": "string", "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseRules": [ "string" ], "Name": "string", "ProductInformationList": [ { "ProductInformationFilterList": [ { "ProductInformationFilterComparator": "string", "ProductInformationFilterName": "string", "ProductInformationFilterValue": [ "string" ] } ], "ResourceType": "string" } ]}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

Description (p. 40)

New description of the license configuration.

Type: String

Required: NoLicenseConfigurationArn (p. 40)

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: YesLicenseConfigurationStatus (p. 40)

New status of the license configuration.

API Version 2018-08-0140

Page 46: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResponse Elements

Type: String

Valid Values: AVAILABLE | DISABLED

Required: NoLicenseCount (p. 40)

New number of licenses managed by the license configuration.

Type: Long

Required: NoLicenseCountHardLimit (p. 40)

New hard limit of the number of available licenses.

Type: Boolean

Required: NoLicenseRules (p. 40)

New license rules.

Type: Array of strings

Required: NoName (p. 40)

New name of the license configuration.

Type: String

Required: NoProductInformationList (p. 40)

New product information.

Type: Array of ProductInformation (p. 65) objects

Required: No

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

API Version 2018-08-0141

Page 47: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0142

Page 48: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceUpdateLicenseSpecificationsForResource

UpdateLicenseSpecificationsForResourceAdds or removes the specified license configurations for the specified AWS resource.

You can update the license specifications of AMIs, instances, and hosts. You cannot update thelicense specifications for launch templates and AWS CloudFormation templates, as they send licenseconfigurations to the operation that creates the resource.

Request Syntax{ "AddLicenseSpecifications": [ { "LicenseConfigurationArn": "string" } ], "RemoveLicenseSpecifications": [ { "LicenseConfigurationArn": "string" } ], "ResourceArn": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

AddLicenseSpecifications (p. 43)

ARNs of the license configurations to add.

Type: Array of LicenseSpecification (p. 61) objects

Required: NoRemoveLicenseSpecifications (p. 43)

ARNs of the license configurations to remove.

Type: Array of LicenseSpecification (p. 61) objects

Required: NoResourceArn (p. 43)

Amazon Resource Name (ARN) of the AWS resource.

Type: String

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

API Version 2018-08-0143

Page 49: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceErrors

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400InvalidResourceStateException

License Manager cannot allocate a license to a resource because of its state.

For example, you cannot allocate a license to an instance in the process of shutting down.

HTTP Status Code: 400LicenseUsageException

You do not have enough licenses available to support a new resource launch.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python

API Version 2018-08-0144

Page 50: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

• AWS SDK for Ruby V3

API Version 2018-08-0145

Page 51: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceUpdateServiceSettings

UpdateServiceSettingsUpdates License Manager settings for the current Region.

Request Syntax{ "EnableCrossAccountsDiscovery": boolean, "OrganizationConfiguration": { "EnableIntegration": boolean }, "S3BucketArn": "string", "SnsTopicArn": "string"}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 70).

The request accepts the following data in JSON format.

EnableCrossAccountsDiscovery (p. 46)

Activates cross-account discovery.

Type: Boolean

Required: NoOrganizationConfiguration (p. 46)

Enables integration with AWS Organizations for cross-account discovery.

Type: OrganizationConfiguration (p. 64) object

Required: NoS3BucketArn (p. 46)

Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information isstored.

Type: String

Required: NoSnsTopicArn (p. 46)

Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

Type: String

Required: No

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

API Version 2018-08-0146

Page 52: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceErrors

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 72).

AccessDeniedException

Access to resource denied.

HTTP Status Code: 400AuthorizationException

The AWS user account does not have permission to perform the action. Check the IAM policyassociated with this account.

HTTP Status Code: 400InvalidParameterValueException

One or more parameter values are not valid.

HTTP Status Code: 400RateLimitExceededException

Too many requests have been submitted. Try again after a brief wait.

HTTP Status Code: 400ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2018-08-0147

Page 53: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

Data TypesThe AWS License Manager API contains several data types that various actions use. This section describeseach data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• AutomatedDiscoveryInformation (p. 49)• ConsumedLicenseSummary (p. 50)• Filter (p. 51)• InventoryFilter (p. 52)• LicenseConfiguration (p. 53)• LicenseConfigurationAssociation (p. 56)• LicenseConfigurationUsage (p. 57)• LicenseOperationFailure (p. 59)• LicenseSpecification (p. 61)• ManagedResourceSummary (p. 62)• Metadata (p. 63)• OrganizationConfiguration (p. 64)• ProductInformation (p. 65)• ProductInformationFilter (p. 66)• ResourceInventory (p. 67)• Tag (p. 69)

API Version 2018-08-0148

Page 54: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceAutomatedDiscoveryInformation

AutomatedDiscoveryInformationDescribes automated discovery.

ContentsLastRunTime

Time that automated discovery last ran.

Type: Timestamp

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0149

Page 55: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceConsumedLicenseSummary

ConsumedLicenseSummaryDetails about license consumption.

ContentsConsumedLicenses

Number of licenses consumed by the resource.

Type: Long

Required: NoResourceType

Resource type of the resource consuming a license.

Type: String

Valid Values: EC2_INSTANCE | EC2_HOST | EC2_AMI | RDS |SYSTEMS_MANAGER_MANAGED_INSTANCE

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0150

Page 56: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceFilter

FilterA filter name and value pair that is used to return more specific results from a describe operation. Filterscan be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

ContentsName

Name of the filter. Filter names are case-sensitive.

Type: String

Required: NoValues

Filter values. Filter values are case-sensitive.

Type: Array of strings

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0151

Page 57: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceInventoryFilter

InventoryFilterAn inventory filter.

ContentsCondition

Condition of the filter.

Type: String

Valid Values: EQUALS | NOT_EQUALS | BEGINS_WITH | CONTAINS

Required: YesName

Name of the filter.

Type: String

Required: YesValue

Value of the filter.

Type: String

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0152

Page 58: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceLicenseConfiguration

LicenseConfigurationA license configuration is an abstraction of a customer license agreement that can be consumed andenforced by License Manager. Components include specifications for the license type (licensing byinstance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host,or all of these), host affinity (how long a VM must be associated with a host), and the number of licensespurchased and used.

ContentsAutomatedDiscoveryInformation

Automated discovery information.

Type: AutomatedDiscoveryInformation (p. 49) object

Required: NoConsumedLicenses

Number of licenses consumed.

Type: Long

Required: NoConsumedLicenseSummaryList

Summaries for licenses consumed by various resources.

Type: Array of ConsumedLicenseSummary (p. 50) objects

Required: NoDescription

Description of the license configuration.

Type: String

Required: NoLicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: NoLicenseConfigurationId

Unique ID of the license configuration.

Type: String

Required: NoLicenseCount

Number of licenses managed by the license configuration.

Type: Long

API Version 2018-08-0153

Page 59: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceContents

Required: NoLicenseCountHardLimit

Number of available licenses as a hard limit.

Type: Boolean

Required: NoLicenseCountingType

Dimension to use to track the license inventory.

Type: String

Valid Values: vCPU | Instance | Core | Socket

Required: NoLicenseRules

License rules.

Type: Array of strings

Required: NoManagedResourceSummaryList

Summaries for managed resources.

Type: Array of ManagedResourceSummary (p. 62) objects

Required: NoName

Name of the license configuration.

Type: String

Required: NoOwnerAccountId

Account ID of the license configuration's owner.

Type: String

Required: NoProductInformationList

Product information.

Type: Array of ProductInformation (p. 65) objects

Required: NoStatus

Status of the license configuration.

Type: String

Required: No

API Version 2018-08-0154

Page 60: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0155

Page 61: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceLicenseConfigurationAssociation

LicenseConfigurationAssociationDescribes an association with a license configuration.

ContentsAssociationTime

Time when the license configuration was associated with the resource.

Type: Timestamp

Required: NoResourceArn

Amazon Resource Name (ARN) of the resource.

Type: String

Required: NoResourceOwnerId

ID of the AWS account that owns the resource consuming licenses.

Type: String

Required: NoResourceType

Type of server resource.

Type: String

Valid Values: EC2_INSTANCE | EC2_HOST | EC2_AMI | RDS |SYSTEMS_MANAGER_MANAGED_INSTANCE

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0156

Page 62: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceLicenseConfigurationUsage

LicenseConfigurationUsageDetails about the usage of a resource associated with a license configuration.

ContentsAssociationTime

Time when the license configuration was initially associated with the resource.

Type: Timestamp

Required: NoConsumedLicenses

Number of licenses consumed by the resource.

Type: Long

Required: NoResourceArn

Amazon Resource Name (ARN) of the resource.

Type: String

Required: NoResourceOwnerId

ID of the account that owns the resource.

Type: String

Required: NoResourceStatus

Status of the resource.

Type: String

Required: NoResourceType

Type of resource.

Type: String

Valid Values: EC2_INSTANCE | EC2_HOST | EC2_AMI | RDS |SYSTEMS_MANAGER_MANAGED_INSTANCE

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

API Version 2018-08-0157

Page 64: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceLicenseOperationFailure

LicenseOperationFailureDescribes the failure of a license operation.

ContentsErrorMessage

Error message.

Type: String

Required: NoFailureTime

Failure time.

Type: Timestamp

Required: NoMetadataList

Reserved.

Type: Array of Metadata (p. 63) objects

Required: NoOperationName

Name of the operation.

Type: String

Required: NoOperationRequestedBy

The requester is "License Manager Automated Discovery".

Type: String

Required: NoResourceArn

Amazon Resource Name (ARN) of the resource.

Type: String

Required: NoResourceOwnerId

ID of the AWS account that owns the resource.

Type: String

Required: NoResourceType

Resource type.

API Version 2018-08-0159

Page 65: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceSee Also

Type: String

Valid Values: EC2_INSTANCE | EC2_HOST | EC2_AMI | RDS |SYSTEMS_MANAGER_MANAGED_INSTANCE

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0160

Page 66: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceLicenseSpecification

LicenseSpecificationDetails for associating a license configuration with a resource.

ContentsLicenseConfigurationArn

Amazon Resource Name (ARN) of the license configuration.

Type: String

Required: Yes

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0161

Page 67: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceManagedResourceSummary

ManagedResourceSummarySummary information about a managed resource.

ContentsAssociationCount

Number of resources associated with licenses.

Type: Long

Required: NoResourceType

Type of resource associated with a license.

Type: String

Valid Values: EC2_INSTANCE | EC2_HOST | EC2_AMI | RDS |SYSTEMS_MANAGER_MANAGED_INSTANCE

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0162

Page 68: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceMetadata

MetadataReserved.

ContentsName

Reserved.

Type: String

Required: NoValue

Reserved.

Type: String

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0163

Page 69: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceOrganizationConfiguration

OrganizationConfigurationConfiguration information for AWS Organizations.

ContentsEnableIntegration

Enables AWS Organization integration.

Type: Boolean

Required: Yes

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0164

Page 70: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceProductInformation

ProductInformationDescribes product information for a license configuration.

ContentsProductInformationFilterList

Product information filters.

The following filters and logical operators are supported when the resource type is SSM_MANAGED:• Application Name - The name of the application. Logical operator is EQUALS.• Application Publisher - The publisher of the application. Logical operator is EQUALS.• Application Version - The version of the application. Logical operator is EQUALS.• Platform Name - The name of the platform. Logical operator is EQUALS.• Platform Type - The platform type. Logical operator is EQUALS.• License Included - The type of license included. Logical operators are EQUALS andNOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

The following filters and logical operators are supported when the resource type is RDS:• Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible

values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.• License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard |diagnostic pack sqlt | tuning pack sqlt | ols | olap.

Type: Array of ProductInformationFilter (p. 66) objects

Required: YesResourceType

Resource type. The possible values are SSM_MANAGED | RDS.

Type: String

Required: Yes

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0165

Page 71: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceProductInformationFilter

ProductInformationFilterDescribes product information filters.

ContentsProductInformationFilterComparator

Logical operator.

Type: String

Required: YesProductInformationFilterName

Filter name.

Type: String

Required: YesProductInformationFilterValue

Filter value.

Type: Array of strings

Required: Yes

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0166

Page 72: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceResourceInventory

ResourceInventoryDetails about a resource.

ContentsPlatform

Platform of the resource.

Type: String

Required: NoPlatformVersion

Platform version of the resource in the inventory.

Type: String

Required: NoResourceArn

Amazon Resource Name (ARN) of the resource.

Type: String

Required: NoResourceId

ID of the resource.

Type: String

Required: NoResourceOwningAccountId

ID of the account that owns the resource.

Type: String

Required: NoResourceType

Type of resource.

Type: String

Valid Values: EC2_INSTANCE | EC2_HOST | EC2_AMI | RDS |SYSTEMS_MANAGER_MANAGED_INSTANCE

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++

API Version 2018-08-0167

Page 74: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API ReferenceTag

TagDetails about a tag for a license configuration.

ContentsKey

Tag key.

Type: String

Required: NoValue

Tag value.

Type: String

Required: No

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3

API Version 2018-08-0169

Page 75: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is

API Version 2018-08-0170

Page 76: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2018-08-0171

Page 77: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.

HTTP Status Code: 400

API Version 2018-08-0172

Page 78: AWS License Manager · AWS License Manager API Reference CreateLicenseConfiguration CreateLicenseConfiguration Creates a license configuration. A license configuration is an abstraction

AWS License Manager API Reference

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

API Version 2018-08-0173