Class: AWS.ApplicationInsights

Inherits:
AWS.Service show all
Identifier:
applicationinsights
API Version:
2018-11-25
Defined in:
(unknown)

Overview

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

Service Description

Amazon CloudWatch Application Insights is a service that helps you detect common problems with your applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.

After you onboard your application, CloudWatch Application Insights identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.

Sending a Request Using ApplicationInsights

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

var applicationinsights = new AWS.ApplicationInsights({apiVersion: '2018-11-25'});

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

AWS.config.apiVersions = {
  applicationinsights: '2018-11-25',
  // other service API versions
};

var applicationinsights = new AWS.ApplicationInsights();

Version:

  • 2018-11-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a ApplicationInsights object

var applicationinsights = new AWS.ApplicationInsights({apiVersion: '2018-11-25'});

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

Property Details

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

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

Adds an application that is created from a resource group.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  CWEMonitorEnabled: true || false,
  OpsCenterEnabled: true || false,
  OpsItemSNSTopicArn: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
applicationinsights.createApplication(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • OpsCenterEnabled — (Boolean)

      When set to true, creates opsItems for any problems detected on an application.

    • CWEMonitorEnabled — (Boolean)

      Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

    • OpsItemSNSTopicArn — (String)

      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

    • Tags — (Array<map>)

      List of tags to add to the application. tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.

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:

      • ApplicationInfo — (map)

        Information about the application.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • CWEMonitorEnabled — (Boolean)

          Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:

          • “Configuring application, detected 1 Errors, 3 Warnings”

          • “Configuring application, detected 1 Unconfigured Components”

Returns:

  • (AWS.Request)

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

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

Creates a custom component by grouping similar standalone instances to monitor.

Service Reference:

Examples:

Calling the createComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  ResourceList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
applicationinsights.createComponent(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • ResourceList — (Array<String>)

      The list of resource ARNs that belong to the component.

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.

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

Adds an log pattern to a LogPatternSet.

Service Reference:

Examples:

Calling the createLogPattern operation

var params = {
  Pattern: 'STRING_VALUE', /* required */
  PatternName: 'STRING_VALUE', /* required */
  PatternSetName: 'STRING_VALUE', /* required */
  Rank: 'NUMBER_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.createLogPattern(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • PatternSetName — (String)

      The name of the log pattern set.

    • PatternName — (String)

      The name of the log pattern.

    • Pattern — (String)

      The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

    • Rank — (Integer)

      Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.

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:

      • LogPattern — (map)

        The successfully created log pattern.

        • PatternSetName — (String)

          The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • PatternName — (String)

          The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • Pattern — (String)

          A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

        • Rank — (Integer)

          Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.

      • ResourceGroupName — (String)

        The name of the resource group.

Returns:

  • (AWS.Request)

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

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

Removes the specified application from monitoring. Does not delete the application.

Service Reference:

Examples:

Calling the deleteApplication operation

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

      The name of the resource group.

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.

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

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

Service Reference:

Examples:

Calling the deleteComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.deleteComponent(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

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.

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

Removes the specified log pattern from a LogPatternSet.

Service Reference:

Examples:

Calling the deleteLogPattern operation

var params = {
  PatternName: 'STRING_VALUE', /* required */
  PatternSetName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.deleteLogPattern(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • PatternSetName — (String)

      The name of the log pattern set.

    • PatternName — (String)

      The name of the log pattern.

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.

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

Describes the application.

Service Reference:

Examples:

Calling the describeApplication operation

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

      The name of the resource group.

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:

      • ApplicationInfo — (map)

        Information about the application.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • CWEMonitorEnabled — (Boolean)

          Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:

          • “Configuring application, detected 1 Errors, 3 Warnings”

          • “Configuring application, detected 1 Unconfigured Components”

Returns:

  • (AWS.Request)

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

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

Describes a component and lists the resources that are grouped together in a component.

Service Reference:

Examples:

Calling the describeComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.describeComponent(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

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:

      • ApplicationComponent — (map)

        Describes a standalone resource or similarly grouped resources that the application is made up of.

        • ComponentName — (String)

          The name of the component.

        • ComponentRemarks — (String)

          If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.

        • ResourceType — (String)

          The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

        • OsType — (String)

          The operating system of the component.

          Possible values include:
          • "WINDOWS"
          • "LINUX"
        • Tier — (String)

          The stack tier of the application component.

          Possible values include:
          • "CUSTOM"
          • "DEFAULT"
          • "DOT_NET_CORE"
          • "DOT_NET_WORKER"
          • "DOT_NET_WEB_TIER"
          • "DOT_NET_WEB"
          • "SQL_SERVER"
          • "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP"
          • "MYSQL"
          • "POSTGRESQL"
          • "JAVA_JMX"
          • "ORACLE"
        • Monitor — (Boolean)

          Indicates whether the application component is monitored.

        • DetectedWorkload — (map<map<String>>)

          Workloads detected in the application component.

      • ResourceList — (Array<String>)

        The list of resource ARNs that belong to the component.

Returns:

  • (AWS.Request)

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

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

Describes the monitoring configuration of the component.

Service Reference:

Examples:

Calling the describeComponentConfiguration operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.describeComponentConfiguration(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

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:

      • Monitor — (Boolean)

        Indicates whether the application component is monitored.

      • Tier — (String)

        The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT

        Possible values include:
        • "CUSTOM"
        • "DEFAULT"
        • "DOT_NET_CORE"
        • "DOT_NET_WORKER"
        • "DOT_NET_WEB_TIER"
        • "DOT_NET_WEB"
        • "SQL_SERVER"
        • "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP"
        • "MYSQL"
        • "POSTGRESQL"
        • "JAVA_JMX"
        • "ORACLE"
      • ComponentConfiguration — (String)

        The configuration settings of the component. The value is the escaped JSON of the configuration.

Returns:

  • (AWS.Request)

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

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

Describes the recommended monitoring configuration of the component.

Examples:

Calling the describeComponentConfigurationRecommendation operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  Tier: CUSTOM | DEFAULT | DOT_NET_CORE | DOT_NET_WORKER | DOT_NET_WEB_TIER | DOT_NET_WEB | SQL_SERVER | SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP | MYSQL | POSTGRESQL | JAVA_JMX | ORACLE /* required */
};
applicationinsights.describeComponentConfigurationRecommendation(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • Tier — (String)

      The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

      Possible values include:
      • "CUSTOM"
      • "DEFAULT"
      • "DOT_NET_CORE"
      • "DOT_NET_WORKER"
      • "DOT_NET_WEB_TIER"
      • "DOT_NET_WEB"
      • "SQL_SERVER"
      • "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP"
      • "MYSQL"
      • "POSTGRESQL"
      • "JAVA_JMX"
      • "ORACLE"

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:

      • ComponentConfiguration — (String)

        The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

Returns:

  • (AWS.Request)

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

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

Describe a specific log pattern from a LogPatternSet.

Service Reference:

Examples:

Calling the describeLogPattern operation

var params = {
  PatternName: 'STRING_VALUE', /* required */
  PatternSetName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE' /* required */
};
applicationinsights.describeLogPattern(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • PatternSetName — (String)

      The name of the log pattern set.

    • PatternName — (String)

      The name of the log pattern.

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:

      • ResourceGroupName — (String)

        The name of the resource group.

      • LogPattern — (map)

        The successfully created log pattern.

        • PatternSetName — (String)

          The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • PatternName — (String)

          The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • Pattern — (String)

          A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

        • Rank — (Integer)

          Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.

Returns:

  • (AWS.Request)

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

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

Describes an anomaly or error with the application.

Service Reference:

Examples:

Calling the describeObservation operation

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

      The ID of the observation.

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:

      • Observation — (map)

        Information about the observation.

        • Id — (String)

          The ID of the observation type.

        • StartTime — (Date)

          The time when the observation was first detected, in epoch seconds.

        • EndTime — (Date)

          The time when the observation ended, in epoch seconds.

        • SourceType — (String)

          The source type of the observation.

        • SourceARN — (String)

          The source resource ARN of the observation.

        • LogGroup — (String)

          The log group name.

        • LineTime — (Date)

          The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

        • LogText — (String)

          The log text of the observation.

        • LogFilter — (String)

          The log filter of the observation.

          Possible values include:
          • "ERROR"
          • "WARN"
          • "INFO"
        • MetricNamespace — (String)

          The namespace of the observation metric.

        • MetricName — (String)

          The name of the observation metric.

        • Unit — (String)

          The unit of the source observation metric.

        • Value — (Float)

          The value of the source observation metric.

        • CloudWatchEventId — (String)

          The ID of the CloudWatch Event-based observation related to the detected problem.

        • CloudWatchEventSource — (String)

          The source of the CloudWatch Event.

          Possible values include:
          • "EC2"
          • "CODE_DEPLOY"
          • "HEALTH"
          • "RDS"
        • CloudWatchEventDetailType — (String)

          The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.

        • HealthEventArn — (String)

          The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

        • HealthService — (String)

          The service to which the AWS Health Event belongs, such as EC2.

        • HealthEventTypeCode — (String)

          The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.

        • HealthEventTypeCategory — (String)

          The category of the AWS Health event, such as issue.

        • HealthEventDescription — (String)

          The description of the AWS Health event provided by the service, such as Amazon EC2.

        • CodeDeployDeploymentId — (String)

          The deployment ID of the CodeDeploy-based observation related to the detected problem.

        • CodeDeployDeploymentGroup — (String)

          The deployment group to which the CodeDeploy deployment belongs.

        • CodeDeployState — (String)

          The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.

        • CodeDeployApplication — (String)

          The CodeDeploy application to which the deployment belongs.

        • CodeDeployInstanceGroupId — (String)

          The instance group to which the CodeDeploy instance belongs.

        • Ec2State — (String)

          The state of the instance, such as STOPPING or TERMINATING.

        • RdsEventCategories — (String)

          The category of an RDS event.

        • RdsEventMessage — (String)

          The message of an RDS event.

        • S3EventName — (String)

          The name of the S3 CloudWatch Event-based observation.

        • StatesExecutionArn — (String)

          The Amazon Resource Name (ARN) of the step function execution-based observation.

        • StatesArn — (String)

          The Amazon Resource Name (ARN) of the step function-based observation.

        • StatesStatus — (String)

          The status of the step function-related observation.

        • StatesInput — (String)

          The input to the step function-based observation.

        • EbsEvent — (String)

          The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.

        • EbsResult — (String)

          The result of an EBS CloudWatch event, such as failed or succeeded.

        • EbsCause — (String)

          The cause of an EBS CloudWatch event.

        • EbsRequestId — (String)

          The request ID of an EBS CloudWatch event.

        • XRayFaultPercent — (Integer)

          The X-Ray request fault percentage for this node.

        • XRayThrottlePercent — (Integer)

          The X-Ray request throttle percentage for this node.

        • XRayErrorPercent — (Integer)

          The X-Ray request error percentage for this node.

        • XRayRequestCount — (Integer)

          The X-Ray request count for this node.

        • XRayRequestAverageLatency — (Integer)

          The X-Ray node request average latency for this node.

        • XRayNodeName — (String)

          The name of the X-Ray node.

        • XRayNodeType — (String)

          The type of the X-Ray node.

Returns:

  • (AWS.Request)

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

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

Describes an application problem.

Service Reference:

Examples:

Calling the describeProblem operation

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

      The ID of the problem.

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:

      • Problem — (map)

        Information about the problem.

        • Id — (String)

          The ID of the problem.

        • Title — (String)

          The name of the problem.

        • Insights — (String)

          A detailed analysis of the problem using machine learning.

        • Status — (String)

          The status of the problem.

          Possible values include:
          • "IGNORE"
          • "RESOLVED"
          • "PENDING"
        • AffectedResource — (String)

          The resource affected by the problem.

        • StartTime — (Date)

          The time when the problem started, in epoch seconds.

        • EndTime — (Date)

          The time when the problem ended, in epoch seconds.

        • SeverityLevel — (String)

          A measure of the level of impact of the problem.

          Possible values include:
          • "Low"
          • "Medium"
          • "High"
        • ResourceGroupName — (String)

          The name of the resource group affected by the problem.

        • Feedback — (map<String>)

          Feedback provided by the user about the problem.

Returns:

  • (AWS.Request)

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

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

Describes the anomalies or errors associated with the problem.

Service Reference:

Examples:

Calling the describeProblemObservations operation

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

      The ID of the problem.

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:

      • RelatedObservations — (map)

        Observations related to the problem.

        • ObservationList — (Array<map>)

          The list of observations related to the problem.

          • Id — (String)

            The ID of the observation type.

          • StartTime — (Date)

            The time when the observation was first detected, in epoch seconds.

          • EndTime — (Date)

            The time when the observation ended, in epoch seconds.

          • SourceType — (String)

            The source type of the observation.

          • SourceARN — (String)

            The source resource ARN of the observation.

          • LogGroup — (String)

            The log group name.

          • LineTime — (Date)

            The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

          • LogText — (String)

            The log text of the observation.

          • LogFilter — (String)

            The log filter of the observation.

            Possible values include:
            • "ERROR"
            • "WARN"
            • "INFO"
          • MetricNamespace — (String)

            The namespace of the observation metric.

          • MetricName — (String)

            The name of the observation metric.

          • Unit — (String)

            The unit of the source observation metric.

          • Value — (Float)

            The value of the source observation metric.

          • CloudWatchEventId — (String)

            The ID of the CloudWatch Event-based observation related to the detected problem.

          • CloudWatchEventSource — (String)

            The source of the CloudWatch Event.

            Possible values include:
            • "EC2"
            • "CODE_DEPLOY"
            • "HEALTH"
            • "RDS"
          • CloudWatchEventDetailType — (String)

            The detail type of the CloudWatch Event-based observation, for example, EC2 Instance State-change Notification.

          • HealthEventArn — (String)

            The Amazon Resource Name (ARN) of the AWS Health Event-based observation.

          • HealthService — (String)

            The service to which the AWS Health Event belongs, such as EC2.

          • HealthEventTypeCode — (String)

            The type of the AWS Health event, for example, AWS_EC2_POWER_CONNECTIVITY_ISSUE.

          • HealthEventTypeCategory — (String)

            The category of the AWS Health event, such as issue.

          • HealthEventDescription — (String)

            The description of the AWS Health event provided by the service, such as Amazon EC2.

          • CodeDeployDeploymentId — (String)

            The deployment ID of the CodeDeploy-based observation related to the detected problem.

          • CodeDeployDeploymentGroup — (String)

            The deployment group to which the CodeDeploy deployment belongs.

          • CodeDeployState — (String)

            The status of the CodeDeploy deployment, for example SUCCESS or FAILURE.

          • CodeDeployApplication — (String)

            The CodeDeploy application to which the deployment belongs.

          • CodeDeployInstanceGroupId — (String)

            The instance group to which the CodeDeploy instance belongs.

          • Ec2State — (String)

            The state of the instance, such as STOPPING or TERMINATING.

          • RdsEventCategories — (String)

            The category of an RDS event.

          • RdsEventMessage — (String)

            The message of an RDS event.

          • S3EventName — (String)

            The name of the S3 CloudWatch Event-based observation.

          • StatesExecutionArn — (String)

            The Amazon Resource Name (ARN) of the step function execution-based observation.

          • StatesArn — (String)

            The Amazon Resource Name (ARN) of the step function-based observation.

          • StatesStatus — (String)

            The status of the step function-related observation.

          • StatesInput — (String)

            The input to the step function-based observation.

          • EbsEvent — (String)

            The type of EBS CloudWatch event, such as createVolume, deleteVolume or attachVolume.

          • EbsResult — (String)

            The result of an EBS CloudWatch event, such as failed or succeeded.

          • EbsCause — (String)

            The cause of an EBS CloudWatch event.

          • EbsRequestId — (String)

            The request ID of an EBS CloudWatch event.

          • XRayFaultPercent — (Integer)

            The X-Ray request fault percentage for this node.

          • XRayThrottlePercent — (Integer)

            The X-Ray request throttle percentage for this node.

          • XRayErrorPercent — (Integer)

            The X-Ray request error percentage for this node.

          • XRayRequestCount — (Integer)

            The X-Ray request count for this node.

          • XRayRequestAverageLatency — (Integer)

            The X-Ray node request average latency for this node.

          • XRayNodeName — (String)

            The name of the X-Ray node.

          • XRayNodeType — (String)

            The type of the X-Ray node.

Returns:

  • (AWS.Request)

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

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

Lists the IDs of the applications that you are monitoring.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationinsights.listApplications(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 in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ApplicationInfoList — (Array<map>)

        The list of applications.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • CWEMonitorEnabled — (Boolean)

          Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:

          • “Configuring application, detected 1 Errors, 3 Warnings”

          • “Configuring application, detected 1 Unconfigured Components”

      • NextToken — (String)

        The token used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists the auto-grouped, standalone, and custom components of the application.

Service Reference:

Examples:

Calling the listComponents operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationinsights.listComponents(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ApplicationComponentList — (Array<map>)

        The list of application components.

        • ComponentName — (String)

          The name of the component.

        • ComponentRemarks — (String)

          If logging is supported for the resource type, indicates whether the component has configured logs to be monitored.

        • ResourceType — (String)

          The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

        • OsType — (String)

          The operating system of the component.

          Possible values include:
          • "WINDOWS"
          • "LINUX"
        • Tier — (String)

          The stack tier of the application component.

          Possible values include:
          • "CUSTOM"
          • "DEFAULT"
          • "DOT_NET_CORE"
          • "DOT_NET_WORKER"
          • "DOT_NET_WEB_TIER"
          • "DOT_NET_WEB"
          • "SQL_SERVER"
          • "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP"
          • "MYSQL"
          • "POSTGRESQL"
          • "JAVA_JMX"
          • "ORACLE"
        • Monitor — (Boolean)

          Indicates whether the application component is monitored.

        • DetectedWorkload — (map<map<String>>)

          Workloads detected in the application component.

      • NextToken — (String)

        The token to request the next page of results.

Returns:

  • (AWS.Request)

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

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

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

  • INFO: creating a new alarm or updating an alarm threshold.

  • WARN: alarm not created due to insufficient data points used to predict thresholds.

  • ERROR: alarm not created due to permission errors or exceeding quotas.

Service Reference:

Examples:

Calling the listConfigurationHistory operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EventStatus: INFO | WARN | ERROR,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceGroupName: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
applicationinsights.listConfigurationHistory(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: {})
    • ResourceGroupName — (String)

      Resource group to which the application belongs.

    • StartTime — (Date)

      The start time of the event.

    • EndTime — (Date)

      The end time of the event.

    • EventStatus — (String)

      The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

      Possible values include:
      • "INFO"
      • "WARN"
      • "ERROR"
    • MaxResults — (Integer)

      The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.

    • NextToken — (String)

      The NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

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:

      • EventList — (Array<map>)

        The list of configuration events and their corresponding details.

        • MonitoredResourceARN — (String)

          The resource monitored by Application Insights.

        • EventStatus — (String)

          The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

          Possible values include:
          • "INFO"
          • "WARN"
          • "ERROR"
        • EventResourceType — (String)

          The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.

          Possible values include:
          • "CLOUDWATCH_ALARM"
          • "CLOUDWATCH_LOG"
          • "CLOUDFORMATION"
          • "SSM_ASSOCIATION"
        • EventTime — (Date)

          The timestamp of the event.

        • EventDetail — (String)

          The details of the event in plain text.

        • EventResourceName — (String)

          The name of the resource Application Insights attempted to configure.

      • NextToken — (String)

        The NextToken value to include in a future ListConfigurationHistory request. When the results of a ListConfigurationHistory request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists the log patterns in the specific log LogPatternSet.

Service Reference:

Examples:

Calling the listLogPatterns operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PatternSetName: 'STRING_VALUE'
};
applicationinsights.listLogPatterns(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • PatternSetName — (String)

      The name of the log pattern set.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ResourceGroupName — (String)

        The name of the resource group.

      • LogPatterns — (Array<map>)

        The list of log patterns.

        • PatternSetName — (String)

          The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • PatternName — (String)

          The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • Pattern — (String)

          A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

        • Rank — (Integer)

          Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.

      • NextToken — (String)

        The token used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists the log pattern sets in the specific application.

Service Reference:

Examples:

Calling the listLogPatternSets operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
applicationinsights.listLogPatternSets(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ResourceGroupName — (String)

        The name of the resource group.

      • LogPatternSets — (Array<String>)

        The list of log pattern sets.

      • NextToken — (String)

        The token used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Lists the problems with your application.

Service Reference:

Examples:

Calling the listProblems operation

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceGroupName: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
applicationinsights.listProblems(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • StartTime — (Date)

      The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

    • EndTime — (Date)

      The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

    • MaxResults — (Integer)

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

    • NextToken — (String)

      The token to request the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ProblemList — (Array<map>)

        The list of problems.

        • Id — (String)

          The ID of the problem.

        • Title — (String)

          The name of the problem.

        • Insights — (String)

          A detailed analysis of the problem using machine learning.

        • Status — (String)

          The status of the problem.

          Possible values include:
          • "IGNORE"
          • "RESOLVED"
          • "PENDING"
        • AffectedResource — (String)

          The resource affected by the problem.

        • StartTime — (Date)

          The time when the problem started, in epoch seconds.

        • EndTime — (Date)

          The time when the problem ended, in epoch seconds.

        • SeverityLevel — (String)

          A measure of the level of impact of the problem.

          Possible values include:
          • "Low"
          • "Medium"
          • "High"
        • ResourceGroupName — (String)

          The name of the resource group affected by the problem.

        • Feedback — (map<String>)

          Feedback provided by the user about the problem.

      • NextToken — (String)

        The token used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

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

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

Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the application that you want to retrieve tag information 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:

      • Tags — (Array<map>)

        An array that lists all the tags that are associated with the application. Each tag consists of a required tag key (Key) and an associated tag value (Value).

        • Keyrequired — (String)

          One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

        • Valuerequired — (String)

          The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.

Returns:

  • (AWS.Request)

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

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

Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Service Reference:

Examples:

Calling the tagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

    • Tags — (Array<map>)

      A list of tags that to add to the application. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Remove one or more tags (keys and values) from a specified application.

Service Reference:

Examples:

Calling the untagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.

    • TagKeys — (Array<String>)

      The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

      To remove more than one tag from the application, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand.

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.

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

Updates the application.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  ResourceGroupName: 'STRING_VALUE', /* required */
  CWEMonitorEnabled: true || false,
  OpsCenterEnabled: true || false,
  OpsItemSNSTopicArn: 'STRING_VALUE',
  RemoveSNSTopic: true || false
};
applicationinsights.updateApplication(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • OpsCenterEnabled — (Boolean)

      When set to true, creates opsItems for any problems detected on an application.

    • CWEMonitorEnabled — (Boolean)

      Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

    • OpsItemSNSTopicArn — (String)

      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

    • RemoveSNSTopic — (Boolean)

      Disassociates the SNS topic from the opsItem created for detected problems.

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:

      • ApplicationInfo — (map)

        Information about the application.

        • ResourceGroupName — (String)

          The name of the resource group used for the application.

        • LifeCycle — (String)

          The lifecycle of the application.

        • OpsItemSNSTopicArn — (String)

          The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

        • OpsCenterEnabled — (Boolean)

          Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

        • CWEMonitorEnabled — (Boolean)

          Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

        • Remarks — (String)

          The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:

          • “Configuring application, detected 1 Errors, 3 Warnings”

          • “Configuring application, detected 1 Unconfigured Components”

Returns:

  • (AWS.Request)

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

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

Updates the custom component name and/or the list of resources that make up the component.

Service Reference:

Examples:

Calling the updateComponent operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  NewComponentName: 'STRING_VALUE',
  ResourceList: [
    'STRING_VALUE',
    /* more items */
  ]
};
applicationinsights.updateComponent(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • NewComponentName — (String)

      The new name of the component.

    • ResourceList — (Array<String>)

      The list of resource ARNs that belong to the component.

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.

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

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.

Service Reference:

Examples:

Calling the updateComponentConfiguration operation

var params = {
  ComponentName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  ComponentConfiguration: 'STRING_VALUE',
  Monitor: true || false,
  Tier: CUSTOM | DEFAULT | DOT_NET_CORE | DOT_NET_WORKER | DOT_NET_WEB_TIER | DOT_NET_WEB | SQL_SERVER | SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP | MYSQL | POSTGRESQL | JAVA_JMX | ORACLE
};
applicationinsights.updateComponentConfiguration(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • ComponentName — (String)

      The name of the component.

    • Monitor — (Boolean)

      Indicates whether the application component is monitored.

    • Tier — (String)

      The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.

      Possible values include:
      • "CUSTOM"
      • "DEFAULT"
      • "DOT_NET_CORE"
      • "DOT_NET_WORKER"
      • "DOT_NET_WEB_TIER"
      • "DOT_NET_WEB"
      • "SQL_SERVER"
      • "SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP"
      • "MYSQL"
      • "POSTGRESQL"
      • "JAVA_JMX"
      • "ORACLE"
    • ComponentConfiguration — (String)

      The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Adds a log pattern to a LogPatternSet.

Service Reference:

Examples:

Calling the updateLogPattern operation

var params = {
  PatternName: 'STRING_VALUE', /* required */
  PatternSetName: 'STRING_VALUE', /* required */
  ResourceGroupName: 'STRING_VALUE', /* required */
  Pattern: 'STRING_VALUE',
  Rank: 'NUMBER_VALUE'
};
applicationinsights.updateLogPattern(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: {})
    • ResourceGroupName — (String)

      The name of the resource group.

    • PatternSetName — (String)

      The name of the log pattern set.

    • PatternName — (String)

      The name of the log pattern.

    • Pattern — (String)

      The log pattern. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

    • Rank — (Integer)

      Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.

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:

      • ResourceGroupName — (String)

        The name of the resource group.

      • LogPattern — (map)

        The successfully created log pattern.

        • PatternSetName — (String)

          The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • PatternName — (String)

          The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

        • Pattern — (String)

          A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

        • Rank — (Integer)

          Rank of the log pattern. Must be a value between 1 and 1,000,000. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank 1 will be the first to get matched to a log line. A pattern of rank 1,000,000 will be last to get matched. When you configure custom log patterns from the console, a Low severity pattern translates to a 750,000 rank. A Medium severity pattern translates to a 500,000 rank. And a High severity pattern translates to a 250,000 rank. Rank values less than 1 or greater than 1,000,000 are reserved for AWS-provided patterns.

Returns:

  • (AWS.Request)

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