Get Log Object

cloudwatchlogs_get_log_object

R Documentation

Retrieves a large logging object (LLO) and streams it back¶

Description¶

Retrieves a large logging object (LLO) and streams it back. This API is used to fetch the content of large portions of log events that have been ingested through the PutOpenTelemetryLogs API. When log events contain fields that would cause the total event size to exceed 1MB, CloudWatch Logs automatically processes up to 10 fields, starting with the largest fields. Each field is truncated as needed to keep the total event size as close to 1MB as possible. The excess portions are stored as Large Log Objects (LLOs) and these fields are processed separately and LLO reference system fields (in the format ⁠@ptr.$[path.to.field]⁠) are added. The path in the reference field reflects the original JSON structure where the large field was located. For example, this could be ⁠@ptr.$['input']['message']⁠, ⁠@ptr.$['AAA']['BBB']['CCC']['DDD']⁠, ⁠@ptr.$['AAA']⁠, or any other path matching your log structure.

The get_log_object API routes requests using SDK host prefix injection. SDK versions released before April 1, 2026 route to streaming-logs.Region.amazonaws.com, which does not support VPC endpoints. SDK versions released on or after April 1, 2026 route to stream-logs.Region.amazonaws.com, which supports VPC endpoints. To set up a VPC endpoint for this API, see Creating a VPC endpoint for CloudWatch Logs .

Usage¶

cloudwatchlogs_get_log_object(unmask, logObjectPointer)

Arguments¶

unmask

A boolean flag that indicates whether to unmask sensitive log data. When set to true, any masked or redacted data in the log object will be displayed in its original form. Default is false.

logObjectPointer

[required] A pointer to the specific log object to retrieve. This is a required parameter that uniquely identifies the log object within CloudWatch Logs. The pointer is typically obtained from a previous query or filter operation.

Value¶

A list with the following syntax:

list(
  fieldStream = list(
    fields = list(
      data = raw
    ),
    InternalStreamingException = list(
      message = "string"
    )
  )
)

Request syntax¶

svc$get_log_object(
  unmask = TRUE|FALSE,
  logObjectPointer = "string"
)