libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatchLogs.PutLogEvents

Description

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the expectedSequenceToken field from InvalidSequenceTokenException. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
  • None of the log events in the batch can be more than 2 hours in the future.
  • None of the log events in the batch can be older than 14 days or older than the retention period of the log group.
  • The log events in the batch must be in chronological order by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
  • The maximum number of log events in a batch is 10,000.
  • There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.

If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid Amazon Web Services access key ID or secret key.

Synopsis

Creating a Request

data PutLogEvents Source #

See: newPutLogEvents smart constructor.

Constructors

PutLogEvents' 

Fields

  • sequenceToken :: Maybe Text

    The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

  • logGroupName :: Text

    The name of the log group.

  • logStreamName :: Text

    The name of the log stream.

  • logEvents :: NonEmpty InputLogEvent

    The log events.

Instances

Instances details
Eq PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Read PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Show PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Generic PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Associated Types

type Rep PutLogEvents :: Type -> Type #

NFData PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Methods

rnf :: PutLogEvents -> () #

Hashable PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

ToJSON PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

AWSRequest PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Associated Types

type AWSResponse PutLogEvents #

ToHeaders PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

ToPath PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

ToQuery PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

type Rep PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

type Rep PutLogEvents = D1 ('MetaData "PutLogEvents" "Amazonka.CloudWatchLogs.PutLogEvents" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "PutLogEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sequenceToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "logStreamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "logEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty InputLogEvent)))))
type AWSResponse PutLogEvents Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

newPutLogEvents Source #

Create a value of PutLogEvents 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:sequenceToken:PutLogEvents', putLogEvents_sequenceToken - The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

$sel:logGroupName:PutLogEvents', putLogEvents_logGroupName - The name of the log group.

$sel:logStreamName:PutLogEvents', putLogEvents_logStreamName - The name of the log stream.

$sel:logEvents:PutLogEvents', putLogEvents_logEvents - The log events.

Request Lenses

putLogEvents_sequenceToken :: Lens' PutLogEvents (Maybe Text) Source #

The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls might be successful or one might be rejected.

Destructuring the Response

data PutLogEventsResponse Source #

See: newPutLogEventsResponse smart constructor.

Constructors

PutLogEventsResponse' 

Fields

Instances

Instances details
Eq PutLogEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Read PutLogEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Show PutLogEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Generic PutLogEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Associated Types

type Rep PutLogEventsResponse :: Type -> Type #

NFData PutLogEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

Methods

rnf :: PutLogEventsResponse -> () #

type Rep PutLogEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutLogEvents

type Rep PutLogEventsResponse = D1 ('MetaData "PutLogEventsResponse" "Amazonka.CloudWatchLogs.PutLogEvents" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "PutLogEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rejectedLogEventsInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RejectedLogEventsInfo)) :*: (S1 ('MetaSel ('Just "nextSequenceToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutLogEventsResponse Source #

Create a value of PutLogEventsResponse 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:rejectedLogEventsInfo:PutLogEventsResponse', putLogEventsResponse_rejectedLogEventsInfo - The rejected events.

$sel:nextSequenceToken:PutLogEventsResponse', putLogEventsResponse_nextSequenceToken - The next sequence token.

$sel:httpStatus:PutLogEventsResponse', putLogEventsResponse_httpStatus - The response's http status code.

Response Lenses