Class: AWS.CloudWatchLogs

Inherits:
AWS.Service show all
Identifier:
cloudwatchlogs
API Version:
2014-03-28
Defined in:
(unknown)

Overview

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

Sending a Request Using CloudWatchLogs

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

var cloudwatchlogs = new AWS.CloudWatchLogs({apiVersion: '2014-03-28'});

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

AWS.config.apiVersions = {
  cloudwatchlogs: '2014-03-28',
  // other service API versions
};

var cloudwatchlogs = new AWS.CloudWatchLogs();

Version:

  • 2014-03-28

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

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

Examples:

Constructing a CloudWatchLogs object

var cloudwatchlogs = new AWS.CloudWatchLogs({apiVersion: '2014-03-28'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CloudWatchLogs.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

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

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

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Service Reference:

Examples:

Calling the associateKmsKey operation

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

Parameters:

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.

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

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

Service Reference:

Examples:

Calling the cancelExportTask operation

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

      The ID of the export task.

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.

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

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Service Reference:

Examples:

Calling the createExportTask operation

var params = {
  destination: 'STRING_VALUE', /* required */
  from: 0, /* required */
  logGroupName: 'STRING_VALUE', /* required */
  to: 0, /* required */
  destinationPrefix: 'STRING_VALUE',
  logStreamNamePrefix: 'STRING_VALUE',
  taskName: 'STRING_VALUE'
};
cloudwatchlogs.createExportTask(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: {})
    • taskName — (String)

      The name of the export task.

    • logGroupName — (String)

      The name of the log group.

    • logStreamNamePrefix — (String)

      Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

    • from — (Integer)

      The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.

    • to — (Integer)

      The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.

    • destination — (String)

      The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

    • destinationPrefix — (String)

      The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

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:

      • taskId — (String)

        The ID of the export task.

Returns:

  • (AWS.Request)

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

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

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

Service Reference:

Examples:

Calling the createLogGroup operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  kmsKeyId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cloudwatchlogs.createLogGroup(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: {})
    • logGroupName — (String)

      The name of the log group.

    • kmsKeyId — (String)

      The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

    • tags — (map<String>)

      The key-value pairs to use for the tags.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

Service Reference:

Examples:

Calling the createLogStream operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  logStreamName: 'STRING_VALUE' /* required */
};
cloudwatchlogs.createLogStream(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: {})
    • logGroupName — (String)

      The name of the log group.

    • logStreamName — (String)

      The name of the log stream.

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.

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

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

Service Reference:

Examples:

Calling the deleteDestination operation

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

      The name of the destination.

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.

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

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

Service Reference:

Examples:

Calling the deleteLogGroup operation

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

      The name of the log 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.

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

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

Service Reference:

Examples:

Calling the deleteLogStream operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  logStreamName: 'STRING_VALUE' /* required */
};
cloudwatchlogs.deleteLogStream(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: {})
    • logGroupName — (String)

      The name of the log group.

    • logStreamName — (String)

      The name of the log stream.

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.

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

Deletes the specified metric filter.

Service Reference:

Examples:

Calling the deleteMetricFilter operation

var params = {
  filterName: 'STRING_VALUE', /* required */
  logGroupName: 'STRING_VALUE' /* required */
};
cloudwatchlogs.deleteMetricFilter(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: {})
    • logGroupName — (String)

      The name of the log group.

    • filterName — (String)

      The name of the metric filter.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  policyName: 'STRING_VALUE'
};
cloudwatchlogs.deleteResourcePolicy(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: {})
    • policyName — (String)

      The name of the policy to be revoked. This parameter is required.

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.

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

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

Service Reference:

Examples:

Calling the deleteRetentionPolicy operation

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

      The name of the log 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.

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

Deletes the specified subscription filter.

Service Reference:

Examples:

Calling the deleteSubscriptionFilter operation

var params = {
  filterName: 'STRING_VALUE', /* required */
  logGroupName: 'STRING_VALUE' /* required */
};
cloudwatchlogs.deleteSubscriptionFilter(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: {})
    • logGroupName — (String)

      The name of the log group.

    • filterName — (String)

      The name of the subscription filter.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Lists all your destinations. The results are ASCII-sorted by destination name.

Service Reference:

Examples:

Calling the describeDestinations operation

var params = {
  DestinationNamePrefix: 'STRING_VALUE',
  limit: 0,
  nextToken: 'STRING_VALUE'
};
cloudwatchlogs.describeDestinations(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: {})
    • DestinationNamePrefix — (String)

      The prefix to match. If you don't specify a value, no prefix filter is applied.

    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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:

      • destinations — (Array<map>)

        The destinations.

        • destinationName — (String)

          The name of the destination.

        • targetArn — (String)

          The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).

        • roleArn — (String)

          A role for impersonation, used when delivering log events to the target.

        • accessPolicy — (String)

          An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

        • arn — (String)

          The ARN of this destination.

        • creationTime — (Integer)

          The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

Service Reference:

Examples:

Calling the describeExportTasks operation

var params = {
  limit: 0,
  nextToken: 'STRING_VALUE',
  statusCode: CANCELLED | COMPLETED | FAILED | PENDING | PENDING_CANCEL | RUNNING,
  taskId: 'STRING_VALUE'
};
cloudwatchlogs.describeExportTasks(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: {})
    • taskId — (String)

      The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

    • statusCode — (String)

      The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

      Possible values include:
      • "CANCELLED"
      • "COMPLETED"
      • "FAILED"
      • "PENDING"
      • "PENDING_CANCEL"
      • "RUNNING"
    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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:

      • exportTasks — (Array<map>)

        The export tasks.

        • taskId — (String)

          The ID of the export task.

        • taskName — (String)

          The name of the export task.

        • logGroupName — (String)

          The name of the log group from which logs data was exported.

        • from — (Integer)

          The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not exported.

        • to — (Integer)

          The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.

        • destination — (String)

          The name of Amazon S3 bucket to which the log data was exported.

        • destinationPrefix — (String)

          The prefix that was used as the start of Amazon S3 key for every object exported.

        • status — (map)

          The status of the export task.

          • code — (String)

            The status code of the export task.

            Possible values include:
            • "CANCELLED"
            • "COMPLETED"
            • "FAILED"
            • "PENDING"
            • "PENDING_CANCEL"
            • "RUNNING"
          • message — (String)

            The status message related to the status code.

        • executionInfo — (map)

          Execution info about the export task.

          • creationTime — (Integer)

            The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

          • completionTime — (Integer)

            The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

Service Reference:

Examples:

Calling the describeLogGroups operation

var params = {
  limit: 0,
  logGroupNamePrefix: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
cloudwatchlogs.describeLogGroups(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: {})
    • logGroupNamePrefix — (String)

      The prefix to match.

    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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:

      • logGroups — (Array<map>)

        The log groups.

        • logGroupName — (String)

          The name of the log group.

        • creationTime — (Integer)

          The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • retentionInDays — (Integer)

          The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

        • metricFilterCount — (Integer)

          The number of metric filters.

        • arn — (String)

          The Amazon Resource Name (ARN) of the log group.

        • storedBytes — (Integer)

          The number of bytes stored.

        • kmsKeyId — (String)

          The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

Service Reference:

Examples:

Calling the describeLogStreams operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  descending: true || false,
  limit: 0,
  logStreamNamePrefix: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  orderBy: LogStreamName | LastEventTime
};
cloudwatchlogs.describeLogStreams(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: {})
    • logGroupName — (String)

      The name of the log group.

    • logStreamNamePrefix — (String)

      The prefix to match.

      iIf orderBy is LastEventTime,you cannot specify this parameter.

    • orderBy — (String)

      If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

      If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

      lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

      Possible values include:
      • "LogStreamName"
      • "LastEventTime"
    • descending — (Boolean)

      If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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:

      • logStreams — (Array<map>)

        The log streams.

        • logStreamName — (String)

          The name of the log stream.

        • creationTime — (Integer)

          The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • firstEventTimestamp — (Integer)

          The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • lastEventTimestamp — (Integer)

          the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTime updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

        • lastIngestionTime — (Integer)

          The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • uploadSequenceToken — (String)

          The sequence token.

        • arn — (String)

          The Amazon Resource Name (ARN) of the log stream.

        • storedBytes — (Integer)

          The number of bytes stored.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

Service Reference:

Examples:

Calling the describeMetricFilters operation

var params = {
  filterNamePrefix: 'STRING_VALUE',
  limit: 0,
  logGroupName: 'STRING_VALUE',
  metricName: 'STRING_VALUE',
  metricNamespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
cloudwatchlogs.describeMetricFilters(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: {})
    • logGroupName — (String)

      The name of the log group.

    • filterNamePrefix — (String)

      The prefix to match.

    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

    • metricName — (String)

      The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.

    • metricNamespace — (String)

      The namespace of the CloudWatch metric.

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:

      • metricFilters — (Array<map>)

        The metric filters.

        • filterName — (String)

          The name of the metric filter.

        • filterPattern — (String)

          A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

        • metricTransformations — (Array<map>)

          The metric transformations.

          • metricNamerequired — (String)

            The name of the CloudWatch metric.

          • metricNamespacerequired — (String)

            The namespace of the CloudWatch metric.

          • metricValuerequired — (String)

            The value to publish to the CloudWatch metric when a filter pattern matches a log event.

          • defaultValue — (Float)

            (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

        • creationTime — (Integer)

          The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • logGroupName — (String)

          The name of the log group.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the resource policies in this account.

Service Reference:

Examples:

Calling the describeResourcePolicies operation

var params = {
  limit: 0,
  nextToken: 'STRING_VALUE'
};
cloudwatchlogs.describeResourcePolicies(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: {})
    • nextToken — (String)

      The token for the next set of items to return. The token expires after 24 hours.

    • limit — (Integer)

      The maximum number of resource policies to be displayed with one call of this API.

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:

      • resourcePolicies — (Array<map>)

        The resource policies that exist in this account.

        • policyName — (String)

          The name of the resource policy.

        • policyDocument — (String)

          The details of the policy.

        • lastUpdatedTime — (Integer)

          Time stamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

Service Reference:

Examples:

Calling the describeSubscriptionFilters operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  filterNamePrefix: 'STRING_VALUE',
  limit: 0,
  nextToken: 'STRING_VALUE'
};
cloudwatchlogs.describeSubscriptionFilters(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: {})
    • logGroupName — (String)

      The name of the log group.

    • filterNamePrefix — (String)

      The prefix to match. If you don't specify a value, no prefix filter is applied.

    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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:

      • subscriptionFilters — (Array<map>)

        The subscription filters.

        • filterName — (String)

          The name of the subscription filter.

        • logGroupName — (String)

          The name of the log group.

        • filterPattern — (String)

          A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

        • destinationArn — (String)

          The Amazon Resource Name (ARN) of the destination.

        • roleArn — (String)

        • distribution — (String)

          The method used to distribute log data to the destination, which can be either random or grouped by log stream.

          Possible values include:
          • "Random"
          • "ByLogStream"
        • creationTime — (Integer)

          The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • nextToken — (String)

        The token for the next set of items to return. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

Service Reference:

Examples:

Calling the disassociateKmsKey operation

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

      The name of the log 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.

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

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

Service Reference:

Examples:

Calling the filterLogEvents operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  endTime: 0,
  filterPattern: 'STRING_VALUE',
  interleaved: true || false,
  limit: 0,
  logStreamNames: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE',
  startTime: 0
};
cloudwatchlogs.filterLogEvents(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: {})
    • logGroupName — (String)

      The name of the log group.

    • logStreamNames — (Array<String>)

      Optional list of log stream names.

    • startTime — (Integer)

      The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.

    • endTime — (Integer)

      The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.

    • filterPattern — (String)

      The filter pattern to use. If not provided, all the events are matched.

    • nextToken — (String)

      The token for the next set of events to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of events to return. The default is 10,000 events.

    • interleaved — (Boolean)

      If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

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:

      • events — (Array<map>)

        The matched events.

        • logStreamName — (String)

          The name of the log stream this event belongs to.

        • timestamp — (Integer)

          The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • message — (String)

          The data contained in the log event.

        • ingestionTime — (Integer)

          The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • eventId — (String)

          The ID of the event.

      • searchedLogStreams — (Array<map>)

        Indicates which log streams have been searched and whether each has been searched completely.

        • logStreamName — (String)

          The name of the log stream.

        • searchedCompletely — (Boolean)

          Indicates whether all the events in this log stream were searched.

      • nextToken — (String)

        The token to use when requesting the next set of items. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

Service Reference:

Examples:

Calling the getLogEvents operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  logStreamName: 'STRING_VALUE', /* required */
  endTime: 0,
  limit: 0,
  nextToken: 'STRING_VALUE',
  startFromHead: true || false,
  startTime: 0
};
cloudwatchlogs.getLogEvents(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: {})
    • logGroupName — (String)

      The name of the log group.

    • logStreamName — (String)

      The name of the log stream.

    • startTime — (Integer)

      The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not included.

    • endTime — (Integer)

      The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not included.

    • nextToken — (String)

      The token for the next set of items to return. (You received this token from a previous call.)

    • limit — (Integer)

      The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

    • startFromHead — (Boolean)

      If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

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:

      • events — (Array<map>)

        The events.

        • timestamp — (Integer)

          The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

        • message — (String)

          The data contained in the log event.

        • ingestionTime — (Integer)

          The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

      • nextForwardToken — (String)

        The token for the next set of items in the forward direction. The token expires after 24 hours.

      • nextBackwardToken — (String)

        The token for the next set of items in the backward direction. The token expires after 24 hours.

Returns:

  • (AWS.Request)

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

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

Lists the tags for the specified log group.

Service Reference:

Examples:

Calling the listTagsLogGroup operation

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

      The name of the log 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:

      • tags — (map<String>)

        The tags for the log group.

Returns:

  • (AWS.Request)

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

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

Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.

Through an access policy, a destination controls what is written to its Kinesis stream. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

Service Reference:

Examples:

Calling the putDestination operation

var params = {
  destinationName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  targetArn: 'STRING_VALUE' /* required */
};
cloudwatchlogs.putDestination(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: {})
    • destinationName — (String)

      A name for the destination.

    • targetArn — (String)

      The ARN of an Amazon Kinesis stream to which to deliver matching log events.

    • roleArn — (String)

      The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

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:

      • destination — (map)

        The destination.

        • destinationName — (String)

          The name of the destination.

        • targetArn — (String)

          The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).

        • roleArn — (String)

          A role for impersonation, used when delivering log events to the target.

        • accessPolicy — (String)

          An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

        • arn — (String)

          The ARN of this destination.

        • creationTime — (Integer)

          The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Returns:

  • (AWS.Request)

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

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

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

Service Reference:

Examples:

Calling the putDestinationPolicy operation

var params = {
  accessPolicy: 'STRING_VALUE', /* required */
  destinationName: 'STRING_VALUE' /* required */
};
cloudwatchlogs.putDestinationPolicy(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: {})
    • destinationName — (String)

      A name for an existing destination.

    • accessPolicy — (String)

      An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination.

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.

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

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

Service Reference:

Examples:

Calling the putLogEvents operation

var params = {
  logEvents: [ /* required */
    {
      message: 'STRING_VALUE', /* required */
      timestamp: 0 /* required */
    },
    /* more items */
  ],
  logGroupName: 'STRING_VALUE', /* required */
  logStreamName: 'STRING_VALUE', /* required */
  sequenceToken: 'STRING_VALUE'
};
cloudwatchlogs.putLogEvents(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: {})
    • logGroupName — (String)

      The name of the log group.

    • logStreamName — (String)

      The name of the log stream.

    • logEvents — (Array<map>)

      The log events.

      • timestamprequired — (Integer)

        The time the event occurred, expressed as the number of milliseconds fter Jan 1, 1970 00:00:00 UTC.

      • messagerequired — (String)

        The raw event message.

    • sequenceToken — (String)

      The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

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:

      • nextSequenceToken — (String)

        The next sequence token.

      • rejectedLogEventsInfo — (map)

        The rejected events.

        • tooNewLogEventStartIndex — (Integer)

          The log events that are too new.

        • tooOldLogEventEndIndex — (Integer)

          The log events that are too old.

        • expiredLogEventEndIndex — (Integer)

          The expired log events.

Returns:

  • (AWS.Request)

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

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

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

Service Reference:

Examples:

Calling the putMetricFilter operation

var params = {
  filterName: 'STRING_VALUE', /* required */
  filterPattern: 'STRING_VALUE', /* required */
  logGroupName: 'STRING_VALUE', /* required */
  metricTransformations: [ /* required */
    {
      metricName: 'STRING_VALUE', /* required */
      metricNamespace: 'STRING_VALUE', /* required */
      metricValue: 'STRING_VALUE', /* required */
      defaultValue: 0.0
    },
    /* more items */
  ]
};
cloudwatchlogs.putMetricFilter(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: {})
    • logGroupName — (String)

      The name of the log group.

    • filterName — (String)

      A name for the metric filter.

    • filterPattern — (String)

      A filter pattern for extracting metric data out of ingested log events.

    • metricTransformations — (Array<map>)

      A collection of information that defines how metric data gets emitted.

      • metricNamerequired — (String)

        The name of the CloudWatch metric.

      • metricNamespacerequired — (String)

        The namespace of the CloudWatch metric.

      • metricValuerequired — (String)

        The value to publish to the CloudWatch metric when a filter pattern matches a log event.

      • defaultValue — (Float)

        (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

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.

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

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  policyDocument: 'STRING_VALUE',
  policyName: 'STRING_VALUE'
};
cloudwatchlogs.putResourcePolicy(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: {})
    • policyName — (String)

      Name of the new policy. This parameter is required.

    • policyDocument — (String)

      Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.

      The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

      { "Version": "2012-10-17" "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": logArn } ] }

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:

      • resourcePolicy — (map)

        The new policy.

        • policyName — (String)

          The name of the resource policy.

        • policyDocument — (String)

          The details of the policy.

        • lastUpdatedTime — (Integer)

          Time stamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Returns:

  • (AWS.Request)

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

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

Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

Service Reference:

Examples:

Calling the putRetentionPolicy operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  retentionInDays: 0 /* required */
};
cloudwatchlogs.putRetentionPolicy(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: {})
    • logGroupName — (String)

      The name of the log group.

    • retentionInDays — (Integer)

      The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

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.

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

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

Service Reference:

Examples:

Calling the putSubscriptionFilter operation

var params = {
  destinationArn: 'STRING_VALUE', /* required */
  filterName: 'STRING_VALUE', /* required */
  filterPattern: 'STRING_VALUE', /* required */
  logGroupName: 'STRING_VALUE', /* required */
  distribution: Random | ByLogStream,
  roleArn: 'STRING_VALUE'
};
cloudwatchlogs.putSubscriptionFilter(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: {})
    • logGroupName — (String)

      The name of the log group.

    • filterName — (String)

      A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

    • filterPattern — (String)

      A filter pattern for subscribing to a filtered stream of log events.

    • destinationArn — (String)

      The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

      • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

      • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

      • An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

      • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

    • roleArn — (String)

      The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

    • distribution — (String)

      The method used to distribute log data to the destination. By default log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.

      Possible values include:
      • "Random"
      • "ByLogStream"

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.

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

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

Service Reference:

Examples:

Calling the tagLogGroup operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cloudwatchlogs.tagLogGroup(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: {})
    • logGroupName — (String)

      The name of the log group.

    • tags — (map<String>)

      The key-value pairs to use for the tags.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

Service Reference:

Examples:

Calling the testMetricFilter operation

var params = {
  filterPattern: 'STRING_VALUE', /* required */
  logEventMessages: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatchlogs.testMetricFilter(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: {})
    • filterPattern — (String)

      A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

    • logEventMessages — (Array<String>)

      The log event messages to test.

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:

      • matches — (Array<map>)

        The matched events.

        • eventNumber — (Integer)

          The event number.

        • eventMessage — (String)

          The raw event data.

        • extractedValues — (map<String>)

          The values extracted from the event data by the filter.

Returns:

  • (AWS.Request)

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

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

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

Service Reference:

Examples:

Calling the untagLogGroup operation

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  tags: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatchlogs.untagLogGroup(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: {})
    • logGroupName — (String)

      The name of the log group.

    • tags — (Array<String>)

      The tag keys. The corresponding tags are removed from the log 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.