Class: AWS.Amp

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.

      • statusCode — required — (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.

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.

      • statusCode — required — (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.

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.

      • workspaceArn — required — (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.

      • clusterArn — required — (String)

        ARN of the Amazon EKS cluster.

      • securityGroupIds — (Array<String>)

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

      • subnetIds — required — (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.

      • statusCode — required — (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.

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.

      • statusCode — required — (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.

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.

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.

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.

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.

      • statusCode — required — (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.

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.

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.

      • createdAt — required — (Date)

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

      • data — required — (Buffer, Typed Array, Blob, String)

        The actual alert manager definition.

        For details about the alert manager definition, see AlertManagedDefinitionData.

      • modifiedAt — required — (Date)

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

      • status — required — (map)

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

        • statusCode — required — (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.

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.

      • createdAt — required — (Date)

        The date and time that the logging configuration was created.

      • logGroupArn — required — (String)

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

      • modifiedAt — required — (Date)

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

      • status — required — (map)

        The current status of the logging configuration.

        • statusCode — required — (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.

      • workspace — required — (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.

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.

      • arn — required — (String)

        The ARN of the rule groups namespace.

      • createdAt — required — (Date)

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

      • data — required — (Buffer, Typed Array, Blob, String)

        The rule groups file used in the namespace.

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

      • modifiedAt — required — (Date)

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

      • name — required — (String)

        The name of the rule groups namespace.

      • status — required — (map)

        The current status of the rule groups namespace.

        • statusCode — required — (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.

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.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the scraper.

      • createdAt — required — (Date)

        The date and time that the scraper was created.

      • destination — required — (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.

          • workspaceArn — required — (String)

            ARN of the Amazon Managed Service for Prometheus workspace.

      • lastModifiedAt — required — (Date)

        The date and time that the scraper was last modified.

      • roleArn — required — (String)

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

      • scrapeConfiguration — required — (map)

        The configuration file in use by the scraper.

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

          The base 64 encoded scrape configuration file.

      • scraperId — required — (String)

        The ID of the scraper.

      • source — required — (map)

        The Amazon EKS cluster from which the scraper collects metrics.

        • eksConfiguration — (map)

          The Amazon EKS cluster from which a scraper collects metrics.

          • clusterArn — required — (String)

            ARN of the Amazon EKS cluster.

          • securityGroupIds — (Array<String>)

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

          • subnetIds — required — (Array<String>)

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

      • status — required — (map)

        A structure that contains the current status of the scraper.

        • statusCode — required — (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:

• scraperActive

• scraperDeleted

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.

      • arn — required — (String)

        The ARN of the workspace.

      • createdAt — required — (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.

      • status — required — (map)

        The current status of the workspace.

        • statusCode — required — (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 — required — (String)

        The unique ID for the workspace.

Returns:

• (AWS.Request) —

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

Waiter Resource States:

• workspaceActive

• workspaceDeleted

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.

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.

      • arn — required — (String)

        The ARN of the rule groups namespace.

      • createdAt — required — (Date)

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

      • modifiedAt — required — (Date)

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

      • name — required — (String)

        The name of the rule groups namespace.

      • status — required — (map)

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

        • statusCode — required — (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.

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.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the scraper.

      • createdAt — required — (Date)

        The date and time that the scraper was created.

      • destination — required — (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.

          • workspaceArn — required — (String)

            ARN of the Amazon Managed Service for Prometheus workspace.

      • lastModifiedAt — required — (Date)

        The date and time that the scraper was last modified.

      • roleArn — required — (String)

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

      • scraperId — required — (String)

        The ID of the scraper.

      • source — required — (map)

        The Amazon EKS cluster from which the scraper collects metrics.

        • eksConfiguration — (map)

          The Amazon EKS cluster from which a scraper collects metrics.

          • clusterArn — required — (String)

            ARN of the Amazon EKS cluster.

          • securityGroupIds — (Array<String>)

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

          • subnetIds — required — (Array<String>)

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

      • status — required — (map)

        A structure that contains the current status of the scraper.

        • statusCode — required — (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.

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.

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.

      • arn — required — (String)

        The ARN of the workspace.

      • createdAt — required — (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.

      • status — required — (map)

        The current status of the workspace.

        • statusCode — required — (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 — required — (String)

        The unique ID for the workspace.

Returns:

• (AWS.Request) —

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

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.

      • statusCode — required — (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.

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.

      • statusCode — required — (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.

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.

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.

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.

      • statusCode — required — (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.

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.

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:

• scraperActive

• scraperDeleted

• workspaceActive

• workspaceDeleted