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 = {
  deliveryDestinationArn: 'STRING_VALUE', /* required */
  deliverySourceName: 'STRING_VALUE', /* required */
  fieldDelimiter: 'STRING_VALUE',
  recordFields: [
    'STRING_VALUE',
    /* more items */
  ],
  s3DeliveryConfiguration: {
    enableHiveCompatiblePath: true || false,
    suffixPath: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cloudwatchlogs.createDelivery(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: {}) —
  • deliverySourceName — (String)

    The name of the delivery source to use for this delivery.

  • deliveryDestinationArn — (String)

    The ARN of the delivery destination to use for this delivery.

  • recordFields — (Array<String>)

    The list of record fields to be delivered to the destination, in order. If the delivery’s log source has mandatory fields, they must be included in this list.

  • fieldDelimiter — (String)

    The field delimiter to use between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

  • s3DeliveryConfiguration — (map)

    This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.

    • suffixPath — (String)

      This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

    • enableHiveCompatiblePath — (Boolean)

      This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

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

    • delivery — (map)

      A structure that contains information about the delivery that you just created.

      • id — (String)

        The unique ID that identifies this delivery in your account.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery.

      • deliverySourceName — (String)

        The name of the delivery source that is associated with this delivery.

      • deliveryDestinationArn — (String)

        The ARN of the delivery destination that is associated with this delivery.

      • deliveryDestinationType — (String)

        Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.

        Possible values include:
        • "S3"
        • "CWL"
        • "FH"
      • recordFields — (Array<String>)

        The record fields used in this delivery.

      • fieldDelimiter — (String)

        The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

      • s3DeliveryConfiguration — (map)

        This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

        • suffixPath — (String)

          This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

        • enableHiveCompatiblePath — (Boolean)

          This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

      • tags — (map<String>)

        The tags that have been assigned to this delivery.

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 = {
  logGroupArnList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  anomalyVisibilityTime: 'NUMBER_VALUE',
  detectorName: 'STRING_VALUE',
  evaluationFrequency: ONE_MIN | FIVE_MIN | TEN_MIN | FIFTEEN_MIN | THIRTY_MIN | ONE_HOUR,
  filterPattern: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
cloudwatchlogs.createLogAnomalyDetector(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: {}) —
  • logGroupArnList — (Array<String>)

    An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN.

  • detectorName — (String)

    A name for this anomaly detector.

  • evaluationFrequency — (String)

    Specifies how often the anomaly detector is to run and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then 15 minutes might be a good setting for evaluationFrequency .

    Possible values include:
    • "ONE_MIN"
    • "FIVE_MIN"
    • "TEN_MIN"
    • "FIFTEEN_MIN"
    • "THIRTY_MIN"
    • "ONE_HOUR"
  • filterPattern — (String)

    You can use this parameter to limit the anomaly detection model to examine only log events that match the pattern you specify here. For more information, see Filter and Pattern Syntax.

  • kmsKeyId — (String)

    Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If a key is assigned to an anomaly detector, a user must have permissions for both this key and for the anomaly detector to retrieve information about the anomalies that it finds.

    For more information about using a KMS key and to see the required IAM policy, see Use a KMS key with an anomaly detector.

  • anomalyVisibilityTime — (Integer)

    The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in anomalyVisibilityTime, it will be considered normal going forward and will not be detected as an anomaly.

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

    • anomalyDetectorArn — (String)

      The ARN of the log anomaly detector that you just created.

Returns:

• (AWS.Request) —

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

var params = {
  logGroupName: 'STRING_VALUE', /* required */
  kmsKeyId: 'STRING_VALUE',
  logGroupClass: STANDARD | INFREQUENT_ACCESS,
  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)

    A name for 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.

  • logGroupClass — (String)

    Use this parameter to specify the log group class for this log group. There are two classes:

    • The Standard log class supports all CloudWatch Logs features.

    • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

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

    The value of logGroupClass can't be changed after a log group is created.

    For details about the features supported by each class, see Log classes

    Possible values include:
    • "STANDARD"
    • "INFREQUENT_ACCESS"

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 = {
  policyName: 'STRING_VALUE', /* required */
  policyType: DATA_PROTECTION_POLICY | SUBSCRIPTION_FILTER_POLICY /* required */
};
cloudwatchlogs.deleteAccountPolicy(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 delete.

  • policyType — (String)

    The type of policy to delete.

    Possible values include:
    • "DATA_PROTECTION_POLICY"
    • "SUBSCRIPTION_FILTER_POLICY"

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

    The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries operation.

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 */
};
cloudwatchlogs.deleteDeliveryDestination(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the delivery destination that you want to delete. You can find a list of delivery destionation names by using the DescribeDeliveryDestinations operation.

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

    The name of the delivery destination that you want to delete the 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 = {
  name: 'STRING_VALUE' /* required */
};
cloudwatchlogs.deleteDeliverySource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the delivery source that you want to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

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 = {
  policyType: DATA_PROTECTION_POLICY | SUBSCRIPTION_FILTER_POLICY, /* required */
  accountIdentifiers: [
    'STRING_VALUE',
    /* more items */
  ],
  policyName: 'STRING_VALUE'
};
cloudwatchlogs.describeAccountPolicies(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: {}) —
  • policyType — (String)

    Use this parameter to limit the returned policies to only the policies that match the policy type that you specify.

    Possible values include:
    • "DATA_PROTECTION_POLICY"
    • "SUBSCRIPTION_FILTER_POLICY"
  • policyName — (String)

    Use this parameter to limit the returned policies to only the policy with the name that you specify.

  • accountIdentifiers — (Array<String>)

    If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account observability, you can use this to specify the account ID of a source account. If you do, the operation returns the account policy for the specified account. Currently, you can specify only one account ID in this parameter.

    If you omit this parameter, only the policy in the current account is returned.

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:

    • accountPolicies — (Array<map>)

      An array of structures that contain information about the CloudWatch Logs account policies that match the specified filters.

      • policyName — (String)

        The name of the account policy.

      • policyDocument — (String)

        The policy document for this account policy.

        The JSON specified in policyDocument can be up to 30,720 characters.

      • lastUpdatedTime — (Integer)

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

      • policyType — (String)

        The type of policy for this account policy.

        Possible values include:
        • "DATA_PROTECTION_POLICY"
        • "SUBSCRIPTION_FILTER_POLICY"
      • scope — (String)

        The scope of the account policy.

        Possible values include:
        • "ALL"
      • selectionCriteria — (String)

        The log group selection criteria for this subscription filter policy.

      • accountId — (String)

        The Amazon Web Services account ID that the policy applies to.

Returns:

• (AWS.Request) —

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

var params = {
  deliveryDestinationTypes: [
    S3 | CWL | FH,
    /* more items */
  ],
  limit: 'NUMBER_VALUE',
  logTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE',
  resourceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  service: 'STRING_VALUE'
};
cloudwatchlogs.describeConfigurationTemplates(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: {}) —
  • service — (String)

    Use this parameter to filter the response to include only the configuration templates that apply to the Amazon Web Services service that you specify here.

  • logTypes — (Array<String>)

    Use this parameter to filter the response to include only the configuration templates that apply to the log types that you specify here.

  • resourceTypes — (Array<String>)

    Use this parameter to filter the response to include only the configuration templates that apply to the resource types that you specify here.

  • deliveryDestinationTypes — (Array<String>)

    Use this parameter to filter the response to include only the configuration templates that apply to the delivery destination types that you specify here.

  • nextToken — (String)

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

  • limit — (Integer)

    Use this parameter to limit the number of configuration templates that are returned 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:

    • configurationTemplates — (Array<map>)

      An array of objects, where each object describes one configuration template that matches the filters that you specified in the request.

      • service — (String)

        A string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services..

      • logType — (String)

        A string specifying which log type this configuration template applies to.

      • resourceType — (String)

        A string specifying which resource type this configuration template applies to.

      • deliveryDestinationType — (String)

        A string specifying which destination type this configuration template applies to.

        Possible values include:
        • "S3"
        • "CWL"
        • "FH"
      • defaultDeliveryConfigValues — (map)

        A mapping that displays the default value of each property within a delivery’s configuration, if it is not specified in the request.

        • recordFields — (Array<String>)

          The default record fields that will be delivered when a list of record fields is not provided in a CreateDelivery operation.

        • fieldDelimiter — (String)

          The default field delimiter that is used in a CreateDelivery operation when the field delimiter is not specified in that operation. The field delimiter is used only when the final output delivery is in Plain, W3C, or Raw format.

        • s3DeliveryConfiguration — (map)

          The delivery parameters that are used when you create a delivery to a delivery destination that is an S3 Bucket.

          • suffixPath — (String)

            This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

          • enableHiveCompatiblePath — (Boolean)

            This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

      • allowedFields — (Array<map>)

        The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.

        • name — (String)

          The name to use when specifying this record field in a CreateDelivery or UpdateDeliveryConfiguration operation.

        • mandatory — (Boolean)

          If this is true, the record field must be present in the recordFields parameter provided to a CreateDelivery or UpdateDeliveryConfiguration operation.

      • allowedOutputFormats — (Array<String>)

        The list of delivery destination output formats that are supported by this log source.

      • allowedActionForAllowVendedLogsDeliveryForResource — (String)

        The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling PutDeliverySource.

      • allowedFieldDelimiters — (Array<String>)

        The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain, W3C, or Raw format.

      • allowedSuffixPathFields — (Array<String>)

        The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

    • 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.describeDeliveries(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)

    Optionally specify the maximum number of deliveries to return 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:

    • deliveries — (Array<map>)

      An array of structures. Each structure contains information about one delivery in the account.

      • id — (String)

        The unique ID that identifies this delivery in your account.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery.

      • deliverySourceName — (String)

        The name of the delivery source that is associated with this delivery.

      • deliveryDestinationArn — (String)

        The ARN of the delivery destination that is associated with this delivery.

      • deliveryDestinationType — (String)

        Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.

        Possible values include:
        • "S3"
        • "CWL"
        • "FH"
      • recordFields — (Array<String>)

        The record fields used in this delivery.

      • fieldDelimiter — (String)

        The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

      • s3DeliveryConfiguration — (map)

        This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

        • suffixPath — (String)

          This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

        • enableHiveCompatiblePath — (Boolean)

          This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

      • tags — (map<String>)

        The tags that have been assigned to this delivery.

    • 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.describeDeliveryDestinations(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)

    Optionally specify the maximum number of delivery destinations to return 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:

    • deliveryDestinations — (Array<map>)

      An array of structures. Each structure contains information about one delivery destination in the account.

      • name — (String)

        The name of this delivery destination.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

      • deliveryDestinationType — (String)

        Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.

        Possible values include:
        • "S3"
        • "CWL"
        • "FH"
      • outputFormat — (String)

        The format of the logs that are sent to this delivery destination.

        Possible values include:
        • "json"
        • "plain"
        • "w3c"
        • "raw"
        • "parquet"
      • deliveryDestinationConfiguration — (map)

        A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

        • destinationResourceArn — required — (String)

          The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

      • tags — (map<String>)

        The tags that have been assigned to this delivery destination.

    • 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.describeDeliverySources(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)

    Optionally specify the maximum number of delivery sources to return 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:

    • deliverySources — (Array<map>)

      An array of structures. Each structure contains information about one delivery source in the account.

      • name — (String)

        The unique name of the delivery source.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery source.

      • resourceArns — (Array<String>)

        This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

      • service — (String)

        The Amazon Web Services service that is sending logs.

      • logType — (String)

        The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

      • tags — (map<String>)

        The tags that have been assigned to this delivery source.

    • 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 = {
  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',
  logGroupClass: STANDARD | INFREQUENT_ACCESS,
  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.

    If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

    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.

  • logGroupClass — (String)

    Specifies the log group class for this log group. There are two classes:

    • The Standard log class supports all CloudWatch Logs features.

    • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

    For details about the features supported by each class, see Log classes

    Possible values include:
    • "STANDARD"
    • "INFREQUENT_ACCESS"

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, 1096, 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. This version of the ARN includes a trailing :* after the log group name.

        Use this version to refer to the ARN in IAM policies when specifying permissions for most API actions. The exception is when specifying permissions for TagResource, UntagResource, and ListTagsForResource. The permissions for those three actions require the ARN version that doesn't include a trailing :*.

      • 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"
      • inheritedProperties — (Array<String>)

        Displays all the properties that this log group has inherited from account-level settings.

      • logGroupClass — (String)

        This specifies the log group class for this log group. There are two classes:

        • The Standard log class supports all CloudWatch Logs features.

        • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

        For details about the features supported by each class, see Log classes

        Possible values include:
        • "STANDARD"
        • "INFREQUENT_ACCESS"
      • logGroupArn — (String)

        The Amazon Resource Name (ARN) of the log group. This version of the ARN doesn't include a trailing :* after the log group name.

        Use this version to refer to the ARN in the following situations:

        • In the logGroupIdentifier input field in many CloudWatch Logs APIs.

        • In the resourceArn field in tagging APIs

        • In IAM policies, when specifying permissions for TagResource, UntagResource, and ListTagsForResource.

    • 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',
  resourceIdentifier: 'STRING_VALUE'
};
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.

    In your DisassociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can't specify both.

  • resourceIdentifier — (String)

    Specifies the target for this operation. You must specify one of the following:

    • Specify the ARN of a log group to stop having CloudWatch Logs use the KMS key to encrypt log events that are ingested and stored by that log group. After you run this operation, CloudWatch Logs encrypts ingested log events with the default CloudWatch Logs method. The log group ARN must be in the following format. Replace REGION and ACCOUNT_ID with your Region and account ID.

      arn:aws:logs:REGION:ACCOUNT_ID:log-group:LOG_GROUP_NAME

    • Specify the following ARN to stop using this key to encrypt the results of future StartQuery operations in this account. Replace REGION and ACCOUNT_ID with your Region and account ID.

      arn:aws:logs:REGION:ACCOUNT_ID:query-result:*

    In your DisssociateKmsKey operation, you must specify either the resourceIdentifier parameter or the logGroup parameter, but you can't specify 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.

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 logStreamNames and logStreamNamePrefix, 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, 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 = {
  id: 'STRING_VALUE' /* required */
};
cloudwatchlogs.getDelivery(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: {}) —
  • id — (String)

    The ID of the delivery that you want to retrieve.

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:

    • delivery — (map)

      A structure that contains information about the delivery.

      • id — (String)

        The unique ID that identifies this delivery in your account.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery.

      • deliverySourceName — (String)

        The name of the delivery source that is associated with this delivery.

      • deliveryDestinationArn — (String)

        The ARN of the delivery destination that is associated with this delivery.

      • deliveryDestinationType — (String)

        Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Firehose.

        Possible values include:
        • "S3"
        • "CWL"
        • "FH"
      • recordFields — (Array<String>)

        The record fields used in this delivery.

      • fieldDelimiter — (String)

        The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.

      • s3DeliveryConfiguration — (map)

        This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.

        • suffixPath — (String)

          This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.

        • enableHiveCompatiblePath — (Boolean)

          This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.

      • tags — (map<String>)

        The tags that have been assigned to this delivery.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of the delivery destination that you want to retrieve.

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:

    • deliveryDestination — (map)

      A structure containing information about the delivery destination.

      • name — (String)

        The name of this delivery destination.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.

      • deliveryDestinationType — (String)

        Displays whether this delivery destination is CloudWatch Logs, Amazon S3, or Firehose.

        Possible values include:
        • "S3"
        • "CWL"
        • "FH"
      • outputFormat — (String)

        The format of the logs that are sent to this delivery destination.

        Possible values include:
        • "json"
        • "plain"
        • "w3c"
        • "raw"
        • "parquet"
      • deliveryDestinationConfiguration — (map)

        A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.

        • destinationResourceArn — required — (String)

          The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.

      • tags — (map<String>)

        The tags that have been assigned to this delivery destination.

Returns:

• (AWS.Request) —

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

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

    The name of the delivery destination that you want to retrieve the policy of.

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:

    • policy — (map)

      The IAM policy for this delivery destination.

      • deliveryDestinationPolicy — (String)

        The contents of the delivery destination policy.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of the delivery source that you want to retrieve.

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:

    • deliverySource — (map)

      A structure containing information about the delivery source.

      • name — (String)

        The unique name of the delivery source.

      • arn — (String)

        The Amazon Resource Name (ARN) that uniquely identifies this delivery source.

      • resourceArns — (Array<String>)

        This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

      • service — (String)

        The Amazon Web Services service that is sending logs.

      • logType — (String)

        The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

      • tags — (map<String>)

        The tags that have been assigned to this delivery source.

Returns:

• (AWS.Request) —

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

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

    The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors in your account by using the ListLogAnomalyDetectors operation.

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:

    • detectorName — (String)

      The name of the log anomaly detector

    • logGroupArnList — (Array<String>)

      An array of structures, where each structure contains the ARN of a log group associated with this anomaly detector.

    • evaluationFrequency — (String)

      Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.

      Possible values include:
      • "ONE_MIN"
      • "FIVE_MIN"
      • "TEN_MIN"
      • "FIFTEEN_MIN"
      • "THIRTY_MIN"
      • "ONE_HOUR"
    • 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.

    • anomalyDetectorStatus — (String)

      Specifies whether the anomaly detector is currently active. To change its status, use the enabled parameter in the UpdateLogAnomalyDetector operation.

      Possible values include:
      • "INITIALIZING"
      • "TRAINING"
      • "ANALYZING"
      • "FAILED"
      • "DELETED"
      • "PAUSED"
    • kmsKeyId — (String)

      The ID of the KMS key assigned to this anomaly detector, if any.

    • creationTimeStamp — (Integer)

      The date and time when this anomaly detector was created.

    • lastModifiedTimeStamp — (Integer)

      The date and time when this anomaly detector was most recently modified.

    • anomalyVisibilityTime — (Integer)

      The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

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 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current 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 scanned log events. 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 60 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"
    • encryptionKey — (String)

      If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.

Returns:

• (AWS.Request) —

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

var params = {
  anomalyDetectorArn: 'STRING_VALUE',
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  suppressionState: SUPPRESSED | UNSUPPRESSED
};
cloudwatchlogs.listAnomalies(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: {}) —
  • anomalyDetectorArn — (String)

    Use this to optionally limit the results to only the anomalies found by a certain anomaly detector.

  • suppressionState — (String)

    You can specify this parameter if you want to the operation to return only anomalies that are currently either suppressed or unsuppressed.

    Possible values include:
    • "SUPPRESSED"
    • "UNSUPPRESSED"
  • limit — (Integer)

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

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

    • anomalies — (Array<map>)

      An array of structures, where each structure contains information about one anomaly that a log anomaly detector has found.

      • anomalyId — required — (String)

        The unique ID that CloudWatch Logs assigned to this anomaly.

      • patternId — required — (String)

        The ID of the pattern used to help identify this anomaly.

      • anomalyDetectorArn — required — (String)

        The ARN of the anomaly detector that identified this anomaly.

      • patternString — required — (String)

        The pattern used to help identify this anomaly, in string format.

      • patternRegex — (String)

        The pattern used to help identify this anomaly, in regular expression format.

      • priority — (String)

        The priority level of this anomaly, as determined by CloudWatch Logs. Priority is computed based on log severity labels such as FATAL and ERROR and the amount of deviation from the baseline. Possible values are HIGH, MEDIUM, and LOW.

      • firstSeen — required — (Integer)

        The date and time when the anomaly detector first saw this anomaly. It is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

      • lastSeen — required — (Integer)

        The date and time when the anomaly detector most recently saw this anomaly. It is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

      • description — required — (String)

        A human-readable description of the anomaly. This description is generated by CloudWatch Logs.

      • active — required — (Boolean)

        Specifies whether this anomaly is still ongoing.

      • state — required — (String)

        Indicates the current state of this anomaly. If it is still being treated as an anomaly, the value is Active. If you have suppressed this anomaly by using the UpdateAnomaly operation, the value is Suppressed. If this behavior is now considered to be normal, the value is Baseline.

        Possible values include:
        • "Active"
        • "Suppressed"
        • "Baseline"
      • histogram — required — (map<Integer>)

        A map showing times when the anomaly detector ran, and the number of occurrences of this anomaly that were detected at each of those runs. The times are specified in epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

      • logSamples — required — (Array<map>)

        An array of sample log event messages that are considered to be part of this anomaly.

        • timestamp — (Integer)

          The time stamp of the log event.

        • message — (String)

          The message content of the log event.

      • patternTokens — required — (Array<map>)

        An array of structures where each structure contains information about one token that makes up the pattern.

        • dynamicTokenPosition — (Integer)

          For a dynamic token, this indicates where in the pattern that this token appears, related to other dynamic tokens. The dynamic token that appears first has a value of 1, the one that appears second is 2, and so on.

        • isDynamic — (Boolean)

          Specifies whether this is a dynamic token.

        • tokenString — (String)

          The string represented by this token. If this is a dynamic token, the value will be <*>

        • enumerations — (map<Integer>)

          Contains the values found for a dynamic token, and the number of times each value was found.

      • logGroupArnList — required — (Array<String>)

        An array of ARNS of the log groups that contained log events considered to be part of this anomaly.

      • suppressed — (Boolean)

        Indicates whether this anomaly is currently suppressed. To suppress an anomaly, use UpdateAnomaly.

      • suppressedDate — (Integer)

        If the anomaly is suppressed, this indicates when it was suppressed.

      • suppressedUntil — (Integer)

        If the anomaly is suppressed, this indicates when the suppression will end. If this value is 0, the anomaly was suppressed with no expiration, with the INFINITE value.

      • isPatternLevelSuppression — (Boolean)

        If this anomaly is suppressed, this field is true if the suppression is because the pattern is suppressed. If false, then only this particular anomaly is suppressed.

    • nextToken — (String)

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