We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.LicenseManagerLinuxSubscriptions

Inherits:
AWS.Service
  • Object
show all
Identifier:
licensemanagerlinuxsubscriptions
API Version:
2018-05-10
Defined in:
(unknown)

Overview

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

Service Description

With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances.

Sending a Request Using LicenseManagerLinuxSubscriptions

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

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

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

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

var licensemanagerlinuxsubscriptions = new AWS.LicenseManagerLinuxSubscriptions();

Version:

  • 2018-05-10

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.LicenseManagerLinuxSubscriptions(options = {}) ⇒ Object

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

Examples:

Constructing a LicenseManagerLinuxSubscriptions object

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

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.LicenseManagerLinuxSubscriptions.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.LicenseManagerLinuxSubscriptions.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'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account.

Service Reference:

Examples:

Calling the deregisterSubscriptionProvider operation

var params = {
  SubscriptionProviderArn: 'STRING_VALUE' /* required */
};
licensemanagerlinuxsubscriptions.deregisterSubscriptionProvider(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: {}) —
    • SubscriptionProviderArn — (String)

      The Amazon Resource Name (ARN) of the subscription provider resource to deregister.

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.

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

Get details for a Bring Your Own License (BYOL) subscription that's registered to your account.

Service Reference:

Examples:

Calling the getRegisteredSubscriptionProvider operation

var params = {
  SubscriptionProviderArn: 'STRING_VALUE' /* required */
};
licensemanagerlinuxsubscriptions.getRegisteredSubscriptionProvider(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: {}) —
    • SubscriptionProviderArn — (String)

      The Amazon Resource Name (ARN) of the BYOL registration resource to get details for.

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:

      • LastSuccessfulDataRetrievalTime — (String)

        The timestamp from the last time License Manager retrieved subscription details from your registered third-party Linux subscription provider.

      • SecretArn — (String)

        The Amazon Resource Name (ARN) of the third-party access secret stored in Secrets Manager for the BYOL registration resource specified in the request.

      • SubscriptionProviderArn — (String)

        The Amazon Resource Name (ARN) for the BYOL registration resource specified in the request.

      • SubscriptionProviderSource — (String)

        The subscription provider for the BYOL registration resource specified in the request.

        Possible values include:
        • "RedHat"
      • SubscriptionProviderStatus — (String)

        The status of the Linux subscription provider access token from the last successful subscription data request.

        Possible values include:
        • "ACTIVE"
        • "INVALID"
        • "PENDING"
      • SubscriptionProviderStatusMessage — (String)

        The detailed message from your subscription provider token status.

Returns:

  • (AWS.Request) —

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

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

Lists the Linux subscriptions service settings for your account.

Service Reference:

Examples:

Calling the getServiceSettings operation

var params = {
};
licensemanagerlinuxsubscriptions.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:

      • HomeRegions — (Array<String>)

        The Region in which License Manager displays the aggregated data for Linux subscriptions.

      • LinuxSubscriptionsDiscovery — (String)

        Lists if discovery has been enabled for Linux subscriptions.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • LinuxSubscriptionsDiscoverySettings — (map)

        Lists the settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

        • OrganizationIntegration — required — (String)

          Details if you have enabled resource discovery across your accounts in Organizations.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • SourceRegions — required — (Array<String>)

          The Regions in which to discover data for Linux subscriptions.

      • Status — (String)

        Indicates the status of Linux subscriptions settings being applied.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Successful"
        • "Failed"
      • StatusMessage — (map<String>)

        A message which details the Linux subscriptions service settings current status.

Returns:

  • (AWS.Request) —

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

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

Lists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.

Service Reference:

Examples:

Calling the listLinuxSubscriptionInstances operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Operator: Equal | NotEqual | Contains,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanagerlinuxsubscriptions.listLinuxSubscriptionInstances(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>)

      An array of structures that you can use to filter the results by your specified criteria. For example, you can specify Region in the Name, with the contains operator to list all subscriptions that match a partial string in the Value, such as us-west.

      For each filter, you can specify one of the following values for the Name key to streamline results:

      • AccountID

      • AmiID

      • DualSubscription

      • InstanceID

      • InstanceType

      • ProductCode

      • Region

      • Status

      • UsageOperation

      For each filter, you can use one of the following Operator values to define the behavior of the filter:

      • contains

      • equals

      • Notequal

      • Name — (String)

        The type of name to filter by.

      • Operator — (String)

        An operator for filtering results.

        Possible values include:
        • "Equal"
        • "NotEqual"
        • "Contains"
      • Values — (Array<String>)

        One or more values for the name to filter by.

    • MaxResults — (Integer)

      The maximum items to return in a request.

    • NextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • Instances — (Array<map>)

        An array that contains instance objects.

        • AccountID — (String)

          The account ID which owns the instance.

        • AmiId — (String)

          The AMI ID used to launch the instance.

        • DualSubscription — (String)

          Indicates that you have two different license subscriptions for the same software on your instance.

        • InstanceID — (String)

          The instance ID of the resource.

        • InstanceType — (String)

          The instance type of the resource.

        • LastUpdatedTime — (String)

          The time in which the last discovery updated the instance details.

        • OsVersion — (String)

          The operating system software version that runs on your instance.

        • ProductCode — (Array<String>)

          The product code for the instance. For more information, see Usage operation values in the License Manager User Guide .

        • Region — (String)

          The Region the instance is running in.

        • RegisteredWithSubscriptionProvider — (String)

          Indicates that your instance uses a BYOL license subscription from a third-party Linux subscription provider that you've registered with License Manager.

        • Status — (String)

          The status of the instance.

        • SubscriptionName — (String)

          The name of the license subscription that the instance uses.

        • SubscriptionProviderCreateTime — (String)

          The timestamp when you registered the third-party Linux subscription provider for the subscription that the instance uses.

        • SubscriptionProviderUpdateTime — (String)

          The timestamp from the last time that the instance synced with the registered third-party Linux subscription provider.

        • UsageOperation — (String)

          The usage operation of the instance. For more information, see For more information, see Usage operation values in the License Manager User Guide.

      • NextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request) —

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

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

Lists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.

Service Reference:

Examples:

Calling the listLinuxSubscriptions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Operator: Equal | NotEqual | Contains,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
licensemanagerlinuxsubscriptions.listLinuxSubscriptions(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>)

      An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of Subscription with an optional operator to see subscriptions that match, partially match, or don't match a certain subscription's name.

      The valid names for this filter are:

      • Subscription

      The valid Operators for this filter are:

      • contains

      • equals

      • Notequal

      • Name — (String)

        The type of name to filter by.

      • Operator — (String)

        An operator for filtering results.

        Possible values include:
        • "Equal"
        • "NotEqual"
        • "Contains"
      • Values — (Array<String>)

        One or more values for the name to filter by.

    • MaxResults — (Integer)

      The maximum items to return in a request.

    • NextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • NextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

      • Subscriptions — (Array<map>)

        An array that contains subscription objects.

        • InstanceCount — (Integer)

          The total amount of running instances using this subscription.

        • Name — (String)

          The name of the subscription.

        • Type — (String)

          The type of subscription. The type can be subscription-included with Amazon EC2, Bring Your Own Subscription model (BYOS), or from the Amazon Web Services Marketplace. Certain subscriptions may use licensing from the Amazon Web Services Marketplace as well as OS licensing from Amazon EC2 or BYOS.

Returns:

  • (AWS.Request) —

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

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

List Bring Your Own License (BYOL) subscription registration resources for your account.

Service Reference:

Examples:

Calling the listRegisteredSubscriptionProviders operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SubscriptionProviderSources: [
    RedHat,
    /* more items */
  ]
};
licensemanagerlinuxsubscriptions.listRegisteredSubscriptionProviders(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)

      The maximum items to return in a request.

    • NextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    • SubscriptionProviderSources — (Array<String>)

      To filter your results, specify which subscription providers to return in the list.

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:

      • NextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

      • RegisteredSubscriptionProviders — (Array<map>)

        The list of BYOL registration resources that fit the criteria you specified in the request.

        • LastSuccessfulDataRetrievalTime — (String)

          The timestamp from the last time that License Manager accessed third-party subscription data for your account from your registered Linux subscription provider.

        • SecretArn — (String)

          The Amazon Resource Name (ARN) of the Secrets Manager secret that stores your registered Linux subscription provider access token. For RHEL account subscriptions, this is the offline token.

        • SubscriptionProviderArn — (String)

          The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

        • SubscriptionProviderSource — (String)

          A supported third-party Linux subscription provider. License Manager currently supports Red Hat subscriptions.

          Possible values include:
          • "RedHat"
        • SubscriptionProviderStatus — (String)

          Indicates the status of your registered Linux subscription provider access token from the last time License Manager retrieved subscription data. For RHEL account subscriptions, this is the status of the offline token.

          Possible values include:
          • "ACTIVE"
          • "INVALID"
          • "PENDING"
        • SubscriptionProviderStatusMessage — (String)

          A detailed message that's associated with your BYOL subscription provider token status.

Returns:

  • (AWS.Request) —

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

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

List the metadata tags that are assigned to the specified Amazon Web Services resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
licensemanagerlinuxsubscriptions.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)

      The Amazon Resource Name (ARN) of the resource for which to list metadata tags.

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 — (map<String>)

        The metadata tags for the requested resource.

Returns:

  • (AWS.Request) —

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

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

Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription.

Service Reference:

Examples:

Calling the registerSubscriptionProvider operation

var params = {
  SecretArn: 'STRING_VALUE', /* required */
  SubscriptionProviderSource: RedHat, /* required */
  Tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
licensemanagerlinuxsubscriptions.registerSubscriptionProvider(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: {}) —
    • SecretArn — (String)

      The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token.

    • SubscriptionProviderSource — (String)

      The supported Linux subscription provider to register.

      Possible values include:
      • "RedHat"
    • Tags — (map<String>)

      The metadata tags to assign to your registered Linux subscription provider 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:

      • SubscriptionProviderArn — (String)

        The Amazon Resource Name (ARN) of the Linux subscription provider resource that you registered.

      • SubscriptionProviderSource — (String)

        The Linux subscription provider that you registered.

        Possible values include:
        • "RedHat"
      • SubscriptionProviderStatus — (String)

        Indicates the status of the registration action for the Linux subscription provider that you requested.

        Possible values include:
        • "ACTIVE"
        • "INVALID"
        • "PENDING"

Returns:

  • (AWS.Request) —

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

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

Add metadata tags to the specified Amazon Web Services resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
licensemanagerlinuxsubscriptions.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)

      The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags.

    • tags — (map<String>)

      The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs.

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 one or more metadata tag from the specified Amazon Web Services resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
licensemanagerlinuxsubscriptions.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)

      The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from.

    • tagKeys — (Array<String>)

      A list of metadata tag keys to remove from the requested 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.

Returns:

  • (AWS.Request) —

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

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

Updates the service settings for Linux subscriptions.

Service Reference:

Examples:

Calling the updateServiceSettings operation

var params = {
  LinuxSubscriptionsDiscovery: Enabled | Disabled, /* required */
  LinuxSubscriptionsDiscoverySettings: { /* required */
    OrganizationIntegration: Enabled | Disabled, /* required */
    SourceRegions: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  AllowUpdate: true || false
};
licensemanagerlinuxsubscriptions.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: {}) —
    • AllowUpdate — (Boolean)

      Describes if updates are allowed to the service settings for Linux subscriptions. If you allow updates, you can aggregate Linux subscription data in more than one home Region.

    • LinuxSubscriptionsDiscovery — (String)

      Describes if the discovery of Linux subscriptions is enabled.

      Possible values include:
      • "Enabled"
      • "Disabled"
    • LinuxSubscriptionsDiscoverySettings — (map)

      The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

      • OrganizationIntegration — required — (String)

        Details if you have enabled resource discovery across your accounts in Organizations.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • SourceRegions — required — (Array<String>)

        The Regions in which to discover data for Linux subscriptions.

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:

      • HomeRegions — (Array<String>)

        The Region in which License Manager displays the aggregated data for Linux subscriptions.

      • LinuxSubscriptionsDiscovery — (String)

        Lists if discovery has been enabled for Linux subscriptions.

        Possible values include:
        • "Enabled"
        • "Disabled"
      • LinuxSubscriptionsDiscoverySettings — (map)

        The settings defined for Linux subscriptions discovery. The settings include if Organizations integration has been enabled, and which Regions data will be aggregated from.

        • OrganizationIntegration — required — (String)

          Details if you have enabled resource discovery across your accounts in Organizations.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • SourceRegions — required — (Array<String>)

          The Regions in which to discover data for Linux subscriptions.

      • Status — (String)

        Indicates the status of Linux subscriptions settings being applied.

        Possible values include:
        • "InProgress"
        • "Completed"
        • "Successful"
        • "Failed"
      • StatusMessage — (map<String>)

        A message which details the Linux subscriptions service settings current status.

Returns:

  • (AWS.Request) —

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