AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

This is the AWS License Manager API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for License Manager. The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

Sending a Request Using LicenseManager

var licensemanager = new AWS.LicenseManager();
licensemanager.createLicenseConfiguration(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)

    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'.

  • 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.

  • 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.
  • 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)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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

endpointAWS.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

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

Creates a new license configuration object. 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), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), 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',
  LicenseCount: 'NUMBER_VALUE',
  LicenseCountHardLimit: true || false,
  LicenseRules: [
    'STRING_VALUE',
    /* 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)

      Human-friendly description of the license configuration.

    • LicenseCountingType — (String)

      Dimension to use to track the license inventory.

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

      Number of licenses managed by the license configuration.

    • LicenseCountHardLimit — (Boolean)

      Flag indicating whether hard or soft license enforcement is used. Exceeding a hard limit results in the blocked deployment of new instances.

    • LicenseRules — (Array<String>)

      Array of configured License Manager rules.

    • Tags — (Array<map>)

      The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .

      • Key — (String)

        Key for the resource tag.

      • Value — (String)

        Value for the resource tag.

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)

        ARN of the license configuration object after its creation.

Returns:

  • (AWS.Request)

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

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

Deletes an existing license configuration. This action fails if the configuration 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)

      Unique ID of the configuration object to delete.

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.

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

Returns a detailed description of a 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)

      ARN of the license configuration being requested.

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)

        ARN of the license configuration requested.

      • Name — (String)

        Name of the license configuration.

      • Description — (String)

        Description of the license configuration.

      • LicenseCountingType — (String)

        Dimension on which the licenses are counted (for example, instances, cores, sockets, or VCPUs).

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

        List of flexible text strings designating 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 (active, etc.).

      • OwnerAccountId — (String)

        Owner account ID for the license configuration.

      • ConsumedLicenseSummaryList — (Array<map>)

        List of summaries for consumed licenses used by various resources.

        • ResourceType — (String)

          Resource type of the resource consuming a license (instance, host, or AMI).

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

          Number of licenses consumed by a resource.

      • ManagedResourceSummaryList — (Array<map>)

        List of summaries of managed resources.

        • ResourceType — (String)

          Type of resource associated with a license (instance, host, or AMI).

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

          Number of resources associated with licenses.

      • Tags — (Array<map>)

        List of tags attached to the license configuration.

        • Key — (String)

          Key for the resource tag.

        • Value — (String)

          Value for the resource tag.

Returns:

  • (AWS.Request)

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

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

Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection.

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, etc.

      • SnsTopicArn — (String)

        SNS topic configured to receive notifications from License Manager.

      • OrganizationConfiguration — (map)

        Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.

        • EnableIntegrationrequired — (Boolean)

          Flag to activate AWS Organization integration.

      • EnableCrossAccountsDiscovery — (Boolean)

        Indicates whether cross-account discovery has been enabled.

Returns:

  • (AWS.Request)

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

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

Lists the resource associations for a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration.

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)

      ARN of a LicenseConfiguration object.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • 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>)

        Lists association objects for the license configuration, each containing the association time, number of consumed licenses, resource ARN, resource ID, account ID that owns the resource, resource size, and resource type.

        • ResourceArn — (String)

          ARN of the resource associated with the license configuration.

        • ResourceType — (String)

          Type of server resource.

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

          ID of the AWS account that owns the resource consuming licenses.

        • AssociationTime — (Date)

          Time when the license configuration was associated with 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.

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

Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.

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>)

      An array of ARNs for the calling account’s license configurations.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      Token for the next set of results.

    • Filters — (Array<map>)

      One or more filters.

      • Name — (String)

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

      • Values — (Array<String>)

        One or more 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>)

        Array of license configuration objects.

        • LicenseConfigurationId — (String)

          Unique ID of the LicenseConfiguration object.

        • LicenseConfigurationArn — (String)

          ARN of the LicenseConfiguration object.

        • Name — (String)

          Name of the license configuration.

        • Description — (String)

          Description of the license configuration.

        • LicenseCountingType — (String)

          Dimension to use to track license inventory.

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

          Array of configured License Manager rules.

        • LicenseCount — (Integer)

          Number of licenses managed by the license configuration.

        • LicenseCountHardLimit — (Boolean)

          Sets the number of available licenses as a hard limit.

        • 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>)

          List of summaries for licenses consumed by various resources.

          • ResourceType — (String)

            Resource type of the resource consuming a license (instance, host, or AMI).

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

            Number of licenses consumed by a resource.

        • ManagedResourceSummaryList — (Array<map>)

          List of summaries for managed resources.

          • ResourceType — (String)

            Type of resource associated with a license (instance, host, or AMI).

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

            Number of resources associated with licenses.

      • 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

Returns the license configuration for a resource.

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)

      ARN of an AMI or Amazon EC2 instance that has an associated license configuration.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • 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.

        • LicenseConfigurationArnrequired — (String)

          ARN of the LicenseConfiguration object.

      • 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

Returns a detailed list of resources.

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. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      Token for the next set of results.

    • Filters — (Array<map>)

      One or more filters.

      • Namerequired — (String)

        The name of the filter.

      • Conditionrequired — (String)

        The 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>)

        The detailed list of resources.

        • ResourceId — (String)

          Unique ID of the resource.

        • ResourceType — (String)

          The type of resource.

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

          The ARN of the resource.

        • Platform — (String)

          The platform of the resource.

        • PlatformVersion — (String)

          Platform version of the resource in the inventory.

        • ResourceOwningAccountId — (String)

          Unique 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 tags attached to a resource.

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)

      ARN for the resource.

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>)

        List of tags attached to the resource.

        • Key — (String)

          Key for the resource tag.

        • Value — (String)

          Value for the resource tag.

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.

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)

      ARN of the targeted LicenseConfiguration object.

    • MaxResults — (Integer)

      Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      Token for the next set of results.

    • Filters — (Array<map>)

      List of filters to apply.

      • Name — (String)

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

      • Values — (Array<String>)

        One or more 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>)

        An array of LicenseConfigurationUsage objects.

        • ResourceArn — (String)

          ARN of the resource associated with a license configuration.

        • ResourceType — (String)

          Type of resource associated with athe license configuration.

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

          Status of a resource associated with the license configuration.

        • ResourceOwnerId — (String)

          ID of the account that owns a resource that is associated with the license configuration.

        • AssociationTime — (Date)

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

        • ConsumedLicenses — (Integer)

          Number of licenses consumed out of the total provisioned in the license configuration.

      • NextToken — (String)

        Token for the next set of results.

Returns:

  • (AWS.Request)

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

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

Attach one of more tags to any resource.

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)

      Resource of the ARN to be tagged.

    • Tags — (Array<map>)

      Names of the tags to attach to the resource.

      • Key — (String)

        Key for the resource tag.

      • Value — (String)

        Value for the resource tag.

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

Remove tags from a resource.

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)

      ARN of the resource.

    • TagKeys — (Array<String>)

      List keys identifying 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 object. 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 (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used.

Service Reference:

Examples:

Calling the updateLicenseConfiguration operation

var params = {
  LicenseConfigurationArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  LicenseConfigurationStatus: AVAILABLE | DISABLED,
  LicenseCount: 'NUMBER_VALUE',
  LicenseCountHardLimit: true || false,
  LicenseRules: [
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE'
};
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)

      ARN for a license configuration.

    • LicenseConfigurationStatus — (String)

      New status of the license configuration (ACTIVE or INACTIVE).

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

      List of flexible text strings designating license rules.

    • LicenseCount — (Integer)

      New number of licenses managed by the license configuration.

    • LicenseCountHardLimit — (Boolean)

      Sets the number of available licenses as a hard limit.

    • Name — (String)

      New name of the license configuration.

    • Description — (String)

      New human-friendly description 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.

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

Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as RunInstances.

Examples:

Calling the updateLicenseSpecificationsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  AddLicenseSpecifications: [
    {
      LicenseConfigurationArn: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  RemoveLicenseSpecifications: [
    {
      LicenseConfigurationArn: 'STRING_VALUE' /* required */
    },
    /* 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)

      ARN for an AWS server resource.

    • AddLicenseSpecifications — (Array<map>)

      License configuration ARNs to be added to a resource.

      • LicenseConfigurationArnrequired — (String)

        ARN of the LicenseConfiguration object.

    • RemoveLicenseSpecifications — (Array<map>)

      License configuration ARNs to be removed from a resource.

      • LicenseConfigurationArnrequired — (String)

        ARN of the LicenseConfiguration object.

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 service settings.

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)

      ARN of the Amazon S3 bucket where License Manager information is stored.

    • SnsTopicArn — (String)

      ARN of the Amazon SNS topic used for License Manager alerts.

    • OrganizationConfiguration — (map)

      Integrates AWS Organizations with License Manager for cross-account discovery.

      • EnableIntegrationrequired — (Boolean)

        Flag to activate AWS Organization 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.