FilterLogEventsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-filter-log-events-request-schema.json",
  "title": "FilterLogEventsRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-operations-api-openapi.yml#/components/schemas/FilterLogEventsRequest",
  "type": "object",
  "properties": {
    "logGroupName": {
      "type": "string",
      "description": "The name of the log group to search. You must include either logGroupIdentifier or logGroupName, but not both."
    },
    "logGroupIdentifier": {
      "type": "string",
      "description": "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. You must include either logGroupIdentifier or logGroupName, but not both."
    },
    "logStreamNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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": {
      "type": "string",
      "description": "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": {
      "type": "integer",
      "description": "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. Set startTime explicitly to reduce the chances of empty pages in the response."
    },
    "endTime": {
      "type": "integer",
      "description": "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": {
      "type": "string",
      "description": "The filter pattern to use. For more information, see Filter and Pattern Syntax. If not provided, all the events are matched."
    },
    "nextToken": {
      "type": "string",
      "description": "The token for the next set of events to return. (You received this token from a previous call.)"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of events to return. The default is 10,000 events."
    },
    "startFromHead": {
      "type": "boolean",
      "description": "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 true. The startFromHead parameter sets the sort direction on the first request. On subsequent requests, the nextToken determines the sort direction. To continue paginating in the same direction, provide the returned nextToken. If you provide both nextToken and startFromHead, the direction of the nextToken is used. Setting startFromHead to false is supported only when startTime is on or after Jan 1, 2024 00:00:00 UTC. A request with startFromHea"
    },
    "interleaved": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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."
    }
  }
}