AWS License Manager
API Reference (API Version 2018-08-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreateLicenseConfiguration

Creates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, 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 licenses purchased and used.

Request Syntax

{ "Description": "string", "LicenseCount": number, "LicenseCountHardLimit": boolean, "LicenseCountingType": "string", "LicenseRules": [ "string" ], "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

Description of the license configuration.

Type: String

Required: No

LicenseCount

Number of licenses managed by the license configuration.

Type: Long

Required: No

LicenseCountHardLimit

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

Type: Boolean

Required: No

LicenseCountingType

Dimension used to track the license inventory.

Type: String

Valid Values: vCPU | Instance | Core | Socket

Required: Yes

LicenseRules

License Manager rules. Available rules vary by dimension.

Rules for the Cores dimension:

  • minimumCores

  • maximumCores

  • allowedTenancy

Rules for the Sockets dimension:

  • minimumSockets

  • maximumSockets

  • allowedTenancy

Rules for the Instances dimension:

  • minimumVcpus

  • maximumVcpus

  • minimumCores

  • maximumCores

  • minimumSockets

  • maximumSockets

  • allowedTenancy

Rules for the vCPUs dimension:

  • minimumVcpus

  • maximumVcpus

  • allowedTenancy

  • honorVcpuOptimization

Type: Array of strings

Required: No

Name

Name of the license configuration.

Type: String

Required: Yes

Tags

Tags to add to the resources during launch. You can only add tags to instances and volumes during launch. The specified tags are added to all instances or volumes that are created during launch. To tag a resource after it has been created, see TagResource.

Type: Array of Tag objects

Required: No

Response Syntax

{ "LicenseConfigurationArn": "string" }

Response Elements

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

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

LicenseConfigurationArn

ARN of the license configuration.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

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 policy associated 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

ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

See Also

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