AWS.MarketplaceEntitlementService — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

marketplaceentitlementservice

API Version:

2017-01-11

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This reference provides descriptions of the AWS Marketplace Entitlement Service API.

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. 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.

Getting Entitlement Records

Sending a Request Using MarketplaceEntitlementService

var marketplaceentitlementservice = new AWS.MarketplaceEntitlementService();
marketplaceentitlementservice.getEntitlements(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MarketplaceEntitlementService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var marketplaceentitlementservice = new AWS.MarketplaceEntitlementService({apiVersion: '2017-01-11'});

You can also set the API version globally in AWS.config.apiVersions using the marketplaceentitlementservice service identifier:

AWS.config.apiVersions = {
  marketplaceentitlementservice: '2017-01-11',
  // other service API versions
};

var marketplaceentitlementservice = new AWS.MarketplaceEntitlementService();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MarketplaceEntitlementService(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

getEntitlements(params = {}, callback) ⇒ AWS.Request

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.