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

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

Overview

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

Service Description

Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.

For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.

Amazon Managed Service for Prometheus includes two APIs.

  • Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert managers.

  • Use the Prometheus-compatible API to work within your Prometheus workspace.

Sending a Request Using Amp

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

var amp = new AWS.Amp({apiVersion: '2020-08-01'});

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

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

var amp = new AWS.Amp();

Version:

  • 2020-08-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

scraperActive, scraperDeleted, workspaceActive, workspaceDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Amp object

var amp = new AWS.Amp({apiVersion: '2020-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.Amp.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

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

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

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.

Service Reference:

Examples:

Calling the createAlertManagerDefinition operation

var params = {
  data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.createAlertManagerDefinition(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • data — (Buffer, Typed Array, Blob, String)

      The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file.

      For details about the alert manager definition, see AlertManagedDefinitionData.

    • workspaceId — (String)

      The ID of the workspace to add the alert manager definition 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:

      • status — (map)

        A structure that displays the current status of the alert manager definition.

        • statusCoderequired — (String)

          The current status of the alert manager.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
          • "UPDATE_FAILED"
        • statusReason — (String)

          If there is a failure, the reason for the failure.

Returns:

  • (AWS.Request)

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

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

The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

Service Reference:

Examples:

Calling the createLoggingConfiguration operation

var params = {
  logGroupArn: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.createLoggingConfiguration(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • logGroupArn — (String)

      The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this API.

    • workspaceId — (String)

      The ID of the workspace to create the logging configuration 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:

      • status — (map)

        A structure that displays the current status of the logging configuration.

        • statusCoderequired — (String)

          The current status of the logging configuration.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
          • "UPDATE_FAILED"
        • statusReason — (String)

          If failed, the reason for the failure.

Returns:

  • (AWS.Request)

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

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

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

Service Reference:

Examples:

Calling the createRuleGroupsNamespace operation

var params = {
  data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  name: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
amp.createRuleGroupsNamespace(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • data — (Buffer, Typed Array, Blob, String)

      The rules file to use in the new namespace.

      Contains the base64-encoded version of the YAML rules file.

      For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

    • name — (String)

      The name for the new rule groups namespace.

    • tags — (map<String>)

      The list of tag keys and values to associate with the rule groups namespace.

    • workspaceId — (String)

      The ID of the workspace to add the rule groups namespace.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the new rule groups namespace.

      • name — (String)

        The name of the new rule groups namespace.

      • status — (map)

        A structure that returns the current status of the rule groups namespace.

        • statusCoderequired — (String)

          The current status of the namespace.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
          • "UPDATE_FAILED"
        • statusReason — (String)

          The reason for the failure, if any.

      • tags — (map<String>)

        The list of tag keys and values that are associated with the namespace.

Returns:

  • (AWS.Request)

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

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

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.

If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide.

You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.

The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file.

Note: For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.

Service Reference:

Examples:

Calling the createScraper operation

var params = {
  destination: { /* required */
    ampConfiguration: {
      workspaceArn: 'STRING_VALUE' /* required */
    }
  },
  scrapeConfiguration: { /* required */
    configurationBlob: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
  },
  source: { /* required */
    eksConfiguration: {
      clusterArn: 'STRING_VALUE', /* required */
      subnetIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      securityGroupIds: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
amp.createScraper(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: {})
    • alias — (String)

      (optional) a name to associate with the scraper. This is for your use, and does not need to be unique.

    • clientToken — (String)

      (Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • destination — (map)

      The Amazon Managed Service for Prometheus workspace to send metrics to.

      • ampConfiguration — (map)

        The Amazon Managed Service for Prometheusworkspace to send metrics to.

        • workspaceArnrequired — (String)

          ARN of the Amazon Managed Service for Prometheus workspace.

    • scrapeConfiguration — (map)

      The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

      • configurationBlob — (Buffer, Typed Array, Blob, String)

        The base 64 encoded scrape configuration file.

    • source — (map)

      The Amazon EKS cluster from which the scraper will collect metrics.

      • eksConfiguration — (map)

        The Amazon EKS cluster from which a scraper collects metrics.

        • clusterArnrequired — (String)

          ARN of the Amazon EKS cluster.

        • securityGroupIds — (Array<String>)

          A list of the security group IDs for the Amazon EKS cluster VPC configuration.

        • subnetIdsrequired — (Array<String>)

          A list of subnet IDs for the Amazon EKS cluster VPC configuration.

    • tags — (map<String>)

      (Optional) The list of tag keys and values to associate with the scraper.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the new scraper.

      • scraperId — (String)

        The ID of the new scraper.

      • status — (map)

        A structure that displays the current status of the scraper.

        • statusCoderequired — (String)

          The current status of the scraper.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "CREATION_FAILED"
          • "DELETION_FAILED"
      • tags — (map<String>)

        The list of tag keys and values that are associated with the scraper.

Returns:

  • (AWS.Request)

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

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

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

Service Reference:

Examples:

Calling the createWorkspace operation

var params = {
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  kmsKeyArn: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
amp.createWorkspace(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: {})
    • alias — (String)

      An alias that you assign to this workspace to help you identify it. It does not need to be unique.

      Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

    • clientToken — (String)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • kmsKeyArn — (String)

      (optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

    • tags — (map<String>)

      The list of tag keys and values to associate with the workspace.

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:

      • arn — (String)

        The ARN for the new workspace.

      • kmsKeyArn — (String)

        (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

      • status — (map)

        The current status of the new workspace. Immediately after you create the workspace, the status is usually CREATING.

        • statusCoderequired — (String)

          The current status of the workspace.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
      • tags — (map<String>)

        The list of tag keys and values that are associated with the workspace.

      • workspaceId — (String)

        The unique ID for the new workspace.

Returns:

  • (AWS.Request)

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

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

Deletes the alert manager definition from a workspace.

Service Reference:

Examples:

Calling the deleteAlertManagerDefinition operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.deleteAlertManagerDefinition(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • workspaceId — (String)

      The ID of the workspace to delete the alert manager definition from.

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.

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

Deletes the logging configuration for a workspace.

Service Reference:

Examples:

Calling the deleteLoggingConfiguration operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.deleteLoggingConfiguration(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • workspaceId — (String)

      The ID of the workspace containing the logging configuration 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.

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

Deletes one rule groups namespace and its associated rule groups definition.

Service Reference:

Examples:

Calling the deleteRuleGroupsNamespace operation

var params = {
  name: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.deleteRuleGroupsNamespace(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • name — (String)

      The name of the rule groups namespace to delete.

    • workspaceId — (String)

      The ID of the workspace containing the rule groups namespace and definition 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.

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

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

Service Reference:

Examples:

Calling the deleteScraper operation

var params = {
  scraperId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.deleteScraper(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)

      (Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • scraperId — (String)

      The ID of the scraper 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. The data object has the following properties:

      • scraperId — (String)

        The ID of the scraper to delete.

      • status — (map)

        The current status of the scraper.

        • statusCoderequired — (String)

          The current status of the scraper.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "DELETING"
          • "CREATION_FAILED"
          • "DELETION_FAILED"

Returns:

  • (AWS.Request)

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

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

Deletes an existing workspace.

Note: When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

Service Reference:

Examples:

Calling the deleteWorkspace operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.deleteWorkspace(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • workspaceId — (String)

      The ID of the workspace 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.

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

Retrieves the full information about the alert manager definition for a workspace.

Service Reference:

Examples:

Calling the describeAlertManagerDefinition operation

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

      The ID of the workspace to retrieve the alert manager definition from.

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:

      • alertManagerDefinition — (map)

        The alert manager definition.

        • createdAtrequired — (Date)

          The date and time that the alert manager definition was created.

        • datarequired — (Buffer, Typed Array, Blob, String)

          The actual alert manager definition.

          For details about the alert manager definition, see AlertManagedDefinitionData.

        • modifiedAtrequired — (Date)

          The date and time that the alert manager definition was most recently changed.

        • statusrequired — (map)

          A structure that displays the current status of the alert manager definition..

          • statusCoderequired — (String)

            The current status of the alert manager.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
            • "UPDATE_FAILED"
          • statusReason — (String)

            If there is a failure, the reason for the failure.

Returns:

  • (AWS.Request)

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

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

Returns complete information about the current logging configuration of the workspace.

Service Reference:

Examples:

Calling the describeLoggingConfiguration operation

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

      The ID of the workspace to describe the logging configuration 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:

      • loggingConfiguration — (map)

        A structure that displays the information about the logging configuration.

        • createdAtrequired — (Date)

          The date and time that the logging configuration was created.

        • logGroupArnrequired — (String)

          The ARN of the CloudWatch log group to which the vended log data will be published.

        • modifiedAtrequired — (Date)

          The date and time that the logging configuration was most recently changed.

        • statusrequired — (map)

          The current status of the logging configuration.

          • statusCoderequired — (String)

            The current status of the logging configuration.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
            • "UPDATE_FAILED"
          • statusReason — (String)

            If failed, the reason for the failure.

        • workspacerequired — (String)

          The ID of the workspace the logging configuration is for.

Returns:

  • (AWS.Request)

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

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

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

Service Reference:

Examples:

Calling the describeRuleGroupsNamespace operation

var params = {
  name: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE' /* required */
};
amp.describeRuleGroupsNamespace(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)

      The name of the rule groups namespace that you want information for.

    • workspaceId — (String)

      The ID of the workspace containing the rule groups namespace.

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:

      • ruleGroupsNamespace — (map)

        The information about the rule groups namespace.

        • arnrequired — (String)

          The ARN of the rule groups namespace.

        • createdAtrequired — (Date)

          The date and time that the rule groups namespace was created.

        • datarequired — (Buffer, Typed Array, Blob, String)

          The rule groups file used in the namespace.

          For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

        • modifiedAtrequired — (Date)

          The date and time that the rule groups namespace was most recently changed.

        • namerequired — (String)

          The name of the rule groups namespace.

        • statusrequired — (map)

          The current status of the rule groups namespace.

          • statusCoderequired — (String)

            The current status of the namespace.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
            • "UPDATE_FAILED"
          • statusReason — (String)

            The reason for the failure, if any.

        • tags — (map<String>)

          The list of tag keys and values that are associated with the rule groups namespace.

Returns:

  • (AWS.Request)

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

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

The DescribeScraper operation displays information about an existing scraper.

Service Reference:

Examples:

Calling the describeScraper operation

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

      The ID of the scraper to describe.

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:

      • scraper — (map)

        Contains details about the scraper.

        • alias — (String)

          (Optional) A name associated with the scraper.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the scraper.

        • createdAtrequired — (Date)

          The date and time that the scraper was created.

        • destinationrequired — (map)

          The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

          • ampConfiguration — (map)

            The Amazon Managed Service for Prometheusworkspace to send metrics to.

            • workspaceArnrequired — (String)

              ARN of the Amazon Managed Service for Prometheus workspace.

        • lastModifiedAtrequired — (Date)

          The date and time that the scraper was last modified.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

        • scrapeConfigurationrequired — (map)

          The configuration file in use by the scraper.

          • configurationBlob — (Buffer, Typed Array, Blob, String)

            The base 64 encoded scrape configuration file.

        • scraperIdrequired — (String)

          The ID of the scraper.

        • sourcerequired — (map)

          The Amazon EKS cluster from which the scraper collects metrics.

          • eksConfiguration — (map)

            The Amazon EKS cluster from which a scraper collects metrics.

            • clusterArnrequired — (String)

              ARN of the Amazon EKS cluster.

            • securityGroupIds — (Array<String>)

              A list of the security group IDs for the Amazon EKS cluster VPC configuration.

            • subnetIdsrequired — (Array<String>)

              A list of subnet IDs for the Amazon EKS cluster VPC configuration.

        • statusrequired — (map)

          A structure that contains the current status of the scraper.

          • statusCoderequired — (String)

            The current status of the scraper.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "DELETING"
            • "CREATION_FAILED"
            • "DELETION_FAILED"
        • statusReason — (String)

          If there is a failure, the reason for the failure.

        • tags — (map<String>)

          (Optional) The list of tag keys and values associated with the scraper.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

Returns information about an existing workspace.

Service Reference:

Examples:

Calling the describeWorkspace operation

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

      The ID of the workspace to describe.

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:

      • workspace — (map)

        A structure that contains details about the workspace.

        • alias — (String)

          The alias that is assigned to this workspace to help identify it. It may not be unique.

        • arnrequired — (String)

          The ARN of the workspace.

        • createdAtrequired — (Date)

          The date and time that the workspace was created.

        • kmsKeyArn — (String)

          (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

        • prometheusEndpoint — (String)

          The Prometheus endpoint available for this workspace.

        • statusrequired — (map)

          The current status of the workspace.

          • statusCoderequired — (String)

            The current status of the workspace.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
        • tags — (map<String>)

          The list of tag keys and values that are associated with the workspace.

        • workspaceIdrequired — (String)

          The unique ID for the workspace.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

Service Reference:

Examples:

Calling the getDefaultScraperConfiguration operation

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

      • configuration — (Buffer(Node.js), Typed Array(Browser))

        The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.

Returns:

  • (AWS.Request)

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

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

Returns a list of rule groups namespaces in a workspace.

Service Reference:

Examples:

Calling the listRuleGroupsNamespaces operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
amp.listRuleGroupsNamespaces(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 number of results to return. The default is 100.

    • name — (String)

      Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.

    • nextToken — (String)

      The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

      For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.

    • workspaceId — (String)

      The ID of the workspace containing the rule groups namespaces.

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)

        A token indicating that there are more results to retrieve. You can use this token as part of your next ListRuleGroupsNamespaces request to retrieve those results.

      • ruleGroupsNamespaces — (Array<map>)

        The returned list of rule groups namespaces.

        • arnrequired — (String)

          The ARN of the rule groups namespace.

        • createdAtrequired — (Date)

          The date and time that the rule groups namespace was created.

        • modifiedAtrequired — (Date)

          The date and time that the rule groups namespace was most recently changed.

        • namerequired — (String)

          The name of the rule groups namespace.

        • statusrequired — (map)

          A structure that displays the current status of the rule groups namespace.

          • statusCoderequired — (String)

            The current status of the namespace.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
            • "UPDATE_FAILED"
          • statusReason — (String)

            The reason for the failure, if any.

        • tags — (map<String>)

          The list of tag keys and values that are associated with the rule groups namespace.

Returns:

  • (AWS.Request)

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

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

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

Service Reference:

Examples:

Calling the listScrapers operation

var params = {
  filters: {
    '<FilterKey>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<FilterKey>': ... */
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amp.listScrapers(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 — (map<Array<String>>)

      (Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

      Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

      To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

      status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

      If this is included, it filters the results to only the scrapers that match the filter.

    • maxResults — (Integer)

      Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000.

      If you omit this parameter, the default of 100 is used.

    • nextToken — (String)

      (Optional) The token for the next set of items to return. (You received this token from a previous 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:

      • nextToken — (String)

        A token indicating that there are more results to retrieve. You can use this token as part of your next ListScrapers operation to retrieve those results.

      • scrapers — (Array<map>)

        A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.

        • alias — (String)

          (Optional) A name associated with the scraper.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the scraper.

        • createdAtrequired — (Date)

          The date and time that the scraper was created.

        • destinationrequired — (map)

          The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

          • ampConfiguration — (map)

            The Amazon Managed Service for Prometheusworkspace to send metrics to.

            • workspaceArnrequired — (String)

              ARN of the Amazon Managed Service for Prometheus workspace.

        • lastModifiedAtrequired — (Date)

          The date and time that the scraper was last modified.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

        • scraperIdrequired — (String)

          The ID of the scraper.

        • sourcerequired — (map)

          The Amazon EKS cluster from which the scraper collects metrics.

          • eksConfiguration — (map)

            The Amazon EKS cluster from which a scraper collects metrics.

            • clusterArnrequired — (String)

              ARN of the Amazon EKS cluster.

            • securityGroupIds — (Array<String>)

              A list of the security group IDs for the Amazon EKS cluster VPC configuration.

            • subnetIdsrequired — (Array<String>)

              A list of subnet IDs for the Amazon EKS cluster VPC configuration.

        • statusrequired — (map)

          A structure that contains the current status of the scraper.

          • statusCoderequired — (String)

            The current status of the scraper.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "DELETING"
            • "CREATION_FAILED"
            • "DELETION_FAILED"
        • statusReason — (String)

          If there is a failure, the reason for the failure.

        • tags — (map<String>)

          (Optional) The list of tag keys and values associated with the scraper.

Returns:

  • (AWS.Request)

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

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

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
amp.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 ARN of the resource to list tages for. Must be a workspace or rule groups namespace 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 — (map<String>)

        The list of tag keys and values associated with the resource.

Returns:

  • (AWS.Request)

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

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

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

Service Reference:

Examples:

Calling the listWorkspaces operation

var params = {
  alias: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
amp.listWorkspaces(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: {})
    • alias — (String)

      If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

      Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

    • maxResults — (Integer)

      The maximum number of workspaces to return per request. The default is 100.

    • nextToken — (String)

      The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

      For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

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)

        A token indicating that there are more results to retrieve. You can use this token as part of your next ListWorkspaces request to retrieve those results.

      • workspaces — (Array<map>)

        An array of WorkspaceSummary structures containing information about the workspaces requested.

        • alias — (String)

          The alias that is assigned to this workspace to help identify it. It may not be unique.

        • arnrequired — (String)

          The ARN of the workspace.

        • createdAtrequired — (Date)

          The date and time that the workspace was created.

        • kmsKeyArn — (String)

          (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

        • statusrequired — (map)

          The current status of the workspace.

          • statusCoderequired — (String)

            The current status of the workspace.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
        • tags — (map<String>)

          The list of tag keys and values that are associated with the workspace.

        • workspaceIdrequired — (String)

          The unique ID for the workspace.

Returns:

  • (AWS.Request)

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

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

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.

Service Reference:

Examples:

Calling the putAlertManagerDefinition operation

var params = {
  data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.putAlertManagerDefinition(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • data — (Buffer, Typed Array, Blob, String)

      The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.

      For details about the alert manager definition, see AlertManagedDefinitionData.

    • workspaceId — (String)

      The ID of the workspace to update the alert manager definition in.

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

        A structure that returns the current status of the alert manager definition.

        • statusCoderequired — (String)

          The current status of the alert manager.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
          • "UPDATE_FAILED"
        • statusReason — (String)

          If there is a failure, the reason for the failure.

Returns:

  • (AWS.Request)

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

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

Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

Service Reference:

Examples:

Calling the putRuleGroupsNamespace operation

var params = {
  data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  name: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.putRuleGroupsNamespace(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • data — (Buffer, Typed Array, Blob, String)

      The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.

      For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

    • name — (String)

      The name of the rule groups namespace that you are updating.

    • workspaceId — (String)

      The ID of the workspace where you are updating the rule groups namespace.

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:

      • arn — (String)

        The ARN of the rule groups namespace.

      • name — (String)

        The name of the rule groups namespace that was updated.

      • status — (map)

        A structure that includes the current status of the rule groups namespace.

        • statusCoderequired — (String)

          The current status of the namespace.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
          • "UPDATE_FAILED"
        • statusReason — (String)

          The reason for the failure, if any.

      • tags — (map<String>)

        The list of tag keys and values that are associated with the namespace.

Returns:

  • (AWS.Request)

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

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

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
amp.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 ARN of the workspace or rule groups namespace to apply tags to.

    • tags — (map<String>)

      The list of tag keys and values to associate with the resource.

      Keys may not begin with aws:.

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 an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
amp.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 ARN of the workspace or rule groups namespace.

    • tagKeys — (Array<String>)

      The keys of 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.

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

Updates the log group ARN or the workspace ID of the current logging configuration.

Service Reference:

Examples:

Calling the updateLoggingConfiguration operation

var params = {
  logGroupArn: 'STRING_VALUE', /* required */
  workspaceId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
amp.updateLoggingConfiguration(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)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • logGroupArn — (String)

      The ARN of the CloudWatch log group to which the vended log data will be published.

    • workspaceId — (String)

      The ID of the workspace to update the logging configuration 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:

      • status — (map)

        A structure that contains the current status of the logging configuration.

        • statusCoderequired — (String)

          The current status of the logging configuration.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "CREATION_FAILED"
          • "UPDATE_FAILED"
        • statusReason — (String)

          If failed, the reason for the failure.

Returns:

  • (AWS.Request)

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

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

Updates the alias of an existing workspace.

Service Reference:

Examples:

Calling the updateWorkspaceAlias operation

var params = {
  workspaceId: 'STRING_VALUE', /* required */
  alias: 'STRING_VALUE',
  clientToken: 'STRING_VALUE'
};
amp.updateWorkspaceAlias(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: {})
    • alias — (String)

      The new alias for the workspace. It does not need to be unique.

      Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

    • clientToken — (String)

      A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.

      If a token is not provided, the SDK will use a version 4 UUID.
    • workspaceId — (String)

      The ID of the workspace to update.

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.

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

Waits for a given Amp resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the scraperActive state

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

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

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

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

Waiter Resource Details

amp.waitFor('scraperActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the scraperActive state by periodically calling the underlying Amp.describeScraper() operation every 2 seconds (at most 60 times).

Examples:

Waiting for the scraperActive state

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

Parameters:

  • params (Object)
    • scraperId — (String)

      The ID of the scraper to describe.

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:

      • scraper — (map)

        Contains details about the scraper.

        • alias — (String)

          (Optional) A name associated with the scraper.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the scraper.

        • createdAtrequired — (Date)

          The date and time that the scraper was created.

        • destinationrequired — (map)

          The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

          • ampConfiguration — (map)

            The Amazon Managed Service for Prometheusworkspace to send metrics to.

            • workspaceArnrequired — (String)

              ARN of the Amazon Managed Service for Prometheus workspace.

        • lastModifiedAtrequired — (Date)

          The date and time that the scraper was last modified.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

        • scrapeConfigurationrequired — (map)

          The configuration file in use by the scraper.

          • configurationBlob — (Buffer, Typed Array, Blob, String)

            The base 64 encoded scrape configuration file.

        • scraperIdrequired — (String)

          The ID of the scraper.

        • sourcerequired — (map)

          The Amazon EKS cluster from which the scraper collects metrics.

          • eksConfiguration — (map)

            The Amazon EKS cluster from which a scraper collects metrics.

            • clusterArnrequired — (String)

              ARN of the Amazon EKS cluster.

            • securityGroupIds — (Array<String>)

              A list of the security group IDs for the Amazon EKS cluster VPC configuration.

            • subnetIdsrequired — (Array<String>)

              A list of subnet IDs for the Amazon EKS cluster VPC configuration.

        • statusrequired — (map)

          A structure that contains the current status of the scraper.

          • statusCoderequired — (String)

            The current status of the scraper.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "DELETING"
            • "CREATION_FAILED"
            • "DELETION_FAILED"
        • statusReason — (String)

          If there is a failure, the reason for the failure.

        • tags — (map<String>)

          (Optional) The list of tag keys and values associated with the scraper.

Returns:

  • (AWS.Request)

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

See Also:

amp.waitFor('scraperDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the scraperDeleted state by periodically calling the underlying Amp.describeScraper() operation every 2 seconds (at most 60 times).

Examples:

Waiting for the scraperDeleted state

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

Parameters:

  • params (Object)
    • scraperId — (String)

      The ID of the scraper to describe.

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:

      • scraper — (map)

        Contains details about the scraper.

        • alias — (String)

          (Optional) A name associated with the scraper.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the scraper.

        • createdAtrequired — (Date)

          The date and time that the scraper was created.

        • destinationrequired — (map)

          The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

          • ampConfiguration — (map)

            The Amazon Managed Service for Prometheusworkspace to send metrics to.

            • workspaceArnrequired — (String)

              ARN of the Amazon Managed Service for Prometheus workspace.

        • lastModifiedAtrequired — (Date)

          The date and time that the scraper was last modified.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

        • scrapeConfigurationrequired — (map)

          The configuration file in use by the scraper.

          • configurationBlob — (Buffer, Typed Array, Blob, String)

            The base 64 encoded scrape configuration file.

        • scraperIdrequired — (String)

          The ID of the scraper.

        • sourcerequired — (map)

          The Amazon EKS cluster from which the scraper collects metrics.

          • eksConfiguration — (map)

            The Amazon EKS cluster from which a scraper collects metrics.

            • clusterArnrequired — (String)

              ARN of the Amazon EKS cluster.

            • securityGroupIds — (Array<String>)

              A list of the security group IDs for the Amazon EKS cluster VPC configuration.

            • subnetIdsrequired — (Array<String>)

              A list of subnet IDs for the Amazon EKS cluster VPC configuration.

        • statusrequired — (map)

          A structure that contains the current status of the scraper.

          • statusCoderequired — (String)

            The current status of the scraper.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "DELETING"
            • "CREATION_FAILED"
            • "DELETION_FAILED"
        • statusReason — (String)

          If there is a failure, the reason for the failure.

        • tags — (map<String>)

          (Optional) The list of tag keys and values associated with the scraper.

Returns:

  • (AWS.Request)

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

See Also:

amp.waitFor('workspaceActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the workspaceActive state by periodically calling the underlying Amp.describeWorkspace() operation every 2 seconds (at most 60 times).

Examples:

Waiting for the workspaceActive state

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

Parameters:

  • params (Object)
    • workspaceId — (String)

      The ID of the workspace to describe.

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:

      • workspace — (map)

        A structure that contains details about the workspace.

        • alias — (String)

          The alias that is assigned to this workspace to help identify it. It may not be unique.

        • arnrequired — (String)

          The ARN of the workspace.

        • createdAtrequired — (Date)

          The date and time that the workspace was created.

        • kmsKeyArn — (String)

          (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

        • prometheusEndpoint — (String)

          The Prometheus endpoint available for this workspace.

        • statusrequired — (map)

          The current status of the workspace.

          • statusCoderequired — (String)

            The current status of the workspace.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
        • tags — (map<String>)

          The list of tag keys and values that are associated with the workspace.

        • workspaceIdrequired — (String)

          The unique ID for the workspace.

Returns:

  • (AWS.Request)

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

See Also:

amp.waitFor('workspaceDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the workspaceDeleted state by periodically calling the underlying Amp.describeWorkspace() operation every 2 seconds (at most 60 times).

Examples:

Waiting for the workspaceDeleted state

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

Parameters:

  • params (Object)
    • workspaceId — (String)

      The ID of the workspace to describe.

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:

      • workspace — (map)

        A structure that contains details about the workspace.

        • alias — (String)

          The alias that is assigned to this workspace to help identify it. It may not be unique.

        • arnrequired — (String)

          The ARN of the workspace.

        • createdAtrequired — (Date)

          The date and time that the workspace was created.

        • kmsKeyArn — (String)

          (optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

        • prometheusEndpoint — (String)

          The Prometheus endpoint available for this workspace.

        • statusrequired — (map)

          The current status of the workspace.

          • statusCoderequired — (String)

            The current status of the workspace.

            Possible values include:
            • "CREATING"
            • "ACTIVE"
            • "UPDATING"
            • "DELETING"
            • "CREATION_FAILED"
        • tags — (map<String>)

          The list of tag keys and values that are associated with the workspace.

        • workspaceIdrequired — (String)

          The unique ID for the workspace.

Returns:

  • (AWS.Request)

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

See Also: