Class: AWS.CloudWatchLogs

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.

var params = {
  destination: 'STRING_VALUE', /* required */
  from: 'NUMBER_VALUE', /* required */
  logGroupName: 'STRING_VALUE', /* required */
  to: 'NUMBER_VALUE', /* 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 timestamp 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 timestamp later than this time are not exported.

    You must specify a time that is not earlier than when this log group was created.

  • destination — (String)

    The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services 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.

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 KMS key to use when encrypting log data. For more information, see Amazon Resource Names.

  • tags — (map<String>)

    The key-value pairs to use for the tags.

    You can grant users access to certain log groups while preventing them from accessing other log groups. To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when you create a log group, you must have either the logs:TagResource or logs:TagLogGroup permission. For more information about tagging, see Tagging Amazon Web Services resources. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using 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.

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.

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

    The name or ARN of the log group that you want to delete the data protection policy 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.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

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

    The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

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:

    • success — (Boolean)

      A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.

Returns:

• (AWS.Request) —

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

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.

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.

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.

var params = {
  DestinationNamePrefix: 'STRING_VALUE',
  limit: 'NUMBER_VALUE',
  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 maximum value of 50 items is used.

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 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 Amazon Web Services 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.

var params = {
  limit: 'NUMBER_VALUE',
  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 one or zero 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 timestamp 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 timestamp later than this time are not exported.

      • destination — (String)

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

var params = {
  accountIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  includeLinkedAccounts: true || false,
  limit: 'NUMBER_VALUE',
  logGroupNamePattern: 'STRING_VALUE',
  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: {}) —
  • accountIdentifiers — (Array<String>)

    When includeLinkedAccounts is set to True, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

  • logGroupNamePrefix — (String)

    The prefix to match.

    Note: logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.
  • logGroupNamePattern — (String)

    If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo would not match.

    Note: logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.
  • 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.

  • includeLinkedAccounts — (Boolean)

    If you are using a monitoring account, set this to True to have the operation return log groups in the accounts listed in accountIdentifiers.

    If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

    Note: If you specify includeLinkedAccounts in your request, then metricFilterCount, retentionInDays, and storedBytes are not included in the response.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • logGroups — (Array<map>)

      The log groups.

      If the retentionInDays value is not included for a log group, then that log group's events do not expire.

      • 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, 2192, 2557, 2922, 3288, and 3653.

        To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

      • 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 KMS key to use when encrypting log data.

      • dataProtectionStatus — (String)

        Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.

        Possible values include:
        • "ACTIVATED"
        • "DELETED"
        • "ARCHIVED"
        • "DISABLED"
    • 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.

var params = {
  descending: true || false,
  limit: 'NUMBER_VALUE',
  logGroupIdentifier: 'STRING_VALUE',
  logGroupName: 'STRING_VALUE',
  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.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • logGroupIdentifier — (String)

    Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • logStreamNamePrefix — (String)

    The prefix to match.

    If 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 in rare situations might take longer.

    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. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

      • lastIngestionTime — (Integer)

        The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but in rare situations might take longer.

      • uploadSequenceToken — (String)

        The sequence token.

        The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken to use a PutLogEvents action.

      • arn — (String)

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

      • storedBytes — (Integer)

        The number of bytes stored.

        Important: As of June 17, 2019, this parameter is no longer supported for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

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

var params = {
  filterNamePrefix: 'STRING_VALUE',
  limit: 'NUMBER_VALUE',
  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. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.

  • 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)

    Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.

  • metricNamespace — (String)

    Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName 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:

    • 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 can contain timestamps, 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.

        • metricName — required — (String)

          The name of the CloudWatch metric.

        • metricNamespace — required — (String)

          A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

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

        • dimensions — (map<String>)

          The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

          Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

          CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

          You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

        • unit — (String)

          The unit to assign to the metric. If you omit this, the unit is set as None.

          Possible values include:
          • "Seconds"
          • "Microseconds"
          • "Milliseconds"
          • "Bytes"
          • "Kilobytes"
          • "Megabytes"
          • "Gigabytes"
          • "Terabytes"
          • "Bits"
          • "Kilobits"
          • "Megabits"
          • "Gigabits"
          • "Terabits"
          • "Percent"
          • "Count"
          • "Bytes/Second"
          • "Kilobytes/Second"
          • "Megabytes/Second"
          • "Gigabytes/Second"
          • "Terabytes/Second"
          • "Bits/Second"
          • "Kilobits/Second"
          • "Megabits/Second"
          • "Gigabits/Second"
          • "Terabits/Second"
          • "Count/Second"
          • "None"
      • 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.

var params = {
  logGroupName: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: Scheduled | Running | Complete | Failed | Cancelled | Timeout | Unknown
};
cloudwatchlogs.describeQueries(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)

    Limits the returned queries to only those for the specified log group.

  • status — (String)

    Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

    Possible values include:
    • "Scheduled"
    • "Running"
    • "Complete"
    • "Failed"
    • "Cancelled"
    • "Timeout"
    • "Unknown"
  • maxResults — (Integer)

    Limits the number of returned queries to the specified number.

  • nextToken — (String)

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

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:

    • queries — (Array<map>)

      The list of queries that match the request.

      • queryId — (String)

        The unique ID number of this query.

      • queryString — (String)

        The query string used in this query.

      • status — (String)

        The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

        Possible values include:
        • "Scheduled"
        • "Running"
        • "Complete"
        • "Failed"
        • "Cancelled"
        • "Timeout"
        • "Unknown"
      • createTime — (Integer)

        The date and time that this query was created.

      • logGroupName — (String)

        The name of the log group scanned by this query.

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

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

    Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.

  • maxResults — (Integer)

    Limits the number of returned query definitions to the specified number.

  • nextToken — (String)

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

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:

    • queryDefinitions — (Array<map>)

      The list of query definitions that match your request.

      • queryDefinitionId — (String)

        The unique ID of the query definition.

      • name — (String)

        The name of the query definition.

      • queryString — (String)

        The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

      • lastModified — (Integer)

        The date that the query definition was most recently modified.

      • logGroupNames — (Array<String>)

        If this query definition contains a list of log groups that it is limited to, that list appears here.

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

var params = {
  limit: 'NUMBER_VALUE',
  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)

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

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  filterNamePrefix: 'STRING_VALUE',
  limit: 'NUMBER_VALUE',
  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 can contain timestamps, 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.

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.

var params = {
  endTime: 'NUMBER_VALUE',
  filterPattern: 'STRING_VALUE',
  interleaved: true || false,
  limit: 'NUMBER_VALUE',
  logGroupIdentifier: 'STRING_VALUE',
  logGroupName: 'STRING_VALUE',
  logStreamNamePrefix: 'STRING_VALUE',
  logStreamNames: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE',
  startTime: 'NUMBER_VALUE',
  unmask: true || false
};
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 to search.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • logGroupIdentifier — (String)

    Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • logStreamNames — (Array<String>)

    Filters the results to only logs from the log streams in this list.

    If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

  • logStreamNamePrefix — (String)

    Filters the results to include only events from log streams that have names starting with this prefix.

    If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

  • 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 timestamp 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 timestamp later than this time are not returned.

  • filterPattern — (String)

    The filter pattern to use. For more information, see Filter and Pattern Syntax.

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

    Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

  • unmask — (Boolean)

    Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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 to which this event belongs.

      • 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>)

      Important As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

      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.

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

    The name or ARN of the log group that contains the data protection policy that you want to see.

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:

    • logGroupIdentifier — (String)

      The log group name or ARN that you specified in your request.

    • policyDocument — (String)

      The data protection policy document for this log group.

    • lastUpdatedTime — (Integer)

      The date and time that this policy was most recently updated.

Returns:

• (AWS.Request) —

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

var params = {
  logStreamName: 'STRING_VALUE', /* required */
  endTime: 'NUMBER_VALUE',
  limit: 'NUMBER_VALUE',
  logGroupIdentifier: 'STRING_VALUE',
  logGroupName: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  startFromHead: true || false,
  startTime: 'NUMBER_VALUE',
  unmask: true || false
};
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.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • logGroupIdentifier — (String)

    Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • 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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to or 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 limit, the default 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.

    If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

  • unmask — (Boolean)

    Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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. If you have reached the end of the stream, it returns the same token you passed in.

    • nextBackwardToken — (String)

      The token for the next set of items in the backward direction. The token expires after 24 hours. This token is not null. If you have reached the end of the stream, it returns the same token you passed in.

Returns:

• (AWS.Request) —

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

var params = {
  logGroupIdentifier: 'STRING_VALUE',
  logGroupName: 'STRING_VALUE',
  time: 'NUMBER_VALUE'
};
cloudwatchlogs.getLogGroupFields(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 to search.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.
  • time — (Integer)

    The time to set as the center of the query. If you specify time, the 15 minutes before this time are queries. If you omit time, the 8 minutes before and 8 minutes after this time are searched.

    The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

  • logGroupIdentifier — (String)

    Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

    Note: You must include either logGroupIdentifier or logGroupName, but not both.

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:

    • logGroupFields — (Array<map>)

      The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.

      • name — (String)

        The name of a log field.

      • percent — (Integer)

        The percentage of log events queried that contained the field.

Returns:

• (AWS.Request) —

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

var params = {
  logRecordPointer: 'STRING_VALUE', /* required */
  unmask: true || false
};
cloudwatchlogs.getLogRecord(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: {}) —
  • logRecordPointer — (String)

    The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.

  • unmask — (Boolean)

    Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

    To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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:

    • logRecord — (map<String>)

      The requested log event, as a JSON string.

Returns:

• (AWS.Request) —

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

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

    The ID number of the query.

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:

    • results — (Array<Array<map>>)

      The log events that matched the query criteria during the most recent time it ran.

      The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

      • field — (String)

        The log event field.

      • value — (String)

        The value of this field.

    • statistics — (map)

      Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query.

      • recordsMatched — (Float)

        The number of log events that matched the query string.

      • recordsScanned — (Float)

        The total number of log events scanned during the query.

      • bytesScanned — (Float)

        The total number of bytes in the log events scanned during the query.

    • status — (String)

      The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

      Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

      Possible values include:
      • "Scheduled"
      • "Running"
      • "Complete"
      • "Failed"
      • "Cancelled"
      • "Timeout"
      • "Unknown"

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The ARN of the resource that you want to view tags for.

    The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

    The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

    For more information about ARN format, see CloudWatch Logs resources and operations.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • tags — (map<String>)

      The list of tags associated with the requested resource.>

Returns:

• (AWS.Request) —

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

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.

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

    Specify either the log group name or log group ARN.

  • policyDocument — (String)

    Specify the data protection policy, in JSON.

    This policy must include two JSON blocks:

    • The first block must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.

      The Operation property with an Audit action is required to find the sensitive data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.

    • The second block must include both a DataIdentifer array and an Operation property with an Deidentify action. The DataIdentifer array must exactly match the DataIdentifer array in the first block of the policy.

      The Operation property with the Deidentify action is what actually masks the data, and it must contain the "MaskConfig": {} object. The "MaskConfig": {} object must be empty.

    For an example data protection policy, see the Examples section on this page.

    The contents of two DataIdentifer arrays must match exactly.

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:

    • logGroupIdentifier — (String)

      The log group name or ARN that you specified in your request.

    • policyDocument — (String)

      The data protection policy used for this log group.

    • lastUpdatedTime — (Integer)

      The date and time that this policy was most recently updated.

Returns:

• (AWS.Request) —

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

var params = {
  destinationName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  targetArn: 'STRING_VALUE', /* required */
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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.

  • tags — (map<String>)

    An optional list of key-value pairs to associate with the resource.

    For more information about tagging, see Tagging Amazon Web Services resources

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 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 Amazon Web Services 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.

var params = {
  accessPolicy: 'STRING_VALUE', /* required */
  destinationName: 'STRING_VALUE', /* required */
  forceUpdate: true || false
};
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. This can be up to 5120 bytes.

  • forceUpdate — (Boolean)

    Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. Before you update a destination policy this way, you must first update the subscription filters in the accounts that send logs to this destination. If you do not, the subscription filters might stop working. By specifying true for forceUpdate, you are affirming that you have already updated the subscription filters. For more information, see Updating an existing cross-account subscription

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  logEvents: [ /* required */
    {
      message: 'STRING_VALUE', /* required */
      timestamp: 'NUMBER_VALUE' /* 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.

    • timestamp — required — (Integer)

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

    • message — required — (String)

      The raw event message.

  • sequenceToken — (String)

    The sequence token obtained from the response of the previous PutLogEvents call.

    The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.

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.

      This field has been deprecated.

      The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream and you do not need to wait for the response of a previous PutLogEvents action to obtain the nextSequenceToken value.

    • rejectedLogEventsInfo — (map)

      The rejected events.

      • tooNewLogEventStartIndex — (Integer)

        The log events that are too new.

      • tooOldLogEventEndIndex — (Integer)

        The log events that are dated too far in the past.

      • expiredLogEventEndIndex — (Integer)

        The expired log events.

Returns:

• (AWS.Request) —

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

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: 'NUMBER_VALUE',
      dimensions: {
        '<DimensionsKey>': 'STRING_VALUE',
        /* '<DimensionsKey>': ... */
      },
      unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None
    },
    /* 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.

    • metricName — required — (String)

      The name of the CloudWatch metric.

    • metricNamespace — required — (String)

      A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.

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

    • dimensions — (map<String>)

      The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.

      Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.

      CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.

      You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.

    • unit — (String)

      The unit to assign to the metric. If you omit this, the unit is set as None.

      Possible values include:
      • "Seconds"
      • "Microseconds"
      • "Milliseconds"
      • "Bytes"
      • "Kilobytes"
      • "Megabytes"
      • "Gigabytes"
      • "Terabytes"
      • "Bits"
      • "Kilobits"
      • "Megabits"
      • "Gigabits"
      • "Terabits"
      • "Percent"
      • "Count"
      • "Bytes/Second"
      • "Kilobytes/Second"
      • "Megabytes/Second"
      • "Gigabytes/Second"
      • "Terabytes/Second"
      • "Bits/Second"
      • "Kilobits/Second"
      • "Megabits/Second"
      • "Gigabits/Second"
      • "Terabits/Second"
      • "Count/Second"
      • "None"

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  queryString: 'STRING_VALUE', /* required */
  logGroupNames: [
    'STRING_VALUE',
    /* more items */
  ],
  queryDefinitionId: 'STRING_VALUE'
};
cloudwatchlogs.putQueryDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    A name for the query definition. If you are saving numerous query definitions, we recommend that you name them. This way, you can find the ones you want by using the first part of the name as a filter in the queryDefinitionNamePrefix parameter of DescribeQueryDefinitions.

  • queryDefinitionId — (String)

    If you are updating a query definition, use this parameter to specify the ID of the query definition that you want to update. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.

    If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.

  • logGroupNames — (Array<String>)

    Use this parameter to include specific log groups as part of your query definition.

    If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.

  • queryString — (String)

    The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.

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:

    • queryDefinitionId — (String)

      The ID of the query definition.

Returns:

• (AWS.Request) —

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

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. This parameter is required.

    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.

    CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

    In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs. You would also replace the value of SourceAccount with the Amazon Web Services account ID making that call.

    { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }

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)

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

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  retentionInDays: 'NUMBER_VALUE' /* 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, 2192, 2557, 2922, 3288, and 3653.

    To set a log group so that its log events do not expire, use DeleteRetentionPolicy.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  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. 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.

      If you're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.

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

    • A 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 data 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.

var params = {
  endTime: 'NUMBER_VALUE', /* required */
  queryString: 'STRING_VALUE', /* required */
  startTime: 'NUMBER_VALUE', /* required */
  limit: 'NUMBER_VALUE',
  logGroupIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  logGroupName: 'STRING_VALUE',
  logGroupNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudwatchlogs.startQuery(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 log group on which to perform the query.

    Note: A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
  • logGroupNames — (Array<String>)

    The list of log groups to be queried. You can include up to 50 log groups.

    Note: A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.
  • logGroupIdentifiers — (Array<String>)

    The list of log groups to query. You can include up to 50 log groups.

    You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

    If you specify an ARN, the ARN can't end with an asterisk (*).

    A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames or logGroupIdentifiers.

  • startTime — (Integer)

    The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

  • endTime — (Integer)

    The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

  • queryString — (String)

    The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

  • limit — (Integer)

    The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

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:

    • queryId — (String)

      The unique ID of the query.

Returns:

• (AWS.Request) —

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

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

    The ID number of the query to stop. To find this ID number, use DescribeQueries.

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:

    • success — (Boolean)

      This is true if the query was stopped by the StopQuery operation.

Returns:

• (AWS.Request) —

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

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.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cloudwatchlogs.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The ARN of the resource that you're adding tags to.

    The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

    The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

    For more information about ARN format, see CloudWatch Logs resources and operations.

  • tags — (map<String>)

    The list of key-value pairs to associate with the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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 can contain timestamps, 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.

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.

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

Parameters:

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

    The ARN of the CloudWatch Logs resource that you're removing tags from.

    The ARN format of a log group is arn:aws:logs:Region:account-id:log-group:log-group-name

    The ARN format of a destination is arn:aws:logs:Region:account-id:destination:destination-name

    For more information about ARN format, see CloudWatch Logs resources and operations.

  • tagKeys — (Array<String>)

    The list of tag keys to remove from the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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