Get Entitlements

marketplaceentitlementservice_get_entitlements

R Documentation

GetEntitlements retrieves entitlement values for a given product¶

Description¶

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier, AWS account ID, license ARN, or product dimensions.

Usage¶

marketplaceentitlementservice_get_entitlements(ProductCode, Filter,
  NextToken, MaxResults)

Arguments¶

ProductCode

[required] Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

Filter

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

CustomerIdentifier and CustomerAWSAccountId are mutually exclusive parameters. You must use one or the other, but not both in the same request.

If you're migrating an existing integration, use Account Feeds to map CustomerIdentifier to CustomerAWSAccountId, and Agreements Feeds to map CustomerAWSAccountId and LicenseArn.

NextToken

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

MaxResults

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

Value¶

A list with the following syntax:

list(
  Entitlements = list(
    list(
      ProductCode = "string",
      Dimension = "string",
      CustomerIdentifier = "string",
      CustomerAWSAccountId = "string",
      Value = list(
        IntegerValue = 123,
        DoubleValue = 123.0,
        BooleanValue = TRUE|FALSE,
        StringValue = "string"
      ),
      ExpirationDate = as.POSIXct(
        "2015-01-01"
      ),
      LicenseArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_entitlements(
  ProductCode = "string",
  Filter = list(
    list(
      "string"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)