amazonka-cloudwatch-logs-1.3.5: Amazon CloudWatch Logs SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudWatchLogs

Contents

Description

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.

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

See: AWS API Reference

Synopsis

Service Configuration

cloudWatchLogs :: Service Source

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 Source

Returned if a parameter of the request is incorrectly specified.

InvalidSequenceTokenException

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

Prism for InvalidSequenceTokenException' errors.

ResourceAlreadyExistsException

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

Returned if the specified resource already exists.

OperationAbortedException

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

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

ServiceUnavailableException

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

Returned if the service cannot complete the request.

DataAlreadyAcceptedException

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

Prism for DataAlreadyAcceptedException' errors.

InvalidOperationException

_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source

Returned if the operation is not valid on the specified resource

ResourceNotFoundException

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

Returned if the specified resource does not exist.

LimitExceededException

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

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 (Paginated)

CreateExportTask

PutDestination

DescribeSubscriptionFilters (Paginated)

GetLogEvents

DescribeLogGroups (Paginated)

DeleteDestination

FilterLogEvents (Paginated)

DeleteLogStream

CreateLogStream

CreateLogGroup

DescribeExportTasks

CancelExportTask

PutSubscriptionFilter

DeleteLogGroup

DeleteSubscriptionFilter

PutLogEvents

DescribeMetricFilters (Paginated)

TestMetricFilter

PutDestinationPolicy

PutMetricFilter

DeleteRetentionPolicy

DeleteMetricFilter

PutRetentionPolicy

DescribeLogStreams (Paginated)

Types

ExportTaskStatusCode

OrderBy

Destination

data Destination Source

A cross account destination that is the recipient of subscription log events.

See: destination smart constructor.

destination :: Destination Source

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 :: Lens' Destination (Maybe Text) Source

ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).

dCreationTime :: Lens' Destination (Maybe Natural) Source

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created.

dArn :: Lens' Destination (Maybe Text) Source

ARN of this destination.

dAccessPolicy :: Lens' Destination (Maybe Text) Source

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

dDestinationName :: Lens' Destination (Maybe Text) Source

Name of the destination.

dRoleARN :: Lens' Destination (Maybe Text) Source

A role for impersonation for delivering log events to the target.

ExportTask

exportTask :: ExportTask Source

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

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

etDestinationPrefix :: Lens' ExportTask (Maybe Text) Source

Prefix that was used as the start of Amazon S3 key for every object exported.

etDestination :: Lens' ExportTask (Maybe Text) Source

Name of Amazon S3 bucket to which the log data was exported.

etStatus :: Lens' ExportTask (Maybe ExportTaskStatus) Source

Status of the export task.

etTaskName :: Lens' ExportTask (Maybe Text) Source

The name of the export task.

etTaskId :: Lens' ExportTask (Maybe Text) Source

Id of the export task.

etTo :: Lens' ExportTask (Maybe Natural) Source

A unix timestamp indicating the end time of the range for the request. Events with a timestamp later than this time were not exported.

etFrom :: Lens' ExportTask (Maybe Natural) Source

A unix timestamp indicating the start time of the range for the request. Events with a timestamp prior to this time were not exported.

etLogGroupName :: Lens' ExportTask (Maybe Text) Source

The name of the log group from which logs data was exported.

etExecutionInfo :: Lens' ExportTask (Maybe ExportTaskExecutionInfo) Source

Execution info about the export task.

ExportTaskExecutionInfo

exportTaskExecutionInfo :: ExportTaskExecutionInfo Source

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

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

eteiCreationTime :: Lens' ExportTaskExecutionInfo (Maybe Natural) Source

A point in time when the export task got created.

eteiCompletionTime :: Lens' ExportTaskExecutionInfo (Maybe Natural) Source

A point in time when the export task got completed.

ExportTaskStatus

exportTaskStatus :: ExportTaskStatus Source

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

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

etsCode :: Lens' ExportTaskStatus (Maybe ExportTaskStatusCode) Source

Status code of the export task.

etsMessage :: Lens' ExportTaskStatus (Maybe Text) Source

Status message related to the code.

FilteredLogEvent

filteredLogEvent :: FilteredLogEvent Source

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:

fleLogStreamName :: Lens' FilteredLogEvent (Maybe Text) Source

The name of the log stream this event belongs to.

fleMessage :: Lens' FilteredLogEvent (Maybe Text) Source

The data contained in the log event.

fleEventId :: Lens' FilteredLogEvent (Maybe Text) Source

A unique identifier for this event.

InputLogEvent

data InputLogEvent Source

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.

inputLogEvent Source

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:

ileMessage :: Lens' InputLogEvent Text Source

Undocumented member.

LogGroup

logGroup :: LogGroup Source

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 :: Lens' LogGroup (Maybe Natural) Source

Undocumented member.

lgArn :: Lens' LogGroup (Maybe Text) Source

Undocumented member.

lgLogGroupName :: Lens' LogGroup (Maybe Text) Source

Undocumented member.

lgRetentionInDays :: Lens' LogGroup (Maybe Int) Source

Undocumented member.

lgStoredBytes :: Lens' LogGroup (Maybe Natural) Source

Undocumented member.

LogStream

data LogStream Source

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

See: logStream smart constructor.

logStream :: LogStream Source

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:

lsArn :: Lens' LogStream (Maybe Text) Source

Undocumented member.

lsLogStreamName :: Lens' LogStream (Maybe Text) Source

Undocumented member.

lsStoredBytes :: Lens' LogStream (Maybe Natural) Source

Undocumented member.

MetricFilter

data MetricFilter Source

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.

metricFilter :: MetricFilter Source

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:

mfFilterName :: Lens' MetricFilter (Maybe Text) Source

Undocumented member.

MetricFilterMatchRecord

metricFilterMatchRecord :: MetricFilterMatchRecord Source

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:

MetricTransformation

metricTransformation Source

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:

OutputLogEvent

outputLogEvent :: OutputLogEvent Source

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:

oleMessage :: Lens' OutputLogEvent (Maybe Text) Source

Undocumented member.

RejectedLogEventsInfo

rejectedLogEventsInfo :: RejectedLogEventsInfo Source

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:

SearchedLogStream

data SearchedLogStream Source

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

See: searchedLogStream smart constructor.

searchedLogStream :: SearchedLogStream Source

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 :: Lens' SearchedLogStream (Maybe Text) Source

The name of the log stream.

slsSearchedCompletely :: Lens' SearchedLogStream (Maybe Bool) Source

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

SubscriptionFilter

subscriptionFilter :: SubscriptionFilter Source

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: