amazonka-cloudwatch-logs-2.0: Amazon CloudWatch Logs SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudWatchLogs.GetLogRecord

Description

Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

The full unparsed log event is returned within @message.

Synopsis

Creating a Request

data GetLogRecord Source #

See: newGetLogRecord smart constructor.

Constructors

GetLogRecord' 

Fields

  • unmask :: Maybe Bool

    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.

  • logRecordPointer :: Text

    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.

Instances

Instances details
ToJSON GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

ToHeaders GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

ToPath GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

ToQuery GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

AWSRequest GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Associated Types

type AWSResponse GetLogRecord #

Generic GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Associated Types

type Rep GetLogRecord :: Type -> Type #

Read GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Show GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

NFData GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Methods

rnf :: GetLogRecord -> () #

Eq GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Hashable GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

type AWSResponse GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

type Rep GetLogRecord Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

type Rep GetLogRecord = D1 ('MetaData "GetLogRecord" "Amazonka.CloudWatchLogs.GetLogRecord" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "GetLogRecord'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unmask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "logRecordPointer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetLogRecord Source #

Create a value of GetLogRecord with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:unmask:GetLogRecord', getLogRecord_unmask - 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.

$sel:logRecordPointer:GetLogRecord', getLogRecord_logRecordPointer - 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.

Request Lenses

getLogRecord_unmask :: Lens' GetLogRecord (Maybe Bool) Source #

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.

getLogRecord_logRecordPointer :: Lens' GetLogRecord Text Source #

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.

Destructuring the Response

data GetLogRecordResponse Source #

See: newGetLogRecordResponse smart constructor.

Constructors

GetLogRecordResponse' 

Fields

Instances

Instances details
Generic GetLogRecordResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Associated Types

type Rep GetLogRecordResponse :: Type -> Type #

Read GetLogRecordResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Show GetLogRecordResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

NFData GetLogRecordResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

Methods

rnf :: GetLogRecordResponse -> () #

Eq GetLogRecordResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

type Rep GetLogRecordResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.GetLogRecord

type Rep GetLogRecordResponse = D1 ('MetaData "GetLogRecordResponse" "Amazonka.CloudWatchLogs.GetLogRecord" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "GetLogRecordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logRecord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetLogRecordResponse Source #

Create a value of GetLogRecordResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:logRecord:GetLogRecordResponse', getLogRecordResponse_logRecord - The requested log event, as a JSON string.

$sel:httpStatus:GetLogRecordResponse', getLogRecordResponse_httpStatus - The response's http status code.

Response Lenses

getLogRecordResponse_logRecord :: Lens' GetLogRecordResponse (Maybe (HashMap Text Text)) Source #

The requested log event, as a JSON string.