You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MarketplaceEntitlementService::Types::Entitlement

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#customer_identifier ⇒ String

The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

Returns:

  • (String) —

    The customer identifier is a handle to each unique customer in an application.

#dimension ⇒ String

The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

Returns:

  • (String) —

    The dimension for which the given entitlement applies.

#expiration_date ⇒ Time

The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

Returns:

  • (Time) —

    The expiration date represents the minimum date through which this entitlement is expected to remain valid.

#product_code ⇒ String

The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

Returns:

  • (String) —

    The product code for which the given entitlement applies.

#value ⇒ Types::EntitlementValue

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

Returns:

  • (Types::EntitlementValue) —

    The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.