AWS.LicenseManagerUserSubscriptions — 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:

licensemanagerusersubscriptions

API Version:

2018-05-10

Defined in:

(unknown)

Overview

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

Service Description

With License Manager, you can create user-based subscriptions to utilize licensed software with a per user subscription fee on Amazon EC2 instances.

Sending a Request Using LicenseManagerUserSubscriptions

var licensemanagerusersubscriptions = new AWS.LicenseManagerUserSubscriptions();
licensemanagerusersubscriptions.associateUser(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 LicenseManagerUserSubscriptions object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var licensemanagerusersubscriptions = new AWS.LicenseManagerUserSubscriptions({apiVersion: '2018-05-10'});

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

AWS.config.apiVersions = {
  licensemanagerusersubscriptions: '2018-05-10',
  // other service API versions
};

var licensemanagerusersubscriptions = new AWS.LicenseManagerUserSubscriptions();

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.LicenseManagerUserSubscriptions(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

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

Associates the user to an EC2 instance to utilize user-based subscriptions.

Note: Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

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

Deregisters the identity provider from providing user-based subscriptions.

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

Disassociates the user from an EC2 instance providing user-based subscriptions.

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

Lists the identity providers for user-based subscriptions.

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

Lists the EC2 instances providing user-based subscriptions.

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

Lists the user-based subscription products available from an identity provider.

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

Lists user associations for an identity provider.

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

Registers an identity provider for user-based subscriptions.

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

Starts a product subscription for a user with the specified identity provider.

Note: Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as Pending billing status) in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.

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

Stops a product subscription for a user with the specified identity provider.

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

Updates additional product configuration settings for the registered identity provider.