get_log_object async ¶

async def get_log_object(
    self,
    log_object_pointer: "capo_cloudwatch_logs.types.log_object_pointer.LogObjectPointer",
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    unmask: Optional["capo_cloudwatch_logs.types.unmask.Unmask"] = None,
) -> "capo_cloudwatch_logs.types.get_log_object_response.GetLogObjectResponse":
    """<p>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 <code>@ptr.$[path.to.field]</code>) are added. The path in the reference field reflects the original JSON structure where the large field was located. For example, this could be <code>@ptr.$['input']['message']</code>, <code>@ptr.$['AAA']['BBB']['CCC']['DDD']</code>, <code>@ptr.$['AAA']</code>, or any other path matching your log structure.</p> <note> <p>The <code>GetLogObject</code> API routes requests using SDK host prefix injection. SDK versions released before April 1, 2026 route to <code>streaming-logs.<i>Region</i>.amazonaws.com</code>, which does not support VPC endpoints. SDK versions released on or after April 1, 2026 route to <code>stream-logs.<i>Region</i>.amazonaws.com</code>, which supports VPC endpoints. To set up a VPC endpoint for this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch-logs-and-interface-VPC.html#create-VPC-endpoint-for-CloudWatchLogs">Creating a VPC endpoint for CloudWatch Logs </a>.</p> </note>

    Args:
        unmask: <p>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.</p>
        log_object_pointer: <p>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.</p>

    Raises:
        capo_cloudwatch_logs.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_cloudwatch_logs.errors.invalid_operation_exception.InvalidOperationException: <p>The operation is not valid on the specified resource.</p>
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.limit_exceeded_exception.LimitExceededException: <p>You have reached the maximum number of resources that can be created.</p>
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch_logs.types.get_log_object_request.GetLogObjectRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch_logs.types.get_log_object_response.GetLogObjectResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.get_log_object

        (
            output,
            http_response,
        ) = await capo_cloudwatch_logs._operations.logs_20140328.get_log_object.async_get_log_object(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_cloudwatch_logs.types.get_log_object_response.GetLogObjectResponse",
    ) -> dict[str, Any]:
        import capo_cloudwatch_logs.types.get_log_object_response

        return capo_cloudwatch_logs.types.get_log_object_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetLogObject", redact_output=_redact_output),
    )
    input_: capo_cloudwatch_logs.types.get_log_object_request.GetLogObjectRequest = {
        "log_object_pointer": log_object_pointer
    }
    if unmask is not None:
        input_["unmask"] = unmask

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    return response.output