Skip to content

Creates a grant for the specified license

Description

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

Usage

licensemanager_create_grant(ClientToken, GrantName, LicenseArn,
  Principals, HomeRegion, AllowedOperations, Tags)

Arguments

  • ClientToken

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

  • GrantName

    [required] Grant name.

  • LicenseArn

    [required] Amazon Resource Name (ARN) of the license.

  • Principals

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

    • An Amazon Web Services 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.

  • HomeRegion

    [required] Home Region of the grant.

  • AllowedOperations

    [required] Allowed operations for the grant.

  • Tags

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

Value

A list with the following syntax:

list(
  GrantArn = "string",
  Status = "PENDING_WORKFLOW"|"PENDING_ACCEPT"|"REJECTED"|"ACTIVE"|"FAILED_WORKFLOW"|"DELETED"|"PENDING_DELETE"|"DISABLED"|"WORKFLOW_COMPLETED",
  Version = "string"
)

Request syntax

svc$create_grant(
  ClientToken = "string",
  GrantName = "string",
  LicenseArn = "string",
  Principals = list(
    "string"
  ),
  HomeRegion = "string",
  AllowedOperations = list(
    "CreateGrant"|"CheckoutLicense"|"CheckoutBorrowLicense"|"CheckInLicense"|"ExtendConsumptionLicense"|"ListPurchasedLicenses"|"CreateToken"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)