CreateGrant - AWS License Manager
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

CreateGrant

Creates a grant for the specified license. A grant shares the use of license entitlements with a specific AWS account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the AWS License Manager User Guide.

Request Syntax

{
   "AllowedOperations": [ "string" ],
   "ClientToken": "string",
   "GrantName": "string",
   "HomeRegion": "string",
   "LicenseArn": "string",
   "Principals": [ "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.

AllowedOperations

Allowed operations for the grant.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 8 items.

Valid Values: CreateGrant | CheckoutLicense | CheckoutBorrowLicense | CheckInLicense | ExtendConsumptionLicense | ListPurchasedLicenses | CreateToken | BatchCreateLicenseUsageRecords

Required: Yes

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

GrantName

Grant name.

Type: String

Required: Yes

HomeRegion

Home Region of the grant.

Type: String

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

Principals

The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):

  • An AWS account, which includes only the account specified.

  • An organizational unit (OU), which includes all accounts in the OU.

  • An organization, which will include all accounts across your organization.

Type: Array of strings

Array Members: Fixed number of 1 item.

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

Response Syntax

{
   "GrantArn": "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.

GrantArn

Grant 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

Grant status.

Type: String

Valid Values: PENDING_WORKFLOW | PENDING_ACCEPT | REJECTED | ACTIVE | FAILED_WORKFLOW | DELETED | PENDING_DELETE | DISABLED | WORKFLOW_COMPLETED

Version

Grant version.

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

ValidationException

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

HTTP Status Code: 400

See Also

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