You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.LicenseManager

Inherits:
AWS.Service show all
Identifier:
licensemanager
API Version:
2018-08-01
Defined in:
(unknown)

Overview

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

Service Description

License Manager makes it easier to manage licenses from software vendors across multiple Amazon Web Services accounts and on-premises servers.

Sending a Request Using LicenseManager

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

var licensemanager = new AWS.LicenseManager({apiVersion: '2018-08-01'});

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

AWS.config.apiVersions = {
  licensemanager: '2018-08-01',
  // other service API versions
};

var licensemanager = new AWS.LicenseManager();

Version:

  • 2018-08-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a LicenseManager object

var licensemanager = new AWS.LicenseManager({apiVersion: '2018-08-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.LicenseManager.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.LicenseManager.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.LicenseManager.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Accepts the specified grant.

Service Reference:

Examples:

Calling the acceptGrant operation

var params = {
  GrantArn: 'STRING_VALUE' /* required */
};
licensemanager.acceptGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GrantArn — (String)

      Amazon Resource Name (ARN) of the grant.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GrantArn — (String)

        Grant ARN.

      • Status — (String)

        Grant status.

        Possible values include:
        • "PENDING_WORKFLOW"
        • "PENDING_ACCEPT"
        • "REJECTED"
        • "ACTIVE"
        • "FAILED_WORKFLOW"
        • "DELETED"
        • "PENDING_DELETE"
        • "DISABLED"
        • "WORKFLOW_COMPLETED"
      • Version — (String)

        Grant version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Checks in the specified license. Check in a license when it is no longer in use.

Service Reference:

Examples:

Calling the checkInLicense operation

var params = {
  LicenseConsumptionToken: 'STRING_VALUE', /* required */
  Beneficiary: 'STRING_VALUE'
};
licensemanager.checkInLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConsumptionToken — (String)

      License consumption token.

    • Beneficiary — (String)

      License beneficiary.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Checks out the specified license for offline use.

Service Reference:

Examples:

Calling the checkoutBorrowLicense operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DigitalSignatureMethod: JWT_PS384, /* required */
  Entitlements: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Unit: Count | None | Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second, /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  LicenseArn: 'STRING_VALUE', /* required */
  CheckoutMetadata: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  NodeId: 'STRING_VALUE'
};
licensemanager.checkoutBorrowLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.

    • Entitlements — (Array<map>)

      License entitlements. Partial checkouts are not supported.

      • Name — required — (String)

        Entitlement data name.

      • Value — (String)

        Entitlement data value.

      • Unit — required — (String)

        Entitlement data unit.

        Possible values include:
        • "Count"
        • "None"
        • "Seconds"
        • "Microseconds"
        • "Milliseconds"
        • "Bytes"
        • "Kilobytes"
        • "Megabytes"
        • "Gigabytes"
        • "Terabytes"
        • "Bits"
        • "Kilobits"
        • "Megabits"
        • "Gigabits"
        • "Terabits"
        • "Percent"
        • "Bytes/Second"
        • "Kilobytes/Second"
        • "Megabytes/Second"
        • "Gigabytes/Second"
        • "Terabytes/Second"
        • "Bits/Second"
        • "Kilobits/Second"
        • "Megabits/Second"
        • "Gigabits/Second"
        • "Terabits/Second"
        • "Count/Second"
    • DigitalSignatureMethod — (String)

      Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.

      Possible values include:
      • "JWT_PS384"
    • NodeId — (String)

      Node ID.

    • CheckoutMetadata — (Array<map>)

      Information about constraints.

      • Name — (String)

        The key name.

      • Value — (String)

        The value.

    • ClientToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseArn — (String)

        Amazon Resource Name (ARN) of the license.

      • LicenseConsumptionToken — (String)

        License consumption token.

      • EntitlementsAllowed — (Array<map>)

        Allowed license entitlements.

        • Name — required — (String)

          Entitlement data name.

        • Value — (String)

          Entitlement data value.

        • Unit — required — (String)

          Entitlement data unit.

          Possible values include:
          • "Count"
          • "None"
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
      • NodeId — (String)

        Node ID.

      • SignedToken — (String)

        Signed token.

      • IssuedAt — (String)

        Date and time at which the license checkout is issued.

      • Expiration — (String)

        Date and time at which the license checkout expires.

      • CheckoutMetadata — (Array<map>)

        Information about constraints.

        • Name — (String)

          The key name.

        • Value — (String)

          The value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Checks out the specified license.

Service Reference:

Examples:

Calling the checkoutLicense operation

var params = {
  CheckoutType: PROVISIONAL | PERPETUAL, /* required */
  ClientToken: 'STRING_VALUE', /* required */
  Entitlements: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Unit: Count | None | Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second, /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  KeyFingerprint: 'STRING_VALUE', /* required */
  ProductSKU: 'STRING_VALUE', /* required */
  Beneficiary: 'STRING_VALUE',
  NodeId: 'STRING_VALUE'
};
licensemanager.checkoutLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProductSKU — (String)

      Product SKU.

    • CheckoutType — (String)

      Checkout type.

      Possible values include:
      • "PROVISIONAL"
      • "PERPETUAL"
    • KeyFingerprint — (String)

      Key fingerprint identifying the license.

    • Entitlements — (Array<map>)

      License entitlements.

      • Name — required — (String)

        Entitlement data name.

      • Value — (String)

        Entitlement data value.

      • Unit — required — (String)

        Entitlement data unit.

        Possible values include:
        • "Count"
        • "None"
        • "Seconds"
        • "Microseconds"
        • "Milliseconds"
        • "Bytes"
        • "Kilobytes"
        • "Megabytes"
        • "Gigabytes"
        • "Terabytes"
        • "Bits"
        • "Kilobits"
        • "Megabits"
        • "Gigabits"
        • "Terabits"
        • "Percent"
        • "Bytes/Second"
        • "Kilobytes/Second"
        • "Megabytes/Second"
        • "Gigabytes/Second"
        • "Terabytes/Second"
        • "Bits/Second"
        • "Kilobits/Second"
        • "Megabits/Second"
        • "Gigabits/Second"
        • "Terabits/Second"
        • "Count/Second"
    • ClientToken — (String)

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

    • Beneficiary — (String)

      License beneficiary.

    • NodeId — (String)

      Node ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CheckoutType — (String)

        Checkout type.

        Possible values include:
        • "PROVISIONAL"
        • "PERPETUAL"
      • LicenseConsumptionToken — (String)

        License consumption token.

      • EntitlementsAllowed — (Array<map>)

        Allowed license entitlements.

        • Name — required — (String)

          Entitlement data name.

        • Value — (String)

          Entitlement data value.

        • Unit — required — (String)

          Entitlement data unit.

          Possible values include:
          • "Count"
          • "None"
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
      • SignedToken — (String)

        Signed token.

      • NodeId — (String)

        Node ID.

      • IssuedAt — (String)

        Date and time at which the license checkout is issued.

      • Expiration — (String)

        Date and time at which the license checkout expires.

      • LicenseArn — (String)

        Amazon Resource Name (ARN) of the checkout license.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a grant for the specified license. A grant shares the use of license entitlements with specific Amazon Web Services accounts.

Service Reference:

Examples:

Calling the createGrant operation

var params = {
  AllowedOperations: [ /* required */
    CreateGrant | CheckoutLicense | CheckoutBorrowLicense | CheckInLicense | ExtendConsumptionLicense | ListPurchasedLicenses | CreateToken,
    /* more items */
  ],
  ClientToken: 'STRING_VALUE', /* required */
  GrantName: 'STRING_VALUE', /* required */
  HomeRegion: 'STRING_VALUE', /* required */
  LicenseArn: 'STRING_VALUE', /* required */
  Principals: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
licensemanager.createGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

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

    • GrantName — (String)

      Grant name.

    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license.

    • Principals — (Array<String>)

      The grant principals.

    • HomeRegion — (String)

      Home Region of the grant.

    • AllowedOperations — (Array<String>)

      Allowed operations for the grant.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GrantArn — (String)

        Grant ARN.

      • Status — (String)

        Grant status.

        Possible values include:
        • "PENDING_WORKFLOW"
        • "PENDING_ACCEPT"
        • "REJECTED"
        • "ACTIVE"
        • "FAILED_WORKFLOW"
        • "DELETED"
        • "PENDING_DELETE"
        • "DISABLED"
        • "WORKFLOW_COMPLETED"
      • Version — (String)

        Grant version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a new version of the specified grant.

Service Reference:

Examples:

Calling the createGrantVersion operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  GrantArn: 'STRING_VALUE', /* required */
  AllowedOperations: [
    CreateGrant | CheckoutLicense | CheckoutBorrowLicense | CheckInLicense | ExtendConsumptionLicense | ListPurchasedLicenses | CreateToken,
    /* more items */
  ],
  GrantName: 'STRING_VALUE',
  SourceVersion: 'STRING_VALUE',
  Status: PENDING_WORKFLOW | PENDING_ACCEPT | REJECTED | ACTIVE | FAILED_WORKFLOW | DELETED | PENDING_DELETE | DISABLED | WORKFLOW_COMPLETED,
  StatusReason: 'STRING_VALUE'
};
licensemanager.createGrantVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

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

    • GrantArn — (String)

      Amazon Resource Name (ARN) of the grant.

    • GrantName — (String)

      Grant name.

    • AllowedOperations — (Array<String>)

      Allowed operations for the grant.

    • Status — (String)

      Grant status.

      Possible values include:
      • "PENDING_WORKFLOW"
      • "PENDING_ACCEPT"
      • "REJECTED"
      • "ACTIVE"
      • "FAILED_WORKFLOW"
      • "DELETED"
      • "PENDING_DELETE"
      • "DISABLED"
      • "WORKFLOW_COMPLETED"
    • StatusReason — (String)

      Grant status reason.

    • SourceVersion — (String)

      Current version of the grant.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GrantArn — (String)

        Grant ARN.

      • Status — (String)

        Grant status.

        Possible values include:
        • "PENDING_WORKFLOW"
        • "PENDING_ACCEPT"
        • "REJECTED"
        • "ACTIVE"
        • "FAILED_WORKFLOW"
        • "DELETED"
        • "PENDING_DELETE"
        • "DISABLED"
        • "WORKFLOW_COMPLETED"
      • Version — (String)

        New version of the grant.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a license.

Service Reference:

Examples:

Calling the createLicense operation

var params = {
  Beneficiary: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE', /* required */
  ConsumptionConfiguration: { /* required */
    BorrowConfiguration: {
      AllowEarlyCheckIn: true || false, /* required */
      MaxTimeToLiveInMinutes: 'NUMBER_VALUE' /* required */
    },
    ProvisionalConfiguration: {
      MaxTimeToLiveInMinutes: 'NUMBER_VALUE' /* required */
    },
    RenewType: None | Weekly | Monthly
  },
  Entitlements: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Unit: Count | None | Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second, /* required */
      AllowCheckIn: true || false,
      MaxCount: 'NUMBER_VALUE',
      Overage: true || false,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  HomeRegion: 'STRING_VALUE', /* required */
  Issuer: { /* required */
    Name: 'STRING_VALUE', /* required */
    SignKey: 'STRING_VALUE'
  },
  LicenseName: 'STRING_VALUE', /* required */
  ProductName: 'STRING_VALUE', /* required */
  ProductSKU: 'STRING_VALUE', /* required */
  Validity: { /* required */
    Begin: 'STRING_VALUE', /* required */
    End: 'STRING_VALUE'
  },
  LicenseMetadata: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
licensemanager.createLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseName — (String)

      License name.

    • ProductName — (String)

      Product name.

    • ProductSKU — (String)

      Product SKU.

    • Issuer — (map)

      License issuer.

      • Name — required — (String)

        Issuer name.

      • SignKey — (String)

        Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

    • HomeRegion — (String)

      Home Region for the license.

    • Validity — (map)

      Date and time range during which the license is valid, in ISO8601-UTC format.

      • Begin — required — (String)

        Start of the time range.

      • End — (String)

        End of the time range.

    • Entitlements — (Array<map>)

      License entitlements.

      • Name — required — (String)

        Entitlement name.

      • Value — (String)

        Entitlement resource. Use only if the unit is None.

      • MaxCount — (Integer)

        Maximum entitlement count. Use if the unit is not None.

      • Overage — (Boolean)

        Indicates whether overages are allowed.

      • Unit — required — (String)

        Entitlement unit.

        Possible values include:
        • "Count"
        • "None"
        • "Seconds"
        • "Microseconds"
        • "Milliseconds"
        • "Bytes"
        • "Kilobytes"
        • "Megabytes"
        • "Gigabytes"
        • "Terabytes"
        • "Bits"
        • "Kilobits"
        • "Megabits"
        • "Gigabits"
        • "Terabits"
        • "Percent"
        • "Bytes/Second"
        • "Kilobytes/Second"
        • "Megabytes/Second"
        • "Gigabytes/Second"
        • "Terabytes/Second"
        • "Bits/Second"
        • "Kilobits/Second"
        • "Megabits/Second"
        • "Gigabits/Second"
        • "Terabits/Second"
        • "Count/Second"
      • AllowCheckIn — (Boolean)

        Indicates whether check-ins are allowed.

    • Beneficiary — (String)

      License beneficiary.

    • ConsumptionConfiguration — (map)

      Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

      • RenewType — (String)

        Renewal frequency.

        Possible values include:
        • "None"
        • "Weekly"
        • "Monthly"
      • ProvisionalConfiguration — (map)

        Details about a provisional configuration.

        • MaxTimeToLiveInMinutes — required — (Integer)

          Maximum time for the provisional configuration, in minutes.

      • BorrowConfiguration — (map)

        Details about a borrow configuration.

        • AllowEarlyCheckIn — required — (Boolean)

          Indicates whether early check-ins are allowed.

        • MaxTimeToLiveInMinutes — required — (Integer)

          Maximum time for the borrow configuration, in minutes.

    • LicenseMetadata — (Array<map>)

      Information about the license.

      • Name — (String)

        The key name.

      • Value — (String)

        The value.

    • ClientToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseArn — (String)

        Amazon Resource Name (ARN) of the license.

      • Status — (String)

        License status.

        Possible values include:
        • "AVAILABLE"
        • "PENDING_AVAILABLE"
        • "DEACTIVATED"
        • "SUSPENDED"
        • "EXPIRED"
        • "PENDING_DELETE"
        • "DELETED"
      • Version — (String)

        License version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a license configuration.

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.

Service Reference:

Examples:

Calling the createLicenseConfiguration operation

var params = {
  LicenseCountingType: vCPU | Instance | Core | Socket, /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisassociateWhenNotFound: true || false,
  LicenseCount: 'NUMBER_VALUE',
  LicenseCountHardLimit: true || false,
  LicenseRules: [
    'STRING_VALUE',
    /* more items */
  ],
  ProductInformationList: [
    {
      ProductInformationFilterList: [ /* required */
        {
          ProductInformationFilterComparator: 'STRING_VALUE', /* required */
          ProductInformationFilterName: 'STRING_VALUE', /* required */
          ProductInformationFilterValue: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
licensemanager.createLicenseConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      Name of the license configuration.

    • Description — (String)

      Description of the license configuration.

    • LicenseCountingType — (String)

      Dimension used to track the license inventory.

      Possible values include:
      • "vCPU"
      • "Instance"
      • "Core"
      • "Socket"
    • LicenseCount — (Integer)

      Number of licenses managed by the license configuration.

    • LicenseCountHardLimit — (Boolean)

      Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.

    • LicenseRules — (Array<String>)

      License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows.

      • Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores

      • Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus

      • Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets

      • vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus

      The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.

    • Tags — (Array<map>)

      Tags to add to the license configuration.

      • Key — (String)

        Tag key.

      • Value — (String)

        Tag value.

    • DisassociateWhenNotFound — (Boolean)

      When true, disassociates a resource when software is uninstalled.

    • ProductInformationList — (Array<map>)

      Product information.

      • ResourceType — required — (String)

        Resource type. The possible values are SSM_MANAGED | RDS.

      • ProductInformationFilterList — required — (Array<map>)

        A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

        Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

        The following filters and are supported when the resource type is SSM_MANAGED:

        • Application Name - The name of the application. Logical operator is EQUALS.

        • Application Publisher - The publisher of the application. Logical operator is EQUALS.

        • Application Version - The version of the application. Logical operator is EQUALS.

        • Platform Name - The name of the platform. Logical operator is EQUALS.

        • Platform Type - The platform type. Logical operator is EQUALS.

        • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

        • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

        • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

        The following filters and logical operators are supported when the resource type is RDS:

        • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

        • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

        • ProductInformationFilterName — required — (String)

          Filter name.

        • ProductInformationFilterValue — (Array<String>)

          Filter value.

        • ProductInformationFilterComparator — required — (String)

          Logical operator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConfigurationArn — (String)

        Amazon Resource Name (ARN) of the license configuration.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a new license conversion task.

Service Reference:

Examples:

Calling the createLicenseConversionTaskForResource operation

var params = {
  DestinationLicenseContext: { /* required */
    UsageOperation: 'STRING_VALUE'
  },
  ResourceArn: 'STRING_VALUE', /* required */
  SourceLicenseContext: { /* required */
    UsageOperation: 'STRING_VALUE'
  }
};
licensemanager.createLicenseConversionTaskForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the resource you are converting the license type for.

    • SourceLicenseContext — (map)

      Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the AWS CLI in the License Manager User Guide.

      • UsageOperation — (String)

        The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

    • DestinationLicenseContext — (map)

      Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the AWS CLI in the License Manager User Guide.

      • UsageOperation — (String)

        The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConversionTaskId — (String)

        The ID of the created license type conversion task.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a report generator.

Service Reference:

Examples:

Calling the createLicenseManagerReportGenerator operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  ReportContext: { /* required */
    licenseConfigurationArns: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  ReportFrequency: { /* required */
    period: DAY | WEEK | MONTH,
    value: 'NUMBER_VALUE'
  },
  ReportGeneratorName: 'STRING_VALUE', /* required */
  Type: [ /* required */
    LicenseConfigurationSummaryReport | LicenseConfigurationUsageReport,
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
licensemanager.createLicenseManagerReportGenerator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReportGeneratorName — (String)

      Name of the report generator.

    • Type — (Array<String>)

      Type of reports to generate. The following report types an be generated:

      • License configuration report - Reports the number and details of consumed licenses for a license configuration.

      • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

    • ReportContext — (map)

      Defines the type of license configuration the report generator tracks.

      • licenseConfigurationArns — required — (Array<String>)

        Amazon Resource Name (ARN) of the license configuration that this generator reports on.

    • ReportFrequency — (map)

      Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.

      • value — (Integer)

        Number of times within the frequency period that a report is generated. The only supported value is 1.

      • period — (String)

        Time period between each report. The period can be daily, weekly, or monthly.

        Possible values include:
        • "DAY"
        • "WEEK"
        • "MONTH"
    • ClientToken — (String)

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

    • Description — (String)

      Description of the report generator.

    • Tags — (Array<map>)

      Tags to add to the report generator.

      • Key — (String)

        Tag key.

      • Value — (String)

        Tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseManagerReportGeneratorArn — (String)

        The Amazon Resource Name (ARN) of the new report generator.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a new version of the specified license.

Service Reference:

Examples:

Calling the createLicenseVersion operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  ConsumptionConfiguration: { /* required */
    BorrowConfiguration: {
      AllowEarlyCheckIn: true || false, /* required */
      MaxTimeToLiveInMinutes: 'NUMBER_VALUE' /* required */
    },
    ProvisionalConfiguration: {
      MaxTimeToLiveInMinutes: 'NUMBER_VALUE' /* required */
    },
    RenewType: None | Weekly | Monthly
  },
  Entitlements: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Unit: Count | None | Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second, /* required */
      AllowCheckIn: true || false,
      MaxCount: 'NUMBER_VALUE',
      Overage: true || false,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  HomeRegion: 'STRING_VALUE', /* required */
  Issuer: { /* required */
    Name: 'STRING_VALUE', /* required */
    SignKey: 'STRING_VALUE'
  },
  LicenseArn: 'STRING_VALUE', /* required */
  LicenseName: 'STRING_VALUE', /* required */
  ProductName: 'STRING_VALUE', /* required */
  Status: AVAILABLE | PENDING_AVAILABLE | DEACTIVATED | SUSPENDED | EXPIRED | PENDING_DELETE | DELETED, /* required */
  Validity: { /* required */
    Begin: 'STRING_VALUE', /* required */
    End: 'STRING_VALUE'
  },
  LicenseMetadata: [
    {
      Name: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  SourceVersion: 'STRING_VALUE'
};
licensemanager.createLicenseVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license.

    • LicenseName — (String)

      License name.

    • ProductName — (String)

      Product name.

    • Issuer — (map)

      License issuer.

      • Name — required — (String)

        Issuer name.

      • SignKey — (String)

        Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

    • HomeRegion — (String)

      Home Region of the license.

    • Validity — (map)

      Date and time range during which the license is valid, in ISO8601-UTC format.

      • Begin — required — (String)

        Start of the time range.

      • End — (String)

        End of the time range.

    • LicenseMetadata — (Array<map>)

      Information about the license.

      • Name — (String)

        The key name.

      • Value — (String)

        The value.

    • Entitlements — (Array<map>)

      License entitlements.

      • Name — required — (String)

        Entitlement name.

      • Value — (String)

        Entitlement resource. Use only if the unit is None.

      • MaxCount — (Integer)

        Maximum entitlement count. Use if the unit is not None.

      • Overage — (Boolean)

        Indicates whether overages are allowed.

      • Unit — required — (String)

        Entitlement unit.

        Possible values include:
        • "Count"
        • "None"
        • "Seconds"
        • "Microseconds"
        • "Milliseconds"
        • "Bytes"
        • "Kilobytes"
        • "Megabytes"
        • "Gigabytes"
        • "Terabytes"
        • "Bits"
        • "Kilobits"
        • "Megabits"
        • "Gigabits"
        • "Terabits"
        • "Percent"
        • "Bytes/Second"
        • "Kilobytes/Second"
        • "Megabytes/Second"
        • "Gigabytes/Second"
        • "Terabytes/Second"
        • "Bits/Second"
        • "Kilobits/Second"
        • "Megabits/Second"
        • "Gigabits/Second"
        • "Terabits/Second"
        • "Count/Second"
      • AllowCheckIn — (Boolean)

        Indicates whether check-ins are allowed.

    • ConsumptionConfiguration — (map)

      Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.

      • RenewType — (String)

        Renewal frequency.

        Possible values include:
        • "None"
        • "Weekly"
        • "Monthly"
      • ProvisionalConfiguration — (map)

        Details about a provisional configuration.

        • MaxTimeToLiveInMinutes — required — (Integer)

          Maximum time for the provisional configuration, in minutes.

      • BorrowConfiguration — (map)

        Details about a borrow configuration.

        • AllowEarlyCheckIn — required — (Boolean)

          Indicates whether early check-ins are allowed.

        • MaxTimeToLiveInMinutes — required — (Integer)

          Maximum time for the borrow configuration, in minutes.

    • Status — (String)

      License status.

      Possible values include:
      • "AVAILABLE"
      • "PENDING_AVAILABLE"
      • "DEACTIVATED"
      • "SUSPENDED"
      • "EXPIRED"
      • "PENDING_DELETE"
      • "DELETED"
    • ClientToken — (String)

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

    • SourceVersion — (String)

      Current version of the license.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseArn — (String)

        License ARN.

      • Version — (String)

        New version of the license.

      • Status — (String)

        License status.

        Possible values include:
        • "AVAILABLE"
        • "PENDING_AVAILABLE"
        • "DEACTIVATED"
        • "SUSPENDED"
        • "EXPIRED"
        • "PENDING_DELETE"
        • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Creates a long-lived token.

A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.

Service Reference:

Examples:

Calling the createToken operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  LicenseArn: 'STRING_VALUE', /* required */
  ExpirationInDays: 'NUMBER_VALUE',
  RoleArns: [
    'STRING_VALUE',
    /* more items */
  ],
  TokenProperties: [
    'STRING_VALUE',
    /* more items */
  ]
};
licensemanager.createToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.

    • RoleArns — (Array<String>)

      Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.

    • ExpirationInDays — (Integer)

      Token expiration, in days, counted from token creation. The default is 365 days.

    • TokenProperties — (Array<String>)

      Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.

    • ClientToken — (String)

      Idempotency token, valid for 10 minutes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TokenId — (String)

        Token ID.

      • TokenType — (String)

        Token type.

        Possible values include:
        • "REFRESH_TOKEN"
      • Token — (String)

        Refresh token, encoded as a JWT token.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified grant.

Service Reference:

Examples:

Calling the deleteGrant operation

var params = {
  GrantArn: 'STRING_VALUE', /* required */
  Version: 'STRING_VALUE', /* required */
  StatusReason: 'STRING_VALUE'
};
licensemanager.deleteGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GrantArn — (String)

      Amazon Resource Name (ARN) of the grant.

    • StatusReason — (String)

      The Status reason for the delete request.

    • Version — (String)

      Current version of the grant.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GrantArn — (String)

        Grant ARN.

      • Status — (String)

        Grant status.

        Possible values include:
        • "PENDING_WORKFLOW"
        • "PENDING_ACCEPT"
        • "REJECTED"
        • "ACTIVE"
        • "FAILED_WORKFLOW"
        • "DELETED"
        • "PENDING_DELETE"
        • "DISABLED"
        • "WORKFLOW_COMPLETED"
      • Version — (String)

        Grant version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified license.

Service Reference:

Examples:

Calling the deleteLicense operation

var params = {
  LicenseArn: 'STRING_VALUE', /* required */
  SourceVersion: 'STRING_VALUE' /* required */
};
licensemanager.deleteLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license.

    • SourceVersion — (String)

      Current version of the license.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Status — (String)

        License status.

        Possible values include:
        • "PENDING_DELETE"
        • "DELETED"
      • DeletionDate — (String)

        Date when the license is deleted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified license configuration.

You cannot delete a license configuration that is in use.

Service Reference:

Examples:

Calling the deleteLicenseConfiguration operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE' /* required */
};
licensemanager.deleteLicenseConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArn — (String)

      ID of the license configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified report generator.

This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.

Service Reference:

Examples:

Calling the deleteLicenseManagerReportGenerator operation

var params = {
  LicenseManagerReportGeneratorArn: 'STRING_VALUE' /* required */
};
licensemanager.deleteLicenseManagerReportGenerator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseManagerReportGeneratorArn — (String)

      Amazon Resource Name (ARN) of the report generator to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified token. Must be called in the license home Region.

Service Reference:

Examples:

Calling the deleteToken operation

var params = {
  TokenId: 'STRING_VALUE' /* required */
};
licensemanager.deleteToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TokenId — (String)

      Token ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Extends the expiration date for license consumption.

Service Reference:

Examples:

Calling the extendLicenseConsumption operation

var params = {
  LicenseConsumptionToken: 'STRING_VALUE', /* required */
  DryRun: true || false
};
licensemanager.extendLicenseConsumption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConsumptionToken — (String)

      License consumption token.

    • DryRun — (Boolean)

      Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConsumptionToken — (String)

        License consumption token.

      • Expiration — (String)

        Date and time at which the license consumption expires.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.

Service Reference:

Examples:

Calling the getAccessToken operation

var params = {
  Token: 'STRING_VALUE', /* required */
  TokenProperties: [
    'STRING_VALUE',
    /* more items */
  ]
};
licensemanager.getAccessToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Token — (String)

      Refresh token, encoded as a JWT token.

    • TokenProperties — (Array<String>)

      Token properties to validate against those present in the JWT token.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccessToken — (String)

        Temporary access token.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets detailed information about the specified grant.

Service Reference:

Examples:

Calling the getGrant operation

var params = {
  GrantArn: 'STRING_VALUE', /* required */
  Version: 'STRING_VALUE'
};
licensemanager.getGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GrantArn — (String)

      Amazon Resource Name (ARN) of the grant.

    • Version — (String)

      Grant version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grant — (map)

        Grant details.

        • GrantArn — required — (String)

          Amazon Resource Name (ARN) of the grant.

        • GrantName — required — (String)

          Grant name.

        • ParentArn — required — (String)

          Parent ARN.

        • LicenseArn — required — (String)

          License ARN.

        • GranteePrincipalArn — required — (String)

          The grantee principal ARN.

        • HomeRegion — required — (String)

          Home Region of the grant.

        • GrantStatus — required — (String)

          Grant status.

          Possible values include:
          • "PENDING_WORKFLOW"
          • "PENDING_ACCEPT"
          • "REJECTED"
          • "ACTIVE"
          • "FAILED_WORKFLOW"
          • "DELETED"
          • "PENDING_DELETE"
          • "DISABLED"
          • "WORKFLOW_COMPLETED"
        • StatusReason — (String)

          Grant status reason.

        • Version — required — (String)

          Grant version.

        • GrantedOperations — required — (Array<String>)

          Granted operations.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets detailed information about the specified license.

Service Reference:

Examples:

Calling the getLicense operation

var params = {
  LicenseArn: 'STRING_VALUE', /* required */
  Version: 'STRING_VALUE'
};
licensemanager.getLicense(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license.

    • Version — (String)

      License version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • License — (map)

        License details.

        • LicenseArn — (String)

          Amazon Resource Name (ARN) of the license.

        • LicenseName — (String)

          License name.

        • ProductName — (String)

          Product name.

        • ProductSKU — (String)

          Product SKU.

        • Issuer — (map)

          License issuer.

          • Name — (String)

            Issuer name.

          • SignKey — (String)

            Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint — (String)

            Issuer key fingerprint.

        • HomeRegion — (String)

          Home Region of the license.

        • Status — (String)

          License status.

          Possible values include:
          • "AVAILABLE"
          • "PENDING_AVAILABLE"
          • "DEACTIVATED"
          • "SUSPENDED"
          • "EXPIRED"
          • "PENDING_DELETE"
          • "DELETED"
        • Validity — (map)

          Date and time range during which the license is valid, in ISO8601-UTC format.

          • Begin — required — (String)

            Start of the time range.

          • End — (String)

            End of the time range.

        • Beneficiary — (String)

          License beneficiary.

        • Entitlements — (Array<map>)

          License entitlements.

          • Name — required — (String)

            Entitlement name.

          • Value — (String)

            Entitlement resource. Use only if the unit is None.

          • MaxCount — (Integer)

            Maximum entitlement count. Use if the unit is not None.

          • Overage — (Boolean)

            Indicates whether overages are allowed.

          • Unit — required — (String)

            Entitlement unit.

            Possible values include:
            • "Count"
            • "None"
            • "Seconds"
            • "Microseconds"
            • "Milliseconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"
          • AllowCheckIn — (Boolean)

            Indicates whether check-ins are allowed.

        • ConsumptionConfiguration — (map)

          Configuration for consumption of the license.

          • RenewType — (String)

            Renewal frequency.

            Possible values include:
            • "None"
            • "Weekly"
            • "Monthly"
          • ProvisionalConfiguration — (map)

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration — (map)

            Details about a borrow configuration.

            • AllowEarlyCheckIn — required — (Boolean)

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata — (Array<map>)

          License metadata.

          • Name — (String)

            The key name.

          • Value — (String)

            The value.

        • CreateTime — (String)

          License creation time.

        • Version — (String)

          License version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets detailed information about the specified license configuration.

Service Reference:

Examples:

Calling the getLicenseConfiguration operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE' /* required */
};
licensemanager.getLicenseConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArn — (String)

      Amazon Resource Name (ARN) of the license configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConfigurationId — (String)

        Unique ID for the license configuration.

      • LicenseConfigurationArn — (String)

        Amazon Resource Name (ARN) of the license configuration.

      • Name — (String)

        Name of the license configuration.

      • Description — (String)

        Description of the license configuration.

      • LicenseCountingType — (String)

        Dimension for which the licenses are counted.

        Possible values include:
        • "vCPU"
        • "Instance"
        • "Core"
        • "Socket"
      • LicenseRules — (Array<String>)

        License rules.

      • LicenseCount — (Integer)

        Number of available licenses.

      • LicenseCountHardLimit — (Boolean)

        Sets the number of available licenses as a hard limit.

      • ConsumedLicenses — (Integer)

        Number of licenses assigned to resources.

      • Status — (String)

        License configuration status.

      • OwnerAccountId — (String)

        Account ID of the owner of the license configuration.

      • ConsumedLicenseSummaryList — (Array<map>)

        Summaries of the licenses consumed by resources.

        • ResourceType — (String)

          Resource type of the resource consuming a license.

          Possible values include:
          • "EC2_INSTANCE"
          • "EC2_HOST"
          • "EC2_AMI"
          • "RDS"
          • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
        • ConsumedLicenses — (Integer)

          Number of licenses consumed by the resource.

      • ManagedResourceSummaryList — (Array<map>)

        Summaries of the managed resources.

        • ResourceType — (String)

          Type of resource associated with a license.

          Possible values include:
          • "EC2_INSTANCE"
          • "EC2_HOST"
          • "EC2_AMI"
          • "RDS"
          • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
        • AssociationCount — (Integer)

          Number of resources associated with licenses.

      • Tags — (Array<map>)

        Tags for the license configuration.

        • Key — (String)

          Tag key.

        • Value — (String)

          Tag value.

      • ProductInformationList — (Array<map>)

        Product information.

        • ResourceType — required — (String)

          Resource type. The possible values are SSM_MANAGED | RDS.

        • ProductInformationFilterList — required — (Array<map>)

          A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

          Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

          The following filters and are supported when the resource type is SSM_MANAGED:

          • Application Name - The name of the application. Logical operator is EQUALS.

          • Application Publisher - The publisher of the application. Logical operator is EQUALS.

          • Application Version - The version of the application. Logical operator is EQUALS.

          • Platform Name - The name of the platform. Logical operator is EQUALS.

          • Platform Type - The platform type. Logical operator is EQUALS.

          • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

          • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

          • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

          The following filters and logical operators are supported when the resource type is RDS:

          • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

          • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

          • ProductInformationFilterName — required — (String)

            Filter name.

          • ProductInformationFilterValue — (Array<String>)

            Filter value.

          • ProductInformationFilterComparator — required — (String)

            Logical operator.

      • AutomatedDiscoveryInformation — (map)

        Automated discovery information.

        • LastRunTime — (Date)

          Time that automated discovery last ran.

      • DisassociateWhenNotFound — (Boolean)

        When true, disassociates a resource when software is uninstalled.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets information about the specified license type conversion task.

Service Reference:

Examples:

Calling the getLicenseConversionTask operation

var params = {
  LicenseConversionTaskId: 'STRING_VALUE' /* required */
};
licensemanager.getLicenseConversionTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConversionTaskId — (String)

      ID of the license type conversion task to retrieve information on.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConversionTaskId — (String)

        ID of the license type conversion task.

      • ResourceArn — (String)

        Amazon Resource Names (ARN) of the resources the license conversion task is associated with.

      • SourceLicenseContext — (map)

        Information about the license type converted from.

        • UsageOperation — (String)

          The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

      • DestinationLicenseContext — (map)

        Information about the license type converted to.

        • UsageOperation — (String)

          The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

      • StatusMessage — (String)

        The status message for the conversion task.

      • Status — (String)

        Status of the license type conversion task.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"
      • StartTime — (Date)

        Time at which the license type conversion task was started .

      • LicenseConversionTime — (Date)

        Amount of time to complete the license type conversion.

      • EndTime — (Date)

        Time at which the license type conversion task was completed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets information about the specified report generator.

Service Reference:

Examples:

Calling the getLicenseManagerReportGenerator operation

var params = {
  LicenseManagerReportGeneratorArn: 'STRING_VALUE' /* required */
};
licensemanager.getLicenseManagerReportGenerator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseManagerReportGeneratorArn — (String)

      Amazon Resource Name (ARN) of the report generator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportGenerator — (map)

        A report generator that creates periodic reports about your license configurations.

        • ReportGeneratorName — (String)

          Name of the report generator.

        • ReportType — (Array<String>)

          Type of reports that are generated.

        • ReportContext — (map)

          License configuration type for this generator.

          • licenseConfigurationArns — required — (Array<String>)

            Amazon Resource Name (ARN) of the license configuration that this generator reports on.

        • ReportFrequency — (map)

          Details about how frequently reports are generated.

          • value — (Integer)

            Number of times within the frequency period that a report is generated. The only supported value is 1.

          • period — (String)

            Time period between each report. The period can be daily, weekly, or monthly.

            Possible values include:
            • "DAY"
            • "WEEK"
            • "MONTH"
        • LicenseManagerReportGeneratorArn — (String)

          Amazon Resource Name (ARN) of the report generator.

        • LastRunStatus — (String)

          Status of the last report generation attempt.

        • LastRunFailureReason — (String)

          Failure message for the last report generation attempt.

        • LastReportGenerationTime — (String)

          Time the last report was generated at.

        • ReportCreatorAccount — (String)

          The Amazon Web Services account ID used to create the report generator.

        • Description — (String)

          Description of the report generator.

        • S3Location — (map)

          Details of the S3 bucket that report generator reports are published to.

          • bucket — (String)

            Name of the S3 bucket reports are published to.

          • keyPrefix — (String)

            Prefix of the S3 bucket reports are published to.

        • CreateTime — (String)

          Time the report was created.

        • Tags — (Array<map>)

          Tags associated with the report generator.

          • Key — (String)

            Tag key.

          • Value — (String)

            Tag value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets detailed information about the usage of the specified license.

Service Reference:

Examples:

Calling the getLicenseUsage operation

var params = {
  LicenseArn: 'STRING_VALUE' /* required */
};
licensemanager.getLicenseUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseUsage — (map)

        License usage details.

        • EntitlementUsages — (Array<map>)

          License entitlement usages.

          • Name — required — (String)

            Entitlement usage name.

          • ConsumedValue — required — (String)

            Resource usage consumed.

          • MaxCount — (String)

            Maximum entitlement usage count.

          • Unit — required — (String)

            Entitlement usage unit.

            Possible values include:
            • "Count"
            • "None"
            • "Seconds"
            • "Microseconds"
            • "Milliseconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Gets the License Manager settings for the current Region.

Service Reference:

Examples:

Calling the getServiceSettings operation

var params = {
};
licensemanager.getServiceSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • S3BucketArn — (String)

        Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.

      • SnsTopicArn — (String)

        SNS topic configured to receive notifications from License Manager.

      • OrganizationConfiguration — (map)

        Indicates whether Organizations is integrated with License Manager for cross-account discovery.

        • EnableIntegration — required — (Boolean)

          Enables Organizations integration.

      • EnableCrossAccountsDiscovery — (Boolean)

        Indicates whether cross-account discovery is enabled.

      • LicenseManagerResourceShareArn — (String)

        Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the resource associations for the specified license configuration.

Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).

Service Reference:

Examples:

Calling the listAssociationsForLicenseConfiguration operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listAssociationsForLicenseConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArn — (String)

      Amazon Resource Name (ARN) of a license configuration.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • NextToken — (String)

      Token for the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConfigurationAssociations — (Array<map>)

        Information about the associations for the license configuration.

        • ResourceArn — (String)

          Amazon Resource Name (ARN) of the resource.

        • ResourceType — (String)

          Type of server resource.

          Possible values include:
          • "EC2_INSTANCE"
          • "EC2_HOST"
          • "EC2_AMI"
          • "RDS"
          • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
        • ResourceOwnerId — (String)

          ID of the Amazon Web Services account that owns the resource consuming licenses.

        • AssociationTime — (Date)

          Time when the license configuration was associated with the resource.

        • AmiAssociationScope — (String)

          Scope of AMI associations. The possible value is cross-account.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the grants distributed for the specified license.

Service Reference:

Examples:

Calling the listDistributedGrants operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GrantArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listDistributedGrants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GrantArns — (Array<String>)

      Amazon Resource Names (ARNs) of the grants.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters are supported:

      • LicenseArn

      • GrantStatus

      • GranteePrincipalARN

      • ProductSKU

      • LicenseIssuerName

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grants — (Array<map>)

        Distributed grant details.

        • GrantArn — required — (String)

          Amazon Resource Name (ARN) of the grant.

        • GrantName — required — (String)

          Grant name.

        • ParentArn — required — (String)

          Parent ARN.

        • LicenseArn — required — (String)

          License ARN.

        • GranteePrincipalArn — required — (String)

          The grantee principal ARN.

        • HomeRegion — required — (String)

          Home Region of the grant.

        • GrantStatus — required — (String)

          Grant status.

          Possible values include:
          • "PENDING_WORKFLOW"
          • "PENDING_ACCEPT"
          • "REJECTED"
          • "ACTIVE"
          • "FAILED_WORKFLOW"
          • "DELETED"
          • "PENDING_DELETE"
          • "DISABLED"
          • "WORKFLOW_COMPLETED"
        • StatusReason — (String)

          Grant status reason.

        • Version — required — (String)

          Grant version.

        • GrantedOperations — required — (Array<String>)

          Granted operations.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the license configuration operations that failed.

Service Reference:

Examples:

Calling the listFailuresForLicenseConfigurationOperations operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listFailuresForLicenseConfigurationOperations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArn — (String)

      Amazon Resource Name of the license configuration.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • NextToken — (String)

      Token for the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseOperationFailureList — (Array<map>)

        License configuration operations that failed.

        • ResourceArn — (String)

          Amazon Resource Name (ARN) of the resource.

        • ResourceType — (String)

          Resource type.

          Possible values include:
          • "EC2_INSTANCE"
          • "EC2_HOST"
          • "EC2_AMI"
          • "RDS"
          • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
        • ErrorMessage — (String)

          Error message.

        • FailureTime — (Date)

          Failure time.

        • OperationName — (String)

          Name of the operation.

        • ResourceOwnerId — (String)

          ID of the Amazon Web Services account that owns the resource.

        • OperationRequestedBy — (String)

          The requester is "License Manager Automated Discovery".

        • MetadataList — (Array<map>)

          Reserved.

          • Name — (String)

            The key name.

          • Value — (String)

            The value.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the license configurations for your account.

Service Reference:

Examples:

Calling the listLicenseConfigurations operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseConfigurationArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listLicenseConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArns — (Array<String>)

      Amazon Resource Names (ARN) of the license configurations.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • NextToken — (String)

      Token for the next set of results.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters and logical operators are supported:

      • licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS.

      • enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS.

      • usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConfigurations — (Array<map>)

        Information about the license configurations.

        • LicenseConfigurationId — (String)

          Unique ID of the license configuration.

        • LicenseConfigurationArn — (String)

          Amazon Resource Name (ARN) of the license configuration.

        • Name — (String)

          Name of the license configuration.

        • Description — (String)

          Description of the license configuration.

        • LicenseCountingType — (String)

          Dimension to use to track the license inventory.

          Possible values include:
          • "vCPU"
          • "Instance"
          • "Core"
          • "Socket"
        • LicenseRules — (Array<String>)

          License rules.

        • LicenseCount — (Integer)

          Number of licenses managed by the license configuration.

        • LicenseCountHardLimit — (Boolean)

          Number of available licenses as a hard limit.

        • DisassociateWhenNotFound — (Boolean)

          When true, disassociates a resource when software is uninstalled.

        • ConsumedLicenses — (Integer)

          Number of licenses consumed.

        • Status — (String)

          Status of the license configuration.

        • OwnerAccountId — (String)

          Account ID of the license configuration's owner.

        • ConsumedLicenseSummaryList — (Array<map>)

          Summaries for licenses consumed by various resources.

          • ResourceType — (String)

            Resource type of the resource consuming a license.

            Possible values include:
            • "EC2_INSTANCE"
            • "EC2_HOST"
            • "EC2_AMI"
            • "RDS"
            • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
          • ConsumedLicenses — (Integer)

            Number of licenses consumed by the resource.

        • ManagedResourceSummaryList — (Array<map>)

          Summaries for managed resources.

          • ResourceType — (String)

            Type of resource associated with a license.

            Possible values include:
            • "EC2_INSTANCE"
            • "EC2_HOST"
            • "EC2_AMI"
            • "RDS"
            • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
          • AssociationCount — (Integer)

            Number of resources associated with licenses.

        • ProductInformationList — (Array<map>)

          Product information.

          • ResourceType — required — (String)

            Resource type. The possible values are SSM_MANAGED | RDS.

          • ProductInformationFilterList — required — (Array<map>)

            A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

            Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

            The following filters and are supported when the resource type is SSM_MANAGED:

            • Application Name - The name of the application. Logical operator is EQUALS.

            • Application Publisher - The publisher of the application. Logical operator is EQUALS.

            • Application Version - The version of the application. Logical operator is EQUALS.

            • Platform Name - The name of the platform. Logical operator is EQUALS.

            • Platform Type - The platform type. Logical operator is EQUALS.

            • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

            • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

            • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

            The following filters and logical operators are supported when the resource type is RDS:

            • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

            • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

            • ProductInformationFilterName — required — (String)

              Filter name.

            • ProductInformationFilterValue — (Array<String>)

              Filter value.

            • ProductInformationFilterComparator — required — (String)

              Logical operator.

        • AutomatedDiscoveryInformation — (map)

          Automated discovery information.

          • LastRunTime — (Date)

            Time that automated discovery last ran.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the license type conversion tasks for your account.

Service Reference:

Examples:

Calling the listLicenseConversionTasks operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listLicenseConversionTasks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • Filters — (Array<map>)

      Filters to scope the results. Valid filters are ResourceArns and Status.

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConversionTasks — (Array<map>)

        Information about the license configuration tasks for your account.

        • LicenseConversionTaskId — (String)

          The ID of the license type conversion task.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.

        • SourceLicenseContext — (map)

          Information about the license type this conversion task converted from.

          • UsageOperation — (String)

            The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

        • DestinationLicenseContext — (map)

          Information about the license type this conversion task converted to.

          • UsageOperation — (String)

            The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform

        • Status — (String)

          The status of the conversion task.

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
        • StatusMessage — (String)

          The status message for the conversion task.

        • StartTime — (Date)

          The time the conversion task was started at.

        • LicenseConversionTime — (Date)

          The time the usage operation value of the resource was changed.

        • EndTime — (Date)

          The time the conversion task was completed.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the report generators for your account.

Service Reference:

Examples:

Calling the listLicenseManagerReportGenerators operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listLicenseManagerReportGenerators(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (Array<map>)

      Filters to scope the results. The following filters are supported:

      • LicenseConfigurationArn

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportGenerators — (Array<map>)

        A report generator that creates periodic reports about your license configurations.

        • ReportGeneratorName — (String)

          Name of the report generator.

        • ReportType — (Array<String>)

          Type of reports that are generated.

        • ReportContext — (map)

          License configuration type for this generator.

          • licenseConfigurationArns — required — (Array<String>)

            Amazon Resource Name (ARN) of the license configuration that this generator reports on.

        • ReportFrequency — (map)

          Details about how frequently reports are generated.

          • value — (Integer)

            Number of times within the frequency period that a report is generated. The only supported value is 1.

          • period — (String)

            Time period between each report. The period can be daily, weekly, or monthly.

            Possible values include:
            • "DAY"
            • "WEEK"
            • "MONTH"
        • LicenseManagerReportGeneratorArn — (String)

          Amazon Resource Name (ARN) of the report generator.

        • LastRunStatus — (String)

          Status of the last report generation attempt.

        • LastRunFailureReason — (String)

          Failure message for the last report generation attempt.

        • LastReportGenerationTime — (String)

          Time the last report was generated at.

        • ReportCreatorAccount — (String)

          The Amazon Web Services account ID used to create the report generator.

        • Description — (String)

          Description of the report generator.

        • S3Location — (map)

          Details of the S3 bucket that report generator reports are published to.

          • bucket — (String)

            Name of the S3 bucket reports are published to.

          • keyPrefix — (String)

            Prefix of the S3 bucket reports are published to.

        • CreateTime — (String)

          Time the report was created.

        • Tags — (Array<map>)

          Tags associated with the report generator.

          • Key — (String)

            Tag key.

          • Value — (String)

            Tag value.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the licenses for your account.

Service Reference:

Examples:

Calling the listLicenses operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listLicenses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArns — (Array<String>)

      Amazon Resource Names (ARNs) of the licenses.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters are supported:

      • Beneficiary

      • ProductSKU

      • Fingerprint

      • Status

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Licenses — (Array<map>)

        License details.

        • LicenseArn — (String)

          Amazon Resource Name (ARN) of the license.

        • LicenseName — (String)

          License name.

        • ProductName — (String)

          Product name.

        • ProductSKU — (String)

          Product SKU.

        • Issuer — (map)

          License issuer.

          • Name — (String)

            Issuer name.

          • SignKey — (String)

            Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint — (String)

            Issuer key fingerprint.

        • HomeRegion — (String)

          Home Region of the license.

        • Status — (String)

          License status.

          Possible values include:
          • "AVAILABLE"
          • "PENDING_AVAILABLE"
          • "DEACTIVATED"
          • "SUSPENDED"
          • "EXPIRED"
          • "PENDING_DELETE"
          • "DELETED"
        • Validity — (map)

          Date and time range during which the license is valid, in ISO8601-UTC format.

          • Begin — required — (String)

            Start of the time range.

          • End — (String)

            End of the time range.

        • Beneficiary — (String)

          License beneficiary.

        • Entitlements — (Array<map>)

          License entitlements.

          • Name — required — (String)

            Entitlement name.

          • Value — (String)

            Entitlement resource. Use only if the unit is None.

          • MaxCount — (Integer)

            Maximum entitlement count. Use if the unit is not None.

          • Overage — (Boolean)

            Indicates whether overages are allowed.

          • Unit — required — (String)

            Entitlement unit.

            Possible values include:
            • "Count"
            • "None"
            • "Seconds"
            • "Microseconds"
            • "Milliseconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"
          • AllowCheckIn — (Boolean)

            Indicates whether check-ins are allowed.

        • ConsumptionConfiguration — (map)

          Configuration for consumption of the license.

          • RenewType — (String)

            Renewal frequency.

            Possible values include:
            • "None"
            • "Weekly"
            • "Monthly"
          • ProvisionalConfiguration — (map)

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration — (map)

            Details about a borrow configuration.

            • AllowEarlyCheckIn — required — (Boolean)

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata — (Array<map>)

          License metadata.

          • Name — (String)

            The key name.

          • Value — (String)

            The value.

        • CreateTime — (String)

          License creation time.

        • Version — (String)

          License version.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Describes the license configurations for the specified resource.

Service Reference:

Examples:

Calling the listLicenseSpecificationsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listLicenseSpecificationsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of a resource that has an associated license configuration.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • NextToken — (String)

      Token for the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseSpecifications — (Array<map>)

        License configurations associated with a resource.

        • LicenseConfigurationArn — required — (String)

          Amazon Resource Name (ARN) of the license configuration.

        • AmiAssociationScope — (String)

          Scope of AMI associations. The possible value is cross-account.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists all versions of the specified license.

Service Reference:

Examples:

Calling the listLicenseVersions operation

var params = {
  LicenseArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listLicenseVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArn — (String)

      Amazon Resource Name (ARN) of the license.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Licenses — (Array<map>)

        License details.

        • LicenseArn — (String)

          Amazon Resource Name (ARN) of the license.

        • LicenseName — (String)

          License name.

        • ProductName — (String)

          Product name.

        • ProductSKU — (String)

          Product SKU.

        • Issuer — (map)

          License issuer.

          • Name — (String)

            Issuer name.

          • SignKey — (String)

            Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint — (String)

            Issuer key fingerprint.

        • HomeRegion — (String)

          Home Region of the license.

        • Status — (String)

          License status.

          Possible values include:
          • "AVAILABLE"
          • "PENDING_AVAILABLE"
          • "DEACTIVATED"
          • "SUSPENDED"
          • "EXPIRED"
          • "PENDING_DELETE"
          • "DELETED"
        • Validity — (map)

          Date and time range during which the license is valid, in ISO8601-UTC format.

          • Begin — required — (String)

            Start of the time range.

          • End — (String)

            End of the time range.

        • Beneficiary — (String)

          License beneficiary.

        • Entitlements — (Array<map>)

          License entitlements.

          • Name — required — (String)

            Entitlement name.

          • Value — (String)

            Entitlement resource. Use only if the unit is None.

          • MaxCount — (Integer)

            Maximum entitlement count. Use if the unit is not None.

          • Overage — (Boolean)

            Indicates whether overages are allowed.

          • Unit — required — (String)

            Entitlement unit.

            Possible values include:
            • "Count"
            • "None"
            • "Seconds"
            • "Microseconds"
            • "Milliseconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"
          • AllowCheckIn — (Boolean)

            Indicates whether check-ins are allowed.

        • ConsumptionConfiguration — (map)

          Configuration for consumption of the license.

          • RenewType — (String)

            Renewal frequency.

            Possible values include:
            • "None"
            • "Weekly"
            • "Monthly"
          • ProvisionalConfiguration — (map)

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration — (map)

            Details about a borrow configuration.

            • AllowEarlyCheckIn — required — (Boolean)

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata — (Array<map>)

          License metadata.

          • Name — (String)

            The key name.

          • Value — (String)

            The value.

        • CreateTime — (String)

          License creation time.

        • Version — (String)

          License version.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists grants that are received but not accepted.

Service Reference:

Examples:

Calling the listReceivedGrants operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  GrantArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listReceivedGrants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GrantArns — (Array<String>)

      Amazon Resource Names (ARNs) of the grants.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters are supported:

      • ProductSKU

      • LicenseIssuerName

      • LicenseArn

      • GrantStatus

      • GranterAccountId

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grants — (Array<map>)

        Received grant details.

        • GrantArn — required — (String)

          Amazon Resource Name (ARN) of the grant.

        • GrantName — required — (String)

          Grant name.

        • ParentArn — required — (String)

          Parent ARN.

        • LicenseArn — required — (String)

          License ARN.

        • GranteePrincipalArn — required — (String)

          The grantee principal ARN.

        • HomeRegion — required — (String)

          Home Region of the grant.

        • GrantStatus — required — (String)

          Grant status.

          Possible values include:
          • "PENDING_WORKFLOW"
          • "PENDING_ACCEPT"
          • "REJECTED"
          • "ACTIVE"
          • "FAILED_WORKFLOW"
          • "DELETED"
          • "PENDING_DELETE"
          • "DISABLED"
          • "WORKFLOW_COMPLETED"
        • StatusReason — (String)

          Grant status reason.

        • Version — required — (String)

          Grant version.

        • GrantedOperations — required — (Array<String>)

          Granted operations.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists received licenses.

Service Reference:

Examples:

Calling the listReceivedLicenses operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listReceivedLicenses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseArns — (Array<String>)

      Amazon Resource Names (ARNs) of the licenses.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters are supported:

      • ProductSKU

      • Status

      • Fingerprint

      • IssuerName

      • Beneficiary

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Licenses — (Array<map>)

        Received license details.

        • LicenseArn — (String)

          Amazon Resource Name (ARN) of the license.

        • LicenseName — (String)

          License name.

        • ProductName — (String)

          Product name.

        • ProductSKU — (String)

          Product SKU.

        • Issuer — (map)

          Granted license issuer.

          • Name — (String)

            Issuer name.

          • SignKey — (String)

            Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.

          • KeyFingerprint — (String)

            Issuer key fingerprint.

        • HomeRegion — (String)

          Home Region of the granted license.

        • Status — (String)

          Granted license status.

          Possible values include:
          • "AVAILABLE"
          • "PENDING_AVAILABLE"
          • "DEACTIVATED"
          • "SUSPENDED"
          • "EXPIRED"
          • "PENDING_DELETE"
          • "DELETED"
        • Validity — (map)

          Date and time range during which the granted license is valid, in ISO8601-UTC format.

          • Begin — required — (String)

            Start of the time range.

          • End — (String)

            End of the time range.

        • Beneficiary — (String)

          Granted license beneficiary.

        • Entitlements — (Array<map>)

          License entitlements.

          • Name — required — (String)

            Entitlement name.

          • Value — (String)

            Entitlement resource. Use only if the unit is None.

          • MaxCount — (Integer)

            Maximum entitlement count. Use if the unit is not None.

          • Overage — (Boolean)

            Indicates whether overages are allowed.

          • Unit — required — (String)

            Entitlement unit.

            Possible values include:
            • "Count"
            • "None"
            • "Seconds"
            • "Microseconds"
            • "Milliseconds"
            • "Bytes"
            • "Kilobytes"
            • "Megabytes"
            • "Gigabytes"
            • "Terabytes"
            • "Bits"
            • "Kilobits"
            • "Megabits"
            • "Gigabits"
            • "Terabits"
            • "Percent"
            • "Bytes/Second"
            • "Kilobytes/Second"
            • "Megabytes/Second"
            • "Gigabytes/Second"
            • "Terabytes/Second"
            • "Bits/Second"
            • "Kilobits/Second"
            • "Megabits/Second"
            • "Gigabits/Second"
            • "Terabits/Second"
            • "Count/Second"
          • AllowCheckIn — (Boolean)

            Indicates whether check-ins are allowed.

        • ConsumptionConfiguration — (map)

          Configuration for consumption of the license.

          • RenewType — (String)

            Renewal frequency.

            Possible values include:
            • "None"
            • "Weekly"
            • "Monthly"
          • ProvisionalConfiguration — (map)

            Details about a provisional configuration.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the provisional configuration, in minutes.

          • BorrowConfiguration — (map)

            Details about a borrow configuration.

            • AllowEarlyCheckIn — required — (Boolean)

              Indicates whether early check-ins are allowed.

            • MaxTimeToLiveInMinutes — required — (Integer)

              Maximum time for the borrow configuration, in minutes.

        • LicenseMetadata — (Array<map>)

          Granted license metadata.

          • Name — (String)

            The key name.

          • Value — (String)

            The value.

        • CreateTime — (String)

          Creation time of the granted license.

        • Version — (String)

          Version of the granted license.

        • ReceivedMetadata — (map)

          Granted license received metadata.

          • ReceivedStatus — (String)

            Received status.

            Possible values include:
            • "PENDING_WORKFLOW"
            • "PENDING_ACCEPT"
            • "REJECTED"
            • "ACTIVE"
            • "FAILED_WORKFLOW"
            • "DELETED"
            • "DISABLED"
            • "WORKFLOW_COMPLETED"
          • ReceivedStatusReason — (String)

            Received status reason.

          • AllowedOperations — (Array<String>)

            Allowed operations.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists resources managed using Systems Manager inventory.

Service Reference:

Examples:

Calling the listResourceInventory operation

var params = {
  Filters: [
    {
      Condition: EQUALS | NOT_EQUALS | BEGINS_WITH | CONTAINS, /* required */
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listResourceInventory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • NextToken — (String)

      Token for the next set of results.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters and logical operators are supported:

      • account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

      • application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH.

      • license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

      • platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH.

      • resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS.

      • tag:<key> - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).

      • Name — required — (String)

        Name of the filter.

      • Condition — required — (String)

        Condition of the filter.

        Possible values include:
        • "EQUALS"
        • "NOT_EQUALS"
        • "BEGINS_WITH"
        • "CONTAINS"
      • Value — (String)

        Value of the filter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceInventoryList — (Array<map>)

        Information about the resources.

        • ResourceId — (String)

          ID of the resource.

        • ResourceType — (String)

          Type of resource.

          Possible values include:
          • "EC2_INSTANCE"
          • "EC2_HOST"
          • "EC2_AMI"
          • "RDS"
          • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
        • ResourceArn — (String)

          Amazon Resource Name (ARN) of the resource.

        • Platform — (String)

          Platform of the resource.

        • PlatformVersion — (String)

          Platform version of the resource in the inventory.

        • ResourceOwningAccountId — (String)

          ID of the account that owns the resource.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists the tags for the specified license configuration.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
licensemanager.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the license configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        Information about the tags.

        • Key — (String)

          Tag key.

        • Value — (String)

          Tag value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists your tokens.

Service Reference:

Examples:

Calling the listTokens operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TokenIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
licensemanager.listTokens(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • TokenIds — (Array<String>)

      Token IDs.

    • Filters — (Array<map>)

      Filters to scope the results. The following filter is supported:

      • LicenseArns

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

    • NextToken — (String)

      Token for the next set of results.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tokens — (Array<map>)

        Received token details.

        • TokenId — (String)

          Token ID.

        • TokenType — (String)

          Type of token generated. The supported value is REFRESH_TOKEN.

        • LicenseArn — (String)

          Amazon Resource Name (ARN) of the license.

        • ExpirationTime — (String)

          Token expiration time, in ISO8601-UTC format.

        • TokenProperties — (Array<String>)

          Data specified by the caller.

        • RoleArns — (Array<String>)

          Amazon Resource Names (ARN) of the roles included in the token.

        • Status — (String)

          Token status. The possible values are AVAILABLE and DELETED.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.

Service Reference:

Examples:

Calling the listUsageForLicenseConfiguration operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanager.listUsageForLicenseConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArn — (String)

      Amazon Resource Name (ARN) of the license configuration.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call.

    • NextToken — (String)

      Token for the next set of results.

    • Filters — (Array<map>)

      Filters to scope the results. The following filters and logical operators are supported:

      • resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS.

      • resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.

      • resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.

      • Name — (String)

        Name of the filter. Filter names are case-sensitive.

      • Values — (Array<String>)

        Filter values. Filter values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LicenseConfigurationUsageList — (Array<map>)

        Information about the license configurations.

        • ResourceArn — (String)

          Amazon Resource Name (ARN) of the resource.

        • ResourceType — (String)

          Type of resource.

          Possible values include:
          • "EC2_INSTANCE"
          • "EC2_HOST"
          • "EC2_AMI"
          • "RDS"
          • "SYSTEMS_MANAGER_MANAGED_INSTANCE"
        • ResourceStatus — (String)

          Status of the resource.

        • ResourceOwnerId — (String)

          ID of the account that owns the resource.

        • AssociationTime — (Date)

          Time when the license configuration was initially associated with the resource.

        • ConsumedLicenses — (Integer)

          Number of licenses consumed by the resource.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Rejects the specified grant.

Service Reference:

Examples:

Calling the rejectGrant operation

var params = {
  GrantArn: 'STRING_VALUE' /* required */
};
licensemanager.rejectGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GrantArn — (String)

      Amazon Resource Name (ARN) of the grant.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GrantArn — (String)

        Grant ARN.

      • Status — (String)

        Grant status.

        Possible values include:
        • "PENDING_WORKFLOW"
        • "PENDING_ACCEPT"
        • "REJECTED"
        • "ACTIVE"
        • "FAILED_WORKFLOW"
        • "DELETED"
        • "PENDING_DELETE"
        • "DISABLED"
        • "WORKFLOW_COMPLETED"
      • Version — (String)

        Grant version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Adds the specified tags to the specified license configuration.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
licensemanager.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the license configuration.

    • Tags — (Array<map>)

      One or more tags.

      • Key — (String)

        Tag key.

      • Value — (String)

        Tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Removes the specified tags from the specified license configuration.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
licensemanager.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the license configuration.

    • TagKeys — (Array<String>)

      Keys identifying the tags to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Modifies the attributes of an existing license configuration.

Service Reference:

Examples:

Calling the updateLicenseConfiguration operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DisassociateWhenNotFound: true || false,
  LicenseConfigurationStatus: AVAILABLE | DISABLED,
  LicenseCount: 'NUMBER_VALUE',
  LicenseCountHardLimit: true || false,
  LicenseRules: [
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE',
  ProductInformationList: [
    {
      ProductInformationFilterList: [ /* required */
        {
          ProductInformationFilterComparator: 'STRING_VALUE', /* required */
          ProductInformationFilterName: 'STRING_VALUE', /* required */
          ProductInformationFilterValue: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ],
      ResourceType: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
licensemanager.updateLicenseConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseConfigurationArn — (String)

      Amazon Resource Name (ARN) of the license configuration.

    • LicenseConfigurationStatus — (String)

      New status of the license configuration.

      Possible values include:
      • "AVAILABLE"
      • "DISABLED"
    • LicenseRules — (Array<String>)

      New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.

    • LicenseCount — (Integer)

      New number of licenses managed by the license configuration.

    • LicenseCountHardLimit — (Boolean)

      New hard limit of the number of available licenses.

    • Name — (String)

      New name of the license configuration.

    • Description — (String)

      New description of the license configuration.

    • ProductInformationList — (Array<map>)

      New product information.

      • ResourceType — required — (String)

        Resource type. The possible values are SSM_MANAGED | RDS.

      • ProductInformationFilterList — required — (Array<map>)

        A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on.

        Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator.

        The following filters and are supported when the resource type is SSM_MANAGED:

        • Application Name - The name of the application. Logical operator is EQUALS.

        • Application Publisher - The publisher of the application. Logical operator is EQUALS.

        • Application Version - The version of the application. Logical operator is EQUALS.

        • Platform Name - The name of the platform. Logical operator is EQUALS.

        • Platform Type - The platform type. Logical operator is EQUALS.

        • Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key.

        • AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS.

        • License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter.

        The following filters and logical operators are supported when the resource type is RDS:

        • Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2.

        • License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.

        • ProductInformationFilterName — required — (String)

          Filter name.

        • ProductInformationFilterValue — (Array<String>)

          Filter value.

        • ProductInformationFilterComparator — required — (String)

          Logical operator.

    • DisassociateWhenNotFound — (Boolean)

      When true, disassociates a resource when software is uninstalled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Updates a report generator.

After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.

Service Reference:

Examples:

Calling the updateLicenseManagerReportGenerator operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  LicenseManagerReportGeneratorArn: 'STRING_VALUE', /* required */
  ReportContext: { /* required */
    licenseConfigurationArns: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  ReportFrequency: { /* required */
    period: DAY | WEEK | MONTH,
    value: 'NUMBER_VALUE'
  },
  ReportGeneratorName: 'STRING_VALUE', /* required */
  Type: [ /* required */
    LicenseConfigurationSummaryReport | LicenseConfigurationUsageReport,
    /* more items */
  ],
  Description: 'STRING_VALUE'
};
licensemanager.updateLicenseManagerReportGenerator(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • LicenseManagerReportGeneratorArn — (String)

      Amazon Resource Name (ARN) of the report generator to update.

    • ReportGeneratorName — (String)

      Name of the report generator.

    • Type — (Array<String>)

      Type of reports to generate. The following report types are supported:

      • License configuration report - Reports the number and details of consumed licenses for a license configuration.

      • Resource report - Reports the tracked licenses and resource consumption for a license configuration.

    • ReportContext — (map)

      The report context.

      • licenseConfigurationArns — required — (Array<String>)

        Amazon Resource Name (ARN) of the license configuration that this generator reports on.

    • ReportFrequency — (map)

      Frequency by which reports are generated.

      • value — (Integer)

        Number of times within the frequency period that a report is generated. The only supported value is 1.

      • period — (String)

        Time period between each report. The period can be daily, weekly, or monthly.

        Possible values include:
        • "DAY"
        • "WEEK"
        • "MONTH"
    • ClientToken — (String)

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

    • Description — (String)

      Description of the report generator.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Adds or removes the specified license configurations for the specified Amazon Web Services resource.

You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.

Service Reference:

Examples:

Calling the updateLicenseSpecificationsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  AddLicenseSpecifications: [
    {
      LicenseConfigurationArn: 'STRING_VALUE', /* required */
      AmiAssociationScope: 'STRING_VALUE'
    },
    /* more items */
  ],
  RemoveLicenseSpecifications: [
    {
      LicenseConfigurationArn: 'STRING_VALUE', /* required */
      AmiAssociationScope: 'STRING_VALUE'
    },
    /* more items */
  ]
};
licensemanager.updateLicenseSpecificationsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the Amazon Web Services resource.

    • AddLicenseSpecifications — (Array<map>)

      ARNs of the license configurations to add.

      • LicenseConfigurationArn — required — (String)

        Amazon Resource Name (ARN) of the license configuration.

      • AmiAssociationScope — (String)

        Scope of AMI associations. The possible value is cross-account.

    • RemoveLicenseSpecifications — (Array<map>)

      ARNs of the license configurations to remove.

      • LicenseConfigurationArn — required — (String)

        Amazon Resource Name (ARN) of the license configuration.

      • AmiAssociationScope — (String)

        Scope of AMI associations. The possible value is cross-account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

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

Updates License Manager settings for the current Region.

Service Reference:

Examples:

Calling the updateServiceSettings operation

var params = {
  EnableCrossAccountsDiscovery: true || false,
  OrganizationConfiguration: {
    EnableIntegration: true || false /* required */
  },
  S3BucketArn: 'STRING_VALUE',
  SnsTopicArn: 'STRING_VALUE'
};
licensemanager.updateServiceSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • S3BucketArn — (String)

      Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.

    • SnsTopicArn — (String)

      Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.

    • OrganizationConfiguration — (map)

      Enables integration with Organizations for cross-account discovery.

      • EnableIntegration — required — (Boolean)

        Enables Organizations integration.

    • EnableCrossAccountsDiscovery — (Boolean)

      Activates cross-account discovery.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.