View a markdown version of this page

Grant - Amazon License Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Grant

Describes a grant.

Contents

GrantArn

Amazon Resource Name (ARN) of the grant.

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

GrantedOperations

Granted operations.

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 | ListReceivedLicenses

Required: Yes

GranteePrincipalArn

The grantee principal 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}$

Required: Yes

GrantName

Grant name.

Type: String

Required: Yes

GrantStatus

Grant status.

Type: String

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

Required: Yes

HomeRegion

Home Region of the grant.

Type: String

Required: Yes

LicenseArn

License 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}$

Required: Yes

ParentArn

Parent 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}$

Required: Yes

Version

Grant version.

Type: String

Required: Yes

GrantType

The type of the grant. Valid values:

  • BuyerGrant - Grants the entitlement to use the license.

  • DelegateGrant - Gives the grantee read-only visibility into the licenses and grants distributed to buyers, with no entitlement to use them.

Type: String

Valid Values: BuyerGrant | DelegateGrant

Required: No

Options

The options specified for the grant.

Type: Options object

Required: No

StatusReason

Grant status reason.

Type: String

Length Constraints: Maximum length of 400.

Pattern: [\s\S]+

Required: No

See Also

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