Network.AWS.CloudWatchLogs

Amazon CloudWatch Logs API Reference

This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs enables you to monitor, store, and access your system, application, and custom log files. This guide provides detailed information about Amazon CloudWatch Logs actions, data types, parameters, and errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls, go to the Amazon CloudWatch Developer Guide.

Use the following links to get started using the /Amazon CloudWatch Logs API Reference/:

• Actions: An alphabetical list of all Amazon CloudWatch Logs actions.
• Data Types: An alphabetical list of all Amazon CloudWatch Logs data types.
• Common Parameters: Parameters that all Query actions can use.
• Common Errors: Client and server errors that all actions can return.
• Regions and Endpoints: Itemized regions and endpoints for all AWS products.

In addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to access Amazon CloudWatch Logs programmatically.

• AWS SDK for Java Documentation
• AWS SDK for .NET Documentation
• AWS SDK for PHP Documentation
• AWS SDK for Ruby Documentation

Developers in the AWS developer community also provide their own libraries, which you can find at the following AWS developer centers:

• AWS Java Developer Center
• AWS PHP Developer Center
• AWS Python Developer Center
• AWS Ruby Developer Center
• AWS Windows and .NET Developer Center

See: AWS API Reference

Service Configuration

cloudWatchLogs :: Service

API version '2014-03-28' of the Amazon CloudWatch Logs SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudWatchLogs.

InvalidParameterException

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError

Returned if a parameter of the request is incorrectly specified.

InvalidSequenceTokenException

_InvalidSequenceTokenException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for InvalidSequenceTokenException' errors.

ResourceAlreadyExistsException

_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError

Returned if the specified resource already exists.

OperationAbortedException

_OperationAbortedException :: AsError a => Getting (First ServiceError) a ServiceError

Returned if multiple requests to update the same resource were in conflict.

DataAlreadyAcceptedException

_DataAlreadyAcceptedException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for DataAlreadyAcceptedException' errors.

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError

Returned if the service cannot complete the request.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

Returned if the specified resource does not exist.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

Returned if you have reached the maximum number of resources that can be created.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DescribeDestinations

module Network.AWS.CloudWatchLogs.DescribeDestinations

DeleteDestination

module Network.AWS.CloudWatchLogs.DeleteDestination

PutDestination

module Network.AWS.CloudWatchLogs.PutDestination

DescribeSubscriptionFilters (Paginated)

module Network.AWS.CloudWatchLogs.DescribeSubscriptionFilters

GetLogEvents

module Network.AWS.CloudWatchLogs.GetLogEvents

DescribeLogGroups (Paginated)

module Network.AWS.CloudWatchLogs.DescribeLogGroups

FilterLogEvents (Paginated)

module Network.AWS.CloudWatchLogs.FilterLogEvents

DeleteLogStream

module Network.AWS.CloudWatchLogs.DeleteLogStream

CreateLogStream

module Network.AWS.CloudWatchLogs.CreateLogStream

CreateLogGroup

module Network.AWS.CloudWatchLogs.CreateLogGroup

PutLogEvents

module Network.AWS.CloudWatchLogs.PutLogEvents

DeleteSubscriptionFilter

module Network.AWS.CloudWatchLogs.DeleteSubscriptionFilter

PutSubscriptionFilter

module Network.AWS.CloudWatchLogs.PutSubscriptionFilter

DeleteLogGroup

module Network.AWS.CloudWatchLogs.DeleteLogGroup

TestMetricFilter

module Network.AWS.CloudWatchLogs.TestMetricFilter

DescribeMetricFilters (Paginated)

module Network.AWS.CloudWatchLogs.DescribeMetricFilters

DeleteMetricFilter

module Network.AWS.CloudWatchLogs.DeleteMetricFilter

PutRetentionPolicy

module Network.AWS.CloudWatchLogs.PutRetentionPolicy

DeleteRetentionPolicy

module Network.AWS.CloudWatchLogs.DeleteRetentionPolicy

PutMetricFilter

module Network.AWS.CloudWatchLogs.PutMetricFilter

PutDestinationPolicy

module Network.AWS.CloudWatchLogs.PutDestinationPolicy

DescribeLogStreams (Paginated)

module Network.AWS.CloudWatchLogs.DescribeLogStreams

Types

OrderBy

data OrderBy

Constructors

LastEventTime

LogStreamName

Instances

Enum OrderBy

Eq OrderBy

Data OrderBy

Ord OrderBy

Read OrderBy

Show OrderBy

Generic OrderBy

ToJSON OrderBy

Hashable OrderBy

ToHeader OrderBy

ToQuery OrderBy

ToByteString OrderBy

FromText OrderBy

ToText OrderBy

Typeable * OrderBy

type Rep OrderBy

Destination

data Destination

See: destination smart constructor.

Instances

Eq Destination

Data Destination

Read Destination

Show Destination

Generic Destination

FromJSON Destination

Typeable * Destination

type Rep Destination

destination :: Destination

Creates a value of Destination with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dTargetARN
• dCreationTime
• dArn
• dAccessPolicy
• dDestinationName
• dRoleARN

dTargetARN :: Lens' Destination (Maybe Text)

Undocumented member.

dCreationTime :: Lens' Destination (Maybe Natural)

Undocumented member.

dArn :: Lens' Destination (Maybe Text)

Undocumented member.

dAccessPolicy :: Lens' Destination (Maybe Text)

Undocumented member.

dDestinationName :: Lens' Destination (Maybe Text)

Undocumented member.

dRoleARN :: Lens' Destination (Maybe Text)

Undocumented member.

FilteredLogEvent

data FilteredLogEvent

Represents a matched event from a FilterLogEvents request.

See: filteredLogEvent smart constructor.

Instances

Eq FilteredLogEvent

Data FilteredLogEvent

Read FilteredLogEvent

Show FilteredLogEvent

Generic FilteredLogEvent

FromJSON FilteredLogEvent

Typeable * FilteredLogEvent

type Rep FilteredLogEvent

filteredLogEvent :: FilteredLogEvent

Creates a value of FilteredLogEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fleIngestionTime
• fleLogStreamName
• fleMessage
• fleTimestamp
• fleEventId

fleIngestionTime :: Lens' FilteredLogEvent (Maybe Natural)

Undocumented member.

fleLogStreamName :: Lens' FilteredLogEvent (Maybe Text)

The name of the log stream this event belongs to.

fleMessage :: Lens' FilteredLogEvent (Maybe Text)

The data contained in the log event.

fleTimestamp :: Lens' FilteredLogEvent (Maybe Natural)

Undocumented member.

fleEventId :: Lens' FilteredLogEvent (Maybe Text)

A unique identifier for this event.

InputLogEvent

data InputLogEvent

A log event is a record of some activity that was recorded by the application or resource being monitored. The log event record that Amazon CloudWatch Logs understands contains two properties: the timestamp of when the event occurred, and the raw event message.

See: inputLogEvent smart constructor.

Instances

Eq InputLogEvent

Data InputLogEvent

Read InputLogEvent

Show InputLogEvent

Generic InputLogEvent

ToJSON InputLogEvent

Typeable * InputLogEvent

type Rep InputLogEvent

inputLogEvent

Arguments

:: Natural

ileTimestamp

-> Text

ileMessage

-> InputLogEvent

Creates a value of InputLogEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ileTimestamp
• ileMessage

ileTimestamp :: Lens' InputLogEvent Natural

Undocumented member.

ileMessage :: Lens' InputLogEvent Text

Undocumented member.

LogGroup

data LogGroup

See: logGroup smart constructor.

Instances

Eq LogGroup

Data LogGroup

Read LogGroup

Show LogGroup

Generic LogGroup

FromJSON LogGroup

Typeable * LogGroup

type Rep LogGroup

logGroup :: LogGroup

Creates a value of LogGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lgCreationTime
• lgMetricFilterCount
• lgArn
• lgLogGroupName
• lgRetentionInDays
• lgStoredBytes

lgCreationTime :: Lens' LogGroup (Maybe Natural)

Undocumented member.

lgMetricFilterCount :: Lens' LogGroup (Maybe Int)

Undocumented member.

lgArn :: Lens' LogGroup (Maybe Text)

Undocumented member.

lgLogGroupName :: Lens' LogGroup (Maybe Text)

Undocumented member.

lgRetentionInDays :: Lens' LogGroup (Maybe Int)

Undocumented member.

lgStoredBytes :: Lens' LogGroup (Maybe Natural)

Undocumented member.

LogStream

data LogStream

A log stream is sequence of log events from a single emitter of logs.

See: logStream smart constructor.

Instances

Eq LogStream

Data LogStream

Read LogStream

Show LogStream

Generic LogStream

FromJSON LogStream

Typeable * LogStream

type Rep LogStream

logStream :: LogStream

Creates a value of LogStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lsCreationTime
• lsUploadSequenceToken
• lsArn
• lsFirstEventTimestamp
• lsLogStreamName
• lsStoredBytes
• lsLastIngestionTime
• lsLastEventTimestamp

lsCreationTime :: Lens' LogStream (Maybe Natural)

Undocumented member.

lsUploadSequenceToken :: Lens' LogStream (Maybe Text)

Undocumented member.

lsArn :: Lens' LogStream (Maybe Text)

Undocumented member.

lsFirstEventTimestamp :: Lens' LogStream (Maybe Natural)

Undocumented member.

lsLogStreamName :: Lens' LogStream (Maybe Text)

Undocumented member.

lsStoredBytes :: Lens' LogStream (Maybe Natural)

Undocumented member.

lsLastIngestionTime :: Lens' LogStream (Maybe Natural)

Undocumented member.

lsLastEventTimestamp :: Lens' LogStream (Maybe Natural)

Undocumented member.

MetricFilter

data MetricFilter

Metric filters can be used to express how Amazon CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric.

See: metricFilter smart constructor.

Instances

Eq MetricFilter

Data MetricFilter

Read MetricFilter

Show MetricFilter

Generic MetricFilter

FromJSON MetricFilter

Typeable * MetricFilter

type Rep MetricFilter

metricFilter :: MetricFilter

Creates a value of MetricFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mfCreationTime
• mfFilterName
• mfFilterPattern
• mfMetricTransformations

mfCreationTime :: Lens' MetricFilter (Maybe Natural)

Undocumented member.

mfFilterName :: Lens' MetricFilter (Maybe Text)

Undocumented member.

mfFilterPattern :: Lens' MetricFilter (Maybe Text)

Undocumented member.

mfMetricTransformations :: Lens' MetricFilter (Maybe (NonEmpty MetricTransformation))

Undocumented member.

MetricFilterMatchRecord

data MetricFilterMatchRecord

See: metricFilterMatchRecord smart constructor.

Instances

Eq MetricFilterMatchRecord

Data MetricFilterMatchRecord

Read MetricFilterMatchRecord

Show MetricFilterMatchRecord

Generic MetricFilterMatchRecord

FromJSON MetricFilterMatchRecord

Typeable * MetricFilterMatchRecord

type Rep MetricFilterMatchRecord

metricFilterMatchRecord :: MetricFilterMatchRecord

Creates a value of MetricFilterMatchRecord with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mfmrExtractedValues
• mfmrEventMessage
• mfmrEventNumber

mfmrExtractedValues :: Lens' MetricFilterMatchRecord (HashMap Text Text)

Undocumented member.

mfmrEventMessage :: Lens' MetricFilterMatchRecord (Maybe Text)

Undocumented member.

mfmrEventNumber :: Lens' MetricFilterMatchRecord (Maybe Integer)

Undocumented member.

MetricTransformation

data MetricTransformation

See: metricTransformation smart constructor.

Instances

Eq MetricTransformation

Data MetricTransformation

Read MetricTransformation

Show MetricTransformation

Generic MetricTransformation

ToJSON MetricTransformation

FromJSON MetricTransformation

Typeable * MetricTransformation

type Rep MetricTransformation

metricTransformation

Arguments

:: Text

mtMetricName

-> Text

mtMetricNamespace

-> Text

mtMetricValue

-> MetricTransformation

Creates a value of MetricTransformation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mtMetricName
• mtMetricNamespace
• mtMetricValue

mtMetricName :: Lens' MetricTransformation Text

Undocumented member.

mtMetricNamespace :: Lens' MetricTransformation Text

Undocumented member.

mtMetricValue :: Lens' MetricTransformation Text

Undocumented member.

OutputLogEvent

data OutputLogEvent

See: outputLogEvent smart constructor.

Instances

Eq OutputLogEvent

Data OutputLogEvent

Read OutputLogEvent

Show OutputLogEvent

Generic OutputLogEvent

FromJSON OutputLogEvent

Typeable * OutputLogEvent

type Rep OutputLogEvent

outputLogEvent :: OutputLogEvent

Creates a value of OutputLogEvent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• oleIngestionTime
• oleMessage
• oleTimestamp

oleIngestionTime :: Lens' OutputLogEvent (Maybe Natural)

Undocumented member.

oleMessage :: Lens' OutputLogEvent (Maybe Text)

Undocumented member.

oleTimestamp :: Lens' OutputLogEvent (Maybe Natural)

Undocumented member.

RejectedLogEventsInfo

data RejectedLogEventsInfo

See: rejectedLogEventsInfo smart constructor.

Instances

Eq RejectedLogEventsInfo

Data RejectedLogEventsInfo

Read RejectedLogEventsInfo

Show RejectedLogEventsInfo

Generic RejectedLogEventsInfo

FromJSON RejectedLogEventsInfo

Typeable * RejectedLogEventsInfo

type Rep RejectedLogEventsInfo

rejectedLogEventsInfo :: RejectedLogEventsInfo

Creates a value of RejectedLogEventsInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rleiTooOldLogEventEndIndex
• rleiTooNewLogEventStartIndex
• rleiExpiredLogEventEndIndex

rleiTooOldLogEventEndIndex :: Lens' RejectedLogEventsInfo (Maybe Int)

Undocumented member.

rleiTooNewLogEventStartIndex :: Lens' RejectedLogEventsInfo (Maybe Int)

Undocumented member.

rleiExpiredLogEventEndIndex :: Lens' RejectedLogEventsInfo (Maybe Int)

Undocumented member.

SearchedLogStream

data SearchedLogStream

An object indicating the search status of a log stream in a FilterLogEvents request.

See: searchedLogStream smart constructor.

Instances

Eq SearchedLogStream

Data SearchedLogStream

Read SearchedLogStream

Show SearchedLogStream

Generic SearchedLogStream

FromJSON SearchedLogStream

Typeable * SearchedLogStream

type Rep SearchedLogStream

searchedLogStream :: SearchedLogStream

Creates a value of SearchedLogStream with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• slsLogStreamName
• slsSearchedCompletely

slsLogStreamName :: Lens' SearchedLogStream (Maybe Text)

The name of the log stream.

slsSearchedCompletely :: Lens' SearchedLogStream (Maybe Bool)

Indicates whether all the events in this log stream were searched or more data exists to search by paginating further.

SubscriptionFilter

data SubscriptionFilter

See: subscriptionFilter smart constructor.

Instances

Eq SubscriptionFilter

Data SubscriptionFilter

Read SubscriptionFilter

Show SubscriptionFilter

Generic SubscriptionFilter

FromJSON SubscriptionFilter

Typeable * SubscriptionFilter

type Rep SubscriptionFilter

subscriptionFilter :: SubscriptionFilter

Creates a value of SubscriptionFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sfCreationTime
• sfFilterName
• sfDestinationARN
• sfLogGroupName
• sfFilterPattern
• sfRoleARN

sfCreationTime :: Lens' SubscriptionFilter (Maybe Natural)

Undocumented member.

sfFilterName :: Lens' SubscriptionFilter (Maybe Text)

Undocumented member.

sfDestinationARN :: Lens' SubscriptionFilter (Maybe Text)

Undocumented member.

sfLogGroupName :: Lens' SubscriptionFilter (Maybe Text)

Undocumented member.

sfFilterPattern :: Lens' SubscriptionFilter (Maybe Text)

Undocumented member.

sfRoleARN :: Lens' SubscriptionFilter (Maybe Text)

Undocumented member.