Request Syntax Request Parameters Response Syntax Response Elements Errors See 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.

Set the type of grant with the GrantType field:

BuyerGrant - The default grant type, created by the seller when a customer subscribes to a product. The seller creates a license for the subscription and a buyer grant for the customer. With a buyer grant, the customer can use, consume, and distribute the license, according to the permissions the seller sets in the product contract.
DelegateGrant - A delegate grant gives the grantee read-only visibility into the licenses and grants that you have distributed to buyers for a product. The grantee can monitor that activity on your behalf, and can also listen for the related Amazon EventBridge events. A delegate grant conveys no entitlement to use the licenses, and its only allowed operation is ListReceivedLicenses. You must create the delegate grant, and its license, from the same AWS account that you used to create those buyer licenses and grants.

Request Syntax


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

AllowedOperations

Allowed operations for the grant.

Type: Array of strings

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

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

GrantType

The type of grant to create. For more information about each type, see the preceding description of this operation. Valid values:

BuyerGrant - The default grant type if you don't specify a value. Conveys the entitlement to use the license.
DelegateGrant - Gives the grantee read-only visibility into the licenses and grants that you have distributed to buyers, with no entitlement to use them.

Type: String

Valid Values: BuyerGrant | DelegateGrant

Required: No

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[a-zA-Z-]*:[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

Options

The options for the grant: the status to set after creation, and how activating the grant affects other active grants for the same product.

Type: Options object

Required: No

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[a-zA-Z-]*:[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

Tags

Tags to add to the grant. For more information about tagging support in License Manager, see the TagResource operation.

Type: Array of Tag objects

Required: No

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[a-zA-Z-]*:[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

Version

Grant version.

Type: String

Errors

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

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