Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateLicenseVersion

Creates a new version of the specified license.

Request Syntax


{
   "ClientToken": "string",
   "ConsumptionConfiguration": { 
      "BorrowConfiguration": { 
         "AllowEarlyCheckIn": boolean,
         "MaxTimeToLiveInMinutes": number
      },
      "ProvisionalConfiguration": { 
         "MaxTimeToLiveInMinutes": number
      },
      "RenewType": "string"
   },
   "Entitlements": [ 
      { 
         "AllowCheckIn": boolean,
         "MaxCount": number,
         "Name": "string",
         "Overage": boolean,
         "Unit": "string",
         "Value": "string"
      }
   ],
   "HomeRegion": "string",
   "Issuer": { 
      "Name": "string",
      "SignKey": "string"
   },
   "LicenseArn": "string",
   "LicenseMetadata": [ 
      { 
         "Name": "string",
         "Value": "string"
      }
   ],
   "LicenseName": "string",
   "ProductName": "string",
   "SourceVersion": "string",
   "Status": "string",
   "Validity": { 
      "Begin": "string",
      "End": "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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: Yes

ConsumptionConfiguration

Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

Type: ConsumptionConfiguration object

Required: Yes

Entitlements

License entitlements.

Type: Array of Entitlement objects

Required: Yes

HomeRegion

Home Region of the license.

Type: String

Required: Yes

Issuer

License issuer.

Type: Issuer object

Required: Yes

LicenseArn

Amazon Resource Name (ARN) of the license.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

LicenseMetadata

Information about the license.

Type: Array of Metadata objects

Required: No

LicenseName

License name.

Type: String

Required: Yes

ProductName

Product name.

Type: String

Required: Yes

SourceVersion

Current version of the license.

Type: String

Required: No

Status

License status.

Type: String

Required: Yes

Validity

Date and time range during which the license is valid, in ISO8601-UTC format.

Type: DatetimeRange object

Required: Yes

Response Syntax


{
   "LicenseArn": "string",
   "Status": "string",
   "Version": "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.

LicenseArn

License ARN.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^arn:aws(-(cn|us-gov|iso-b|iso-c|iso-d))?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Status

License status.

Type: String

Version

New version of the license.

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 Amazon user account does not have permission to perform the action. Check the IAM policy associated with this account.

HTTP Status Code: 400

ConflictException

There was a conflict processing the request. Try your request again.

HTTP Status Code: 400

RateLimitExceededException

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

HTTP Status Code: 400

RedirectException

This is not the correct Region for the resource. Try again.

HTTP Status Code: 400

ResourceNotFoundException

The resource cannot be found.

HTTP Status Code: 400

ServerInternalException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ValidationException

The provided input is not valid. Try your request again.

HTTP Status Code: 400