Canonical AWS API doc

Properties

logGroupName (string) [required]

Name of the log group

Example

await aws.CloudWatchLogs.DeleteLogGroup({
  logGroupName: String, // required
})

Canonical AWS API doc

Properties

accountIdentifiers (array)

List of accounts to search when includeLinkedAccounts is true

includeLinkedAccounts (boolean)

Return log groups in the accounts enumerated by accountIdentifiers

limit (number)

Maximum number of items to evaluate and return

logGroupClass (string)

Log group class setting: STANDARD (supports all CloudWatch Logs features), or INFREQUENT_ACCESS (feature subset with lower costs)

Example

await aws.CloudWatchLogs.DescribeLogGroups({
  accountIdentifiers: Array,
  includeLinkedAccounts: Boolean,
  limit: Number,
  logGroupClass: String,
  logGroupNamePattern: String,
  logGroupNamePrefix: String,
  nextToken: String,
  paginate: Boolean,
})

Canonical AWS API doc

Properties

descending (boolean)

Return results in descending order (if true)

limit (number)

Maximum number of items to evaluate and return

logGroupIdentifier (string)

Name or ARN of the log group

logGroupName (string)

Name of the log group

logStreamNamePrefix (string)

Prefix to match

nextToken (string)

Pagination cursor token to be used if NextToken was returned in a previous response

orderBy (string)

Order results by log stream name (LogStreamName) or event time (LastEventTime)

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

Example

await aws.CloudWatchLogs.DescribeLogStreams({
  descending: Boolean,
  limit: Number,
  logGroupIdentifier: String,
  logGroupName: String,
  logStreamNamePrefix: String,
  nextToken: String,
  orderBy: String,
  paginate: Boolean,
})

Canonical AWS API doc

Properties

logStreamName (string) [required]

Name of the log stream

endTime (number)

End of the time range in epoch milliseconds

limit (number)

Maximum number of items to evaluate and return

logGroupIdentifier (string)

Name or ARN of the log group

logGroupName (string)

Name of the log group

nextToken (string)

Pagination cursor token to be used if NextToken was returned in a previous response

paginate (boolean)

Enable automatic result pagination; use this instead of making your own individual pagination requests

startFromHead (boolean)

Return earliest log events first (true)

startTime (number)

Start of the time range in epoch milliseconds

unmask (boolean)

Display log event fields with all sensitive data unmasked and visible (true)

Example

await aws.CloudWatchLogs.GetLogEvents({
  logStreamName: String, // required
  endTime: Number,
  limit: Number,
  logGroupIdentifier: String,
  logGroupName: String,
  nextToken: String,
  paginate: Boolean,
  startFromHead: Boolean,
  startTime: Number,
  unmask: Boolean,
})

Canonical AWS API doc

Properties

queryId (string)

The ID of the query

Example

await aws.CloudWatchLogs.GetQueryResults({
  queryId: String,
})

Canonical AWS API doc

Properties

endTime (number)

End of the time range in epoch seconds

limit (number)

Maximum number of items to evaluate and return

logGroupIdentifiers (array)

List of log groups to query. StartQuery requires exactly one of logGroupName, logGroupNames or logGroupIdentifiers.

logGroupName (string)

Name of the log group

logGroupNames (array)

List of log groups to query. StartQuery requires exactly one of logGroupName, logGroupNames or logGroupIdentifiers.

query (string)

The query string to use

startTime (number)

Start of the time range in epoch seconds

Example

await aws.CloudWatchLogs.StartQuery({
  endTime: Number,
  limit: Number,
  logGroupIdentifiers: Array,
  logGroupName: String,
  logGroupNames: Array,
  query: String,
  startTime: Number,
})