| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudWatchLogs
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- GetLogGroupFields
- GetLogRecord
- DescribeDestinations (Paginated)
- UntagLogGroup
- StopQuery
- CreateExportTask
- PutDestination
- DescribeSubscriptionFilters (Paginated)
- GetLogEvents
- DescribeLogGroups (Paginated)
- DeleteDestination
- DisassociateKmsKey
- FilterLogEvents (Paginated)
- DeleteQueryDefinition
- PutQueryDefinition
- TagLogGroup
- DescribeResourcePolicies (Paginated)
- DescribeQueryDefinitions
- DeleteLogStream
- DescribeQueries (Paginated)
- CreateLogStream
- CreateLogGroup
- DescribeExportTasks (Paginated)
- CancelExportTask
- PutSubscriptionFilter
- StartQuery
- DeleteLogGroup
- DeleteSubscriptionFilter
- PutLogEvents
- DescribeMetricFilters (Paginated)
- TestMetricFilter
- PutDestinationPolicy
- PutMetricFilter
- DeleteRetentionPolicy
- DeleteMetricFilter
- PutRetentionPolicy
- ListTagsLogGroup
- PutResourcePolicy
- DeleteResourcePolicy
- AssociateKmsKey
- GetQueryResults
- DescribeLogStreams (Paginated)
- Types
- Distribution
- ExportTaskStatusCode
- OrderBy
- QueryStatus
- StandardUnit
- Destination
- ExportTask
- ExportTaskExecutionInfo
- ExportTaskStatus
- FilteredLogEvent
- InputLogEvent
- LogGroup
- LogGroupField
- LogStream
- MetricFilter
- MetricFilterMatchRecord
- MetricTransformation
- OutputLogEvent
- QueryDefinition
- QueryInfo
- QueryStatistics
- RejectedLogEventsInfo
- ResourcePolicy
- ResultField
- SearchedLogStream
- SubscriptionFilter
Description
Derived from API version 2014-03-28 of the AWS service descriptions, licensed under Apache 2.0.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
You can use CloudWatch Logs to:
- Monitor logs from EC2 instances in real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring so no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
- Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
- Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Synopsis
- defaultService :: Service
- _InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSequenceTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnrecognizedClientException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationAbortedException :: AsError a => Getting (First ServiceError) a ServiceError
- _MalformedQueryException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _DataAlreadyAcceptedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data GetLogGroupFields = GetLogGroupFields' (Maybe Natural) Text
- newGetLogGroupFields :: Text -> GetLogGroupFields
- data GetLogGroupFieldsResponse = GetLogGroupFieldsResponse' (Maybe [LogGroupField]) Int
- newGetLogGroupFieldsResponse :: Int -> GetLogGroupFieldsResponse
- data GetLogRecord = GetLogRecord' Text
- newGetLogRecord :: Text -> GetLogRecord
- data GetLogRecordResponse = GetLogRecordResponse' (Maybe (HashMap Text Text)) Int
- newGetLogRecordResponse :: Int -> GetLogRecordResponse
- data DescribeDestinations = DescribeDestinations' (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeDestinations :: DescribeDestinations
- data DescribeDestinationsResponse = DescribeDestinationsResponse' (Maybe Text) (Maybe [Destination]) Int
- newDescribeDestinationsResponse :: Int -> DescribeDestinationsResponse
- data UntagLogGroup = UntagLogGroup' Text (NonEmpty Text)
- newUntagLogGroup :: Text -> NonEmpty Text -> UntagLogGroup
- data UntagLogGroupResponse = UntagLogGroupResponse' {
- newUntagLogGroupResponse :: UntagLogGroupResponse
- data StopQuery = StopQuery' Text
- newStopQuery :: Text -> StopQuery
- data StopQueryResponse = StopQueryResponse' (Maybe Bool) Int
- newStopQueryResponse :: Int -> StopQueryResponse
- data CreateExportTask = CreateExportTask' (Maybe Text) (Maybe Text) (Maybe Text) Text Natural Natural Text
- newCreateExportTask :: Text -> Natural -> Natural -> Text -> CreateExportTask
- data CreateExportTaskResponse = CreateExportTaskResponse' (Maybe Text) Int
- newCreateExportTaskResponse :: Int -> CreateExportTaskResponse
- data PutDestination = PutDestination' Text Text Text
- newPutDestination :: Text -> Text -> Text -> PutDestination
- data PutDestinationResponse = PutDestinationResponse' (Maybe Destination) Int
- newPutDestinationResponse :: Int -> PutDestinationResponse
- data DescribeSubscriptionFilters = DescribeSubscriptionFilters' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newDescribeSubscriptionFilters :: Text -> DescribeSubscriptionFilters
- data DescribeSubscriptionFiltersResponse = DescribeSubscriptionFiltersResponse' (Maybe [SubscriptionFilter]) (Maybe Text) Int
- newDescribeSubscriptionFiltersResponse :: Int -> DescribeSubscriptionFiltersResponse
- data GetLogEvents = GetLogEvents' (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Natural) Text Text
- newGetLogEvents :: Text -> Text -> GetLogEvents
- data GetLogEventsResponse = GetLogEventsResponse' (Maybe Text) (Maybe Text) (Maybe [OutputLogEvent]) Int
- newGetLogEventsResponse :: Int -> GetLogEventsResponse
- data DescribeLogGroups = DescribeLogGroups' (Maybe Text) (Maybe Text) (Maybe Natural)
- newDescribeLogGroups :: DescribeLogGroups
- data DescribeLogGroupsResponse = DescribeLogGroupsResponse' (Maybe [LogGroup]) (Maybe Text) Int
- newDescribeLogGroupsResponse :: Int -> DescribeLogGroupsResponse
- data DeleteDestination = DeleteDestination' Text
- newDeleteDestination :: Text -> DeleteDestination
- data DeleteDestinationResponse = DeleteDestinationResponse' {
- newDeleteDestinationResponse :: DeleteDestinationResponse
- data DisassociateKmsKey = DisassociateKmsKey' Text
- newDisassociateKmsKey :: Text -> DisassociateKmsKey
- data DisassociateKmsKeyResponse = DisassociateKmsKeyResponse' {
- newDisassociateKmsKeyResponse :: DisassociateKmsKeyResponse
- data FilterLogEvents = FilterLogEvents' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Bool) Text
- newFilterLogEvents :: Text -> FilterLogEvents
- data FilterLogEventsResponse = FilterLogEventsResponse' (Maybe [SearchedLogStream]) (Maybe Text) (Maybe [FilteredLogEvent]) Int
- newFilterLogEventsResponse :: Int -> FilterLogEventsResponse
- data DeleteQueryDefinition = DeleteQueryDefinition' Text
- newDeleteQueryDefinition :: Text -> DeleteQueryDefinition
- data DeleteQueryDefinitionResponse = DeleteQueryDefinitionResponse' (Maybe Bool) Int
- newDeleteQueryDefinitionResponse :: Int -> DeleteQueryDefinitionResponse
- data PutQueryDefinition = PutQueryDefinition' (Maybe [Text]) (Maybe Text) Text Text
- newPutQueryDefinition :: Text -> Text -> PutQueryDefinition
- data PutQueryDefinitionResponse = PutQueryDefinitionResponse' (Maybe Text) Int
- newPutQueryDefinitionResponse :: Int -> PutQueryDefinitionResponse
- data TagLogGroup = TagLogGroup' Text (HashMap Text Text)
- newTagLogGroup :: Text -> TagLogGroup
- data TagLogGroupResponse = TagLogGroupResponse' {
- newTagLogGroupResponse :: TagLogGroupResponse
- data DescribeResourcePolicies = DescribeResourcePolicies' (Maybe Text) (Maybe Natural)
- newDescribeResourcePolicies :: DescribeResourcePolicies
- data DescribeResourcePoliciesResponse = DescribeResourcePoliciesResponse' (Maybe [ResourcePolicy]) (Maybe Text) Int
- newDescribeResourcePoliciesResponse :: Int -> DescribeResourcePoliciesResponse
- data DescribeQueryDefinitions = DescribeQueryDefinitions' (Maybe Text) (Maybe Text) (Maybe Natural)
- newDescribeQueryDefinitions :: DescribeQueryDefinitions
- data DescribeQueryDefinitionsResponse = DescribeQueryDefinitionsResponse' (Maybe [QueryDefinition]) (Maybe Text) Int
- newDescribeQueryDefinitionsResponse :: Int -> DescribeQueryDefinitionsResponse
- data DeleteLogStream = DeleteLogStream' Text Text
- newDeleteLogStream :: Text -> Text -> DeleteLogStream
- data DeleteLogStreamResponse = DeleteLogStreamResponse' {
- newDeleteLogStreamResponse :: DeleteLogStreamResponse
- data DescribeQueries = DescribeQueries' (Maybe QueryStatus) (Maybe Text) (Maybe Text) (Maybe Natural)
- newDescribeQueries :: DescribeQueries
- data DescribeQueriesResponse = DescribeQueriesResponse' (Maybe [QueryInfo]) (Maybe Text) Int
- newDescribeQueriesResponse :: Int -> DescribeQueriesResponse
- data CreateLogStream = CreateLogStream' Text Text
- newCreateLogStream :: Text -> Text -> CreateLogStream
- data CreateLogStreamResponse = CreateLogStreamResponse' {
- newCreateLogStreamResponse :: CreateLogStreamResponse
- data CreateLogGroup = CreateLogGroup' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateLogGroup :: Text -> CreateLogGroup
- data CreateLogGroupResponse = CreateLogGroupResponse' {
- newCreateLogGroupResponse :: CreateLogGroupResponse
- data DescribeExportTasks = DescribeExportTasks' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ExportTaskStatusCode)
- newDescribeExportTasks :: DescribeExportTasks
- data DescribeExportTasksResponse = DescribeExportTasksResponse' (Maybe Text) (Maybe [ExportTask]) Int
- newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
- data CancelExportTask = CancelExportTask' Text
- newCancelExportTask :: Text -> CancelExportTask
- data CancelExportTaskResponse = CancelExportTaskResponse' {
- newCancelExportTaskResponse :: CancelExportTaskResponse
- data PutSubscriptionFilter = PutSubscriptionFilter' (Maybe Distribution) (Maybe Text) Text Text Text Text
- newPutSubscriptionFilter :: Text -> Text -> Text -> Text -> PutSubscriptionFilter
- data PutSubscriptionFilterResponse = PutSubscriptionFilterResponse' {
- newPutSubscriptionFilterResponse :: PutSubscriptionFilterResponse
- data StartQuery = StartQuery' (Maybe [Text]) (Maybe Text) (Maybe Natural) Natural Natural Text
- newStartQuery :: Natural -> Natural -> Text -> StartQuery
- data StartQueryResponse = StartQueryResponse' (Maybe Text) Int
- newStartQueryResponse :: Int -> StartQueryResponse
- data DeleteLogGroup = DeleteLogGroup' Text
- newDeleteLogGroup :: Text -> DeleteLogGroup
- data DeleteLogGroupResponse = DeleteLogGroupResponse' {
- newDeleteLogGroupResponse :: DeleteLogGroupResponse
- data DeleteSubscriptionFilter = DeleteSubscriptionFilter' Text Text
- newDeleteSubscriptionFilter :: Text -> Text -> DeleteSubscriptionFilter
- data DeleteSubscriptionFilterResponse = DeleteSubscriptionFilterResponse' {
- newDeleteSubscriptionFilterResponse :: DeleteSubscriptionFilterResponse
- data PutLogEvents = PutLogEvents' (Maybe Text) Text Text (NonEmpty InputLogEvent)
- newPutLogEvents :: Text -> Text -> NonEmpty InputLogEvent -> PutLogEvents
- data PutLogEventsResponse = PutLogEventsResponse' (Maybe RejectedLogEventsInfo) (Maybe Text) Int
- newPutLogEventsResponse :: Int -> PutLogEventsResponse
- data DescribeMetricFilters = DescribeMetricFilters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newDescribeMetricFilters :: DescribeMetricFilters
- data DescribeMetricFiltersResponse = DescribeMetricFiltersResponse' (Maybe Text) (Maybe [MetricFilter]) Int
- newDescribeMetricFiltersResponse :: Int -> DescribeMetricFiltersResponse
- data TestMetricFilter = TestMetricFilter' Text (NonEmpty Text)
- newTestMetricFilter :: Text -> NonEmpty Text -> TestMetricFilter
- data TestMetricFilterResponse = TestMetricFilterResponse' (Maybe [MetricFilterMatchRecord]) Int
- newTestMetricFilterResponse :: Int -> TestMetricFilterResponse
- data PutDestinationPolicy = PutDestinationPolicy' Text Text
- newPutDestinationPolicy :: Text -> Text -> PutDestinationPolicy
- data PutDestinationPolicyResponse = PutDestinationPolicyResponse' {
- newPutDestinationPolicyResponse :: PutDestinationPolicyResponse
- data PutMetricFilter = PutMetricFilter' Text Text Text (NonEmpty MetricTransformation)
- newPutMetricFilter :: Text -> Text -> Text -> NonEmpty MetricTransformation -> PutMetricFilter
- data PutMetricFilterResponse = PutMetricFilterResponse' {
- newPutMetricFilterResponse :: PutMetricFilterResponse
- data DeleteRetentionPolicy = DeleteRetentionPolicy' Text
- newDeleteRetentionPolicy :: Text -> DeleteRetentionPolicy
- data DeleteRetentionPolicyResponse = DeleteRetentionPolicyResponse' {
- newDeleteRetentionPolicyResponse :: DeleteRetentionPolicyResponse
- data DeleteMetricFilter = DeleteMetricFilter' Text Text
- newDeleteMetricFilter :: Text -> Text -> DeleteMetricFilter
- data DeleteMetricFilterResponse = DeleteMetricFilterResponse' {
- newDeleteMetricFilterResponse :: DeleteMetricFilterResponse
- data PutRetentionPolicy = PutRetentionPolicy' Text Int
- newPutRetentionPolicy :: Text -> Int -> PutRetentionPolicy
- data PutRetentionPolicyResponse = PutRetentionPolicyResponse' {
- newPutRetentionPolicyResponse :: PutRetentionPolicyResponse
- data ListTagsLogGroup = ListTagsLogGroup' Text
- newListTagsLogGroup :: Text -> ListTagsLogGroup
- data ListTagsLogGroupResponse = ListTagsLogGroupResponse' (Maybe (HashMap Text Text)) Int
- newListTagsLogGroupResponse :: Int -> ListTagsLogGroupResponse
- data PutResourcePolicy = PutResourcePolicy' (Maybe Text) (Maybe Text)
- newPutResourcePolicy :: PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe ResourcePolicy) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' (Maybe Text)
- newDeleteResourcePolicy :: DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' {
- newDeleteResourcePolicyResponse :: DeleteResourcePolicyResponse
- data AssociateKmsKey = AssociateKmsKey' Text Text
- newAssociateKmsKey :: Text -> Text -> AssociateKmsKey
- data AssociateKmsKeyResponse = AssociateKmsKeyResponse' {
- newAssociateKmsKeyResponse :: AssociateKmsKeyResponse
- data GetQueryResults = GetQueryResults' Text
- newGetQueryResults :: Text -> GetQueryResults
- data GetQueryResultsResponse = GetQueryResultsResponse' (Maybe QueryStatus) (Maybe [[ResultField]]) (Maybe QueryStatistics) Int
- newGetQueryResultsResponse :: Int -> GetQueryResultsResponse
- data DescribeLogStreams = DescribeLogStreams' (Maybe OrderBy) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newDescribeLogStreams :: Text -> DescribeLogStreams
- data DescribeLogStreamsResponse = DescribeLogStreamsResponse' (Maybe Text) (Maybe [LogStream]) Int
- newDescribeLogStreamsResponse :: Int -> DescribeLogStreamsResponse
- newtype Distribution where
- Distribution' { }
- pattern Distribution_ByLogStream :: Distribution
- pattern Distribution_Random :: Distribution
- newtype ExportTaskStatusCode where
- ExportTaskStatusCode' { }
- pattern ExportTaskStatusCode_CANCELLED :: ExportTaskStatusCode
- pattern ExportTaskStatusCode_COMPLETED :: ExportTaskStatusCode
- pattern ExportTaskStatusCode_FAILED :: ExportTaskStatusCode
- pattern ExportTaskStatusCode_PENDING :: ExportTaskStatusCode
- pattern ExportTaskStatusCode_PENDING_CANCEL :: ExportTaskStatusCode
- pattern ExportTaskStatusCode_RUNNING :: ExportTaskStatusCode
- newtype OrderBy where
- OrderBy' {
- fromOrderBy :: Text
- pattern OrderBy_LastEventTime :: OrderBy
- pattern OrderBy_LogStreamName :: OrderBy
- OrderBy' {
- newtype QueryStatus where
- QueryStatus' { }
- pattern QueryStatus_Cancelled :: QueryStatus
- pattern QueryStatus_Complete :: QueryStatus
- pattern QueryStatus_Failed :: QueryStatus
- pattern QueryStatus_Running :: QueryStatus
- pattern QueryStatus_Scheduled :: QueryStatus
- pattern QueryStatus_Timeout :: QueryStatus
- pattern QueryStatus_Unknown :: QueryStatus
- newtype StandardUnit where
- StandardUnit' { }
- pattern StandardUnit_Bits :: StandardUnit
- pattern StandardUnit_Bits_Second :: StandardUnit
- pattern StandardUnit_Bytes :: StandardUnit
- pattern StandardUnit_Bytes_Second :: StandardUnit
- pattern StandardUnit_Count :: StandardUnit
- pattern StandardUnit_Count_Second :: StandardUnit
- pattern StandardUnit_Gigabits :: StandardUnit
- pattern StandardUnit_Gigabits_Second :: StandardUnit
- pattern StandardUnit_Gigabytes :: StandardUnit
- pattern StandardUnit_Gigabytes_Second :: StandardUnit
- pattern StandardUnit_Kilobits :: StandardUnit
- pattern StandardUnit_Kilobits_Second :: StandardUnit
- pattern StandardUnit_Kilobytes :: StandardUnit
- pattern StandardUnit_Kilobytes_Second :: StandardUnit
- pattern StandardUnit_Megabits :: StandardUnit
- pattern StandardUnit_Megabits_Second :: StandardUnit
- pattern StandardUnit_Megabytes :: StandardUnit
- pattern StandardUnit_Megabytes_Second :: StandardUnit
- pattern StandardUnit_Microseconds :: StandardUnit
- pattern StandardUnit_Milliseconds :: StandardUnit
- pattern StandardUnit_None :: StandardUnit
- pattern StandardUnit_Percent :: StandardUnit
- pattern StandardUnit_Seconds :: StandardUnit
- pattern StandardUnit_Terabits :: StandardUnit
- pattern StandardUnit_Terabits_Second :: StandardUnit
- pattern StandardUnit_Terabytes :: StandardUnit
- pattern StandardUnit_Terabytes_Second :: StandardUnit
- data Destination = Destination' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDestination :: Destination
- data ExportTask = ExportTask' (Maybe Text) (Maybe Text) (Maybe ExportTaskStatus) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe ExportTaskExecutionInfo)
- newExportTask :: ExportTask
- data ExportTaskExecutionInfo = ExportTaskExecutionInfo' (Maybe Natural) (Maybe Natural)
- newExportTaskExecutionInfo :: ExportTaskExecutionInfo
- data ExportTaskStatus = ExportTaskStatus' (Maybe ExportTaskStatusCode) (Maybe Text)
- newExportTaskStatus :: ExportTaskStatus
- data FilteredLogEvent = FilteredLogEvent' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newFilteredLogEvent :: FilteredLogEvent
- data InputLogEvent = InputLogEvent' Natural Text
- newInputLogEvent :: Natural -> Text -> InputLogEvent
- data LogGroup = LogGroup' (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Natural)
- newLogGroup :: LogGroup
- data LogGroupField = LogGroupField' (Maybe Natural) (Maybe Text)
- newLogGroupField :: LogGroupField
- data LogStream = LogStream' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural)
- newLogStream :: LogStream
- data MetricFilter = MetricFilter' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty MetricTransformation))
- newMetricFilter :: MetricFilter
- data MetricFilterMatchRecord = MetricFilterMatchRecord' (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text)
- newMetricFilterMatchRecord :: MetricFilterMatchRecord
- data MetricTransformation = MetricTransformation' (Maybe Double) (Maybe (HashMap Text Text)) (Maybe StandardUnit) Text Text Text
- newMetricTransformation :: Text -> Text -> Text -> MetricTransformation
- data OutputLogEvent = OutputLogEvent' (Maybe Natural) (Maybe Text) (Maybe Natural)
- newOutputLogEvent :: OutputLogEvent
- data QueryDefinition = QueryDefinition' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newQueryDefinition :: QueryDefinition
- data QueryInfo = QueryInfo' (Maybe QueryStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newQueryInfo :: QueryInfo
- data QueryStatistics = QueryStatistics' (Maybe Double) (Maybe Double) (Maybe Double)
- newQueryStatistics :: QueryStatistics
- data RejectedLogEventsInfo = RejectedLogEventsInfo' (Maybe Int) (Maybe Int) (Maybe Int)
- newRejectedLogEventsInfo :: RejectedLogEventsInfo
- data ResourcePolicy = ResourcePolicy' (Maybe Text) (Maybe Text) (Maybe Natural)
- newResourcePolicy :: ResourcePolicy
- data ResultField = ResultField' (Maybe Text) (Maybe Text)
- newResultField :: ResultField
- data SearchedLogStream = SearchedLogStream' (Maybe Text) (Maybe Bool)
- newSearchedLogStream :: SearchedLogStream
- data SubscriptionFilter = SubscriptionFilter' (Maybe Natural) (Maybe Text) (Maybe Distribution) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSubscriptionFilter :: SubscriptionFilter
Service Configuration
defaultService :: 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 #
A parameter is specified incorrectly.
InvalidSequenceTokenException
_InvalidSequenceTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The sequence token is not valid. You can get the correct sequence token
in the expectedSequenceToken field in the
InvalidSequenceTokenException message.
UnrecognizedClientException
_UnrecognizedClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The most likely cause is an invalid Amazon Web Services access key ID or secret key.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource already exists.
OperationAbortedException
_OperationAbortedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Multiple requests to update the same resource were in conflict.
MalformedQueryException
_MalformedQueryException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The query string is not valid. Details about this error are displayed in
a QueryCompileError object. For more information, see
QueryCompileError.
For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service cannot complete the request.
DataAlreadyAcceptedException
_DataAlreadyAcceptedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The event was already logged.
InvalidOperationException
_InvalidOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is not valid on the specified resource.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource does not exist.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
GetLogGroupFields
data GetLogGroupFields Source #
See: newGetLogGroupFields smart constructor.
Constructors
| GetLogGroupFields' (Maybe Natural) Text |
Instances
Arguments
| :: Text | |
| -> GetLogGroupFields |
Create a value of GetLogGroupFields 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:time:GetLogGroupFields', getLogGroupFields_time - The time to set as the center of the query. If you specify time, the
15 minutes before this time are queries. If you omit time the 8
minutes before and 8 minutes after this time are searched.
The time value is specified as epoch time, the number of seconds since
January 1, 1970, 00:00:00 UTC.
$sel:logGroupName:GetLogGroupFields', getLogGroupFields_logGroupName - The name of the log group to search.
data GetLogGroupFieldsResponse Source #
See: newGetLogGroupFieldsResponse smart constructor.
Constructors
| GetLogGroupFieldsResponse' (Maybe [LogGroupField]) Int |
Instances
newGetLogGroupFieldsResponse Source #
Create a value of GetLogGroupFieldsResponse 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:logGroupFields:GetLogGroupFieldsResponse', getLogGroupFieldsResponse_logGroupFields - The array of fields found in the query. Each object in the array
contains the name of the field, along with the percentage of time it
appeared in the log events that were queried.
$sel:httpStatus:GetLogGroupFieldsResponse', getLogGroupFieldsResponse_httpStatus - The response's http status code.
GetLogRecord
data GetLogRecord Source #
See: newGetLogRecord smart constructor.
Constructors
| GetLogRecord' Text |
Instances
Arguments
| :: Text | |
| -> GetLogRecord |
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: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.
data GetLogRecordResponse Source #
See: newGetLogRecordResponse smart constructor.
Instances
newGetLogRecordResponse Source #
Arguments
| :: Int | |
| -> GetLogRecordResponse |
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.
DescribeDestinations (Paginated)
data DescribeDestinations Source #
See: newDescribeDestinations smart constructor.
Instances
newDescribeDestinations :: DescribeDestinations Source #
Create a value of DescribeDestinations 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:nextToken:DescribeDestinations', describeDestinations_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:limit:DescribeDestinations', describeDestinations_limit - The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
$sel:destinationNamePrefix:DescribeDestinations', describeDestinations_destinationNamePrefix - The prefix to match. If you don't specify a value, no prefix filter is
applied.
data DescribeDestinationsResponse Source #
See: newDescribeDestinationsResponse smart constructor.
Constructors
| DescribeDestinationsResponse' (Maybe Text) (Maybe [Destination]) Int |
Instances
newDescribeDestinationsResponse Source #
Create a value of DescribeDestinationsResponse 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:nextToken:DescribeDestinations', describeDestinationsResponse_nextToken - Undocumented member.
$sel:destinations:DescribeDestinationsResponse', describeDestinationsResponse_destinations - The destinations.
$sel:httpStatus:DescribeDestinationsResponse', describeDestinationsResponse_httpStatus - The response's http status code.
UntagLogGroup
data UntagLogGroup Source #
See: newUntagLogGroup smart constructor.
Constructors
| UntagLogGroup' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagLogGroup |
Create a value of UntagLogGroup 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:logGroupName:UntagLogGroup', untagLogGroup_logGroupName - The name of the log group.
$sel:tags:UntagLogGroup', untagLogGroup_tags - The tag keys. The corresponding tags are removed from the log group.
data UntagLogGroupResponse Source #
See: newUntagLogGroupResponse smart constructor.
Constructors
| UntagLogGroupResponse' | |
Instances
newUntagLogGroupResponse :: UntagLogGroupResponse Source #
Create a value of UntagLogGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopQuery
See: newStopQuery smart constructor.
Constructors
| StopQuery' Text |
Instances
Create a value of StopQuery 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:queryId:StopQuery', stopQuery_queryId - The ID number of the query to stop. To find this ID number, use
DescribeQueries.
data StopQueryResponse Source #
See: newStopQueryResponse smart constructor.
Constructors
| StopQueryResponse' (Maybe Bool) Int |
Instances
Arguments
| :: Int | |
| -> StopQueryResponse |
Create a value of StopQueryResponse 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:success:StopQueryResponse', stopQueryResponse_success - This is true if the query was stopped by the StopQuery operation.
$sel:httpStatus:StopQueryResponse', stopQueryResponse_httpStatus - The response's http status code.
CreateExportTask
data CreateExportTask Source #
See: newCreateExportTask smart constructor.
Instances
Arguments
| :: Text | |
| -> Natural | |
| -> Natural | |
| -> Text | |
| -> CreateExportTask |
Create a value of CreateExportTask 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:destinationPrefix:CreateExportTask', createExportTask_destinationPrefix - The prefix used as the start of the key for every object exported. If
you don't specify a value, the default is exportedlogs.
$sel:taskName:CreateExportTask', createExportTask_taskName - The name of the export task.
$sel:logStreamNamePrefix:CreateExportTask', createExportTask_logStreamNamePrefix - Export only log streams that match the provided prefix. If you don't
specify a value, no prefix filter is applied.
$sel:logGroupName:CreateExportTask', createExportTask_logGroupName - The name of the log group.
$sel:from:CreateExportTask', createExportTask_from - The start time of the range for the request, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp
earlier than this time are not exported.
$sel:to:CreateExportTask', createExportTask_to - The end time of the range for the request, expreswatchlogsdocused as the
number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
timestamp later than this time are not exported.
$sel:destination:CreateExportTask', createExportTask_destination - The name of S3 bucket for the exported log data. The bucket must be in
the same Amazon Web Services region.
data CreateExportTaskResponse Source #
See: newCreateExportTaskResponse smart constructor.
Constructors
| CreateExportTaskResponse' (Maybe Text) Int |
Instances
newCreateExportTaskResponse Source #
Create a value of CreateExportTaskResponse 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:taskId:CreateExportTaskResponse', createExportTaskResponse_taskId - The ID of the export task.
$sel:httpStatus:CreateExportTaskResponse', createExportTaskResponse_httpStatus - The response's http status code.
PutDestination
data PutDestination Source #
See: newPutDestination smart constructor.
Constructors
| PutDestination' Text Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> PutDestination |
Create a value of PutDestination 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:destinationName:PutDestination', putDestination_destinationName - A name for the destination.
$sel:targetArn:PutDestination', putDestination_targetArn - The ARN of an Amazon Kinesis stream to which to deliver matching log
events.
$sel:roleArn:PutDestination', putDestination_roleArn - The ARN of an IAM role that grants CloudWatch Logs permissions to call
the Amazon Kinesis PutRecord operation on the destination stream.
data PutDestinationResponse Source #
See: newPutDestinationResponse smart constructor.
Constructors
| PutDestinationResponse' (Maybe Destination) Int |
Instances
newPutDestinationResponse Source #
Create a value of PutDestinationResponse 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:destination:PutDestinationResponse', putDestinationResponse_destination - The destination.
$sel:httpStatus:PutDestinationResponse', putDestinationResponse_httpStatus - The response's http status code.
DescribeSubscriptionFilters (Paginated)
data DescribeSubscriptionFilters Source #
See: newDescribeSubscriptionFilters smart constructor.
Instances
newDescribeSubscriptionFilters Source #
Create a value of DescribeSubscriptionFilters 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:filterNamePrefix:DescribeSubscriptionFilters', describeSubscriptionFilters_filterNamePrefix - The prefix to match. If you don't specify a value, no prefix filter is
applied.
$sel:nextToken:DescribeSubscriptionFilters', describeSubscriptionFilters_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:limit:DescribeSubscriptionFilters', describeSubscriptionFilters_limit - The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
$sel:logGroupName:DescribeSubscriptionFilters', describeSubscriptionFilters_logGroupName - The name of the log group.
data DescribeSubscriptionFiltersResponse Source #
See: newDescribeSubscriptionFiltersResponse smart constructor.
Constructors
| DescribeSubscriptionFiltersResponse' (Maybe [SubscriptionFilter]) (Maybe Text) Int |
Instances
newDescribeSubscriptionFiltersResponse Source #
Arguments
| :: Int | |
| -> DescribeSubscriptionFiltersResponse |
Create a value of DescribeSubscriptionFiltersResponse 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:subscriptionFilters:DescribeSubscriptionFiltersResponse', describeSubscriptionFiltersResponse_subscriptionFilters - The subscription filters.
$sel:nextToken:DescribeSubscriptionFilters', describeSubscriptionFiltersResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeSubscriptionFiltersResponse', describeSubscriptionFiltersResponse_httpStatus - The response's http status code.
GetLogEvents
data GetLogEvents Source #
See: newGetLogEvents smart constructor.
Constructors
| GetLogEvents' (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Natural) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetLogEvents |
Create a value of GetLogEvents 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:startTime:GetLogEvents', getLogEvents_startTime - The start of the time range, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this
time or later than this time are included. Events with a timestamp
earlier than this time are not included.
$sel:startFromHead:GetLogEvents', getLogEvents_startFromHead - If the value is true, the earliest log events are returned first. If the
value is false, the latest log events are returned first. The default
value is false.
If you are using a previous nextForwardToken value as the nextToken
in this operation, you must specify true for startFromHead.
$sel:nextToken:GetLogEvents', getLogEvents_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:endTime:GetLogEvents', getLogEvents_endTime - The end of the time range, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than
this time are not included.
$sel:limit:GetLogEvents', getLogEvents_limit - The maximum number of log events returned. If you don't specify a
value, the maximum is as many log events as can fit in a response size
of 1 MB, up to 10,000 log events.
$sel:logGroupName:GetLogEvents', getLogEvents_logGroupName - The name of the log group.
$sel:logStreamName:GetLogEvents', getLogEvents_logStreamName - The name of the log stream.
data GetLogEventsResponse Source #
See: newGetLogEventsResponse smart constructor.
Constructors
| GetLogEventsResponse' (Maybe Text) (Maybe Text) (Maybe [OutputLogEvent]) Int |
Instances
newGetLogEventsResponse Source #
Arguments
| :: Int | |
| -> GetLogEventsResponse |
Create a value of GetLogEventsResponse 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:nextBackwardToken:GetLogEventsResponse', getLogEventsResponse_nextBackwardToken - The token for the next set of items in the backward direction. The token
expires after 24 hours. This token is never null. If you have reached
the end of the stream, it returns the same token you passed in.
$sel:nextForwardToken:GetLogEventsResponse', getLogEventsResponse_nextForwardToken - The token for the next set of items in the forward direction. The token
expires after 24 hours. If you have reached the end of the stream, it
returns the same token you passed in.
$sel:events:GetLogEventsResponse', getLogEventsResponse_events - The events.
$sel:httpStatus:GetLogEventsResponse', getLogEventsResponse_httpStatus - The response's http status code.
DescribeLogGroups (Paginated)
data DescribeLogGroups Source #
See: newDescribeLogGroups smart constructor.
Instances
newDescribeLogGroups :: DescribeLogGroups Source #
Create a value of DescribeLogGroups 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:logGroupNamePrefix:DescribeLogGroups', describeLogGroups_logGroupNamePrefix - The prefix to match.
$sel:nextToken:DescribeLogGroups', describeLogGroups_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:limit:DescribeLogGroups', describeLogGroups_limit - The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
data DescribeLogGroupsResponse Source #
See: newDescribeLogGroupsResponse smart constructor.
Instances
newDescribeLogGroupsResponse Source #
Create a value of DescribeLogGroupsResponse 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:logGroups:DescribeLogGroupsResponse', describeLogGroupsResponse_logGroups - The log groups.
If the retentionInDays value if not included for a log group, then
that log group is set to have its events never expire.
$sel:nextToken:DescribeLogGroups', describeLogGroupsResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeLogGroupsResponse', describeLogGroupsResponse_httpStatus - The response's http status code.
DeleteDestination
data DeleteDestination Source #
See: newDeleteDestination smart constructor.
Constructors
| DeleteDestination' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDestination |
Create a value of DeleteDestination 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:destinationName:DeleteDestination', deleteDestination_destinationName - The name of the destination.
data DeleteDestinationResponse Source #
See: newDeleteDestinationResponse smart constructor.
Constructors
| DeleteDestinationResponse' | |
Instances
newDeleteDestinationResponse :: DeleteDestinationResponse Source #
Create a value of DeleteDestinationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisassociateKmsKey
data DisassociateKmsKey Source #
See: newDisassociateKmsKey smart constructor.
Constructors
| DisassociateKmsKey' Text |
Instances
newDisassociateKmsKey Source #
Arguments
| :: Text | |
| -> DisassociateKmsKey |
Create a value of DisassociateKmsKey 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:logGroupName:DisassociateKmsKey', disassociateKmsKey_logGroupName - The name of the log group.
data DisassociateKmsKeyResponse Source #
See: newDisassociateKmsKeyResponse smart constructor.
Constructors
| DisassociateKmsKeyResponse' | |
Instances
newDisassociateKmsKeyResponse :: DisassociateKmsKeyResponse Source #
Create a value of DisassociateKmsKeyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
FilterLogEvents (Paginated)
data FilterLogEvents Source #
See: newFilterLogEvents smart constructor.
Constructors
| FilterLogEvents' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Bool) Text |
Instances
Arguments
| :: Text | |
| -> FilterLogEvents |
Create a value of FilterLogEvents 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:startTime:FilterLogEvents', filterLogEvents_startTime - The start of the time range, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time
are not returned.
$sel:nextToken:FilterLogEvents', filterLogEvents_nextToken - The token for the next set of events to return. (You received this token
from a previous call.)
$sel:logStreamNames:FilterLogEvents', filterLogEvents_logStreamNames - Filters the results to only logs from the log streams in this list.
If you specify a value for both logStreamNamePrefix and
logStreamNames, the action returns an InvalidParameterException
error.
$sel:logStreamNamePrefix:FilterLogEvents', filterLogEvents_logStreamNamePrefix - Filters the results to include only events from log streams that have
names starting with this prefix.
If you specify a value for both logStreamNamePrefix and
logStreamNames, but the value for logStreamNamePrefix does not match
any log stream names specified in logStreamNames, the action returns
an InvalidParameterException error.
$sel:endTime:FilterLogEvents', filterLogEvents_endTime - The end of the time range, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time
are not returned.
$sel:limit:FilterLogEvents', filterLogEvents_limit - The maximum number of events to return. The default is 10,000 events.
$sel:filterPattern:FilterLogEvents', filterLogEvents_filterPattern - The filter pattern to use. For more information, see
Filter and Pattern Syntax.
If not provided, all the events are matched.
$sel:interleaved:FilterLogEvents', filterLogEvents_interleaved - If the value is true, the operation makes a best effort to provide
responses that contain events from multiple log streams within the log
group, interleaved in a single response. If the value is false, all the
matched log events in the first log stream are searched first, then
those in the next log stream, and so on. The default is false.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
$sel:logGroupName:FilterLogEvents', filterLogEvents_logGroupName - The name of the log group to search.
data FilterLogEventsResponse Source #
See: newFilterLogEventsResponse smart constructor.
Constructors
| FilterLogEventsResponse' (Maybe [SearchedLogStream]) (Maybe Text) (Maybe [FilteredLogEvent]) Int |
Instances
newFilterLogEventsResponse Source #
Create a value of FilterLogEventsResponse 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:searchedLogStreams:FilterLogEventsResponse', filterLogEventsResponse_searchedLogStreams - IMPORTANT Starting on May 15, 2020, this parameter will be
deprecated. This parameter will be an empty list after the deprecation
occurs.
Indicates which log streams have been searched and whether each has been searched completely.
$sel:nextToken:FilterLogEvents', filterLogEventsResponse_nextToken - The token to use when requesting the next set of items. The token
expires after 24 hours.
$sel:events:FilterLogEventsResponse', filterLogEventsResponse_events - The matched events.
$sel:httpStatus:FilterLogEventsResponse', filterLogEventsResponse_httpStatus - The response's http status code.
DeleteQueryDefinition
data DeleteQueryDefinition Source #
See: newDeleteQueryDefinition smart constructor.
Constructors
| DeleteQueryDefinition' Text |
Instances
newDeleteQueryDefinition Source #
Create a value of DeleteQueryDefinition 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:queryDefinitionId:DeleteQueryDefinition', deleteQueryDefinition_queryDefinitionId - The ID of the query definition that you want to delete. You can use
DescribeQueryDefinitions
to retrieve the IDs of your saved query definitions.
data DeleteQueryDefinitionResponse Source #
See: newDeleteQueryDefinitionResponse smart constructor.
Constructors
| DeleteQueryDefinitionResponse' (Maybe Bool) Int |
Instances
newDeleteQueryDefinitionResponse Source #
Create a value of DeleteQueryDefinitionResponse 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:success:DeleteQueryDefinitionResponse', deleteQueryDefinitionResponse_success - A value of TRUE indicates that the operation succeeded. FALSE indicates
that the operation failed.
$sel:httpStatus:DeleteQueryDefinitionResponse', deleteQueryDefinitionResponse_httpStatus - The response's http status code.
PutQueryDefinition
data PutQueryDefinition Source #
See: newPutQueryDefinition smart constructor.
Instances
newPutQueryDefinition Source #
Arguments
| :: Text | |
| -> Text | |
| -> PutQueryDefinition |
Create a value of PutQueryDefinition 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:logGroupNames:PutQueryDefinition', putQueryDefinition_logGroupNames - Use this parameter to include specific log groups as part of your query
definition.
If you are updating a query definition and you omit this parameter, then the updated definition will contain no log groups.
$sel:queryDefinitionId:PutQueryDefinition', putQueryDefinition_queryDefinitionId - If you are updating a query definition, use this parameter to specify
the ID of the query definition that you want to update. You can use
DescribeQueryDefinitions
to retrieve the IDs of your saved query definitions.
If you are creating a query definition, do not specify this parameter. CloudWatch generates a unique ID for the new query definition and include it in the response to this operation.
$sel:name:PutQueryDefinition', putQueryDefinition_name - A name for the query definition. If you are saving a lot of query
definitions, we recommend that you name them so that you can easily find
the ones you want by using the first part of the name as a filter in the
queryDefinitionNamePrefix parameter of
DescribeQueryDefinitions.
$sel:queryString:PutQueryDefinition', putQueryDefinition_queryString - The query string to use for this definition. For more information, see
CloudWatch Logs Insights Query Syntax.
data PutQueryDefinitionResponse Source #
See: newPutQueryDefinitionResponse smart constructor.
Constructors
| PutQueryDefinitionResponse' (Maybe Text) Int |
Instances
newPutQueryDefinitionResponse Source #
Create a value of PutQueryDefinitionResponse 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:queryDefinitionId:PutQueryDefinition', putQueryDefinitionResponse_queryDefinitionId - The ID of the query definition.
$sel:httpStatus:PutQueryDefinitionResponse', putQueryDefinitionResponse_httpStatus - The response's http status code.
TagLogGroup
data TagLogGroup Source #
See: newTagLogGroup smart constructor.
Constructors
| TagLogGroup' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagLogGroup |
Create a value of TagLogGroup 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:logGroupName:TagLogGroup', tagLogGroup_logGroupName - The name of the log group.
$sel:tags:TagLogGroup', tagLogGroup_tags - The key-value pairs to use for the tags.
data TagLogGroupResponse Source #
See: newTagLogGroupResponse smart constructor.
Constructors
| TagLogGroupResponse' | |
Instances
newTagLogGroupResponse :: TagLogGroupResponse Source #
Create a value of TagLogGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeResourcePolicies (Paginated)
data DescribeResourcePolicies Source #
See: newDescribeResourcePolicies smart constructor.
Constructors
| DescribeResourcePolicies' (Maybe Text) (Maybe Natural) |
Instances
newDescribeResourcePolicies :: DescribeResourcePolicies Source #
Create a value of DescribeResourcePolicies 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:nextToken:DescribeResourcePolicies', describeResourcePolicies_nextToken - Undocumented member.
$sel:limit:DescribeResourcePolicies', describeResourcePolicies_limit - The maximum number of resource policies to be displayed with one call of
this API.
data DescribeResourcePoliciesResponse Source #
See: newDescribeResourcePoliciesResponse smart constructor.
Constructors
| DescribeResourcePoliciesResponse' (Maybe [ResourcePolicy]) (Maybe Text) Int |
Instances
newDescribeResourcePoliciesResponse Source #
Create a value of DescribeResourcePoliciesResponse 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:resourcePolicies:DescribeResourcePoliciesResponse', describeResourcePoliciesResponse_resourcePolicies - The resource policies that exist in this account.
$sel:nextToken:DescribeResourcePolicies', describeResourcePoliciesResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeResourcePoliciesResponse', describeResourcePoliciesResponse_httpStatus - The response's http status code.
DescribeQueryDefinitions
data DescribeQueryDefinitions Source #
See: newDescribeQueryDefinitions smart constructor.
Instances
newDescribeQueryDefinitions :: DescribeQueryDefinitions Source #
Create a value of DescribeQueryDefinitions 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:queryDefinitionNamePrefix:DescribeQueryDefinitions', describeQueryDefinitions_queryDefinitionNamePrefix - Use this parameter to filter your results to only the query definitions
that have names that start with the prefix you specify.
$sel:nextToken:DescribeQueryDefinitions', describeQueryDefinitions_nextToken - Undocumented member.
$sel:maxResults:DescribeQueryDefinitions', describeQueryDefinitions_maxResults - Limits the number of returned query definitions to the specified number.
data DescribeQueryDefinitionsResponse Source #
See: newDescribeQueryDefinitionsResponse smart constructor.
Constructors
| DescribeQueryDefinitionsResponse' (Maybe [QueryDefinition]) (Maybe Text) Int |
Instances
newDescribeQueryDefinitionsResponse Source #
Create a value of DescribeQueryDefinitionsResponse 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:queryDefinitions:DescribeQueryDefinitionsResponse', describeQueryDefinitionsResponse_queryDefinitions - The list of query definitions that match your request.
$sel:nextToken:DescribeQueryDefinitions', describeQueryDefinitionsResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeQueryDefinitionsResponse', describeQueryDefinitionsResponse_httpStatus - The response's http status code.
DeleteLogStream
data DeleteLogStream Source #
See: newDeleteLogStream smart constructor.
Constructors
| DeleteLogStream' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteLogStream |
Create a value of DeleteLogStream 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:logGroupName:DeleteLogStream', deleteLogStream_logGroupName - The name of the log group.
$sel:logStreamName:DeleteLogStream', deleteLogStream_logStreamName - The name of the log stream.
data DeleteLogStreamResponse Source #
See: newDeleteLogStreamResponse smart constructor.
Constructors
| DeleteLogStreamResponse' | |
Instances
newDeleteLogStreamResponse :: DeleteLogStreamResponse Source #
Create a value of DeleteLogStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeQueries (Paginated)
data DescribeQueries Source #
See: newDescribeQueries smart constructor.
Constructors
| DescribeQueries' (Maybe QueryStatus) (Maybe Text) (Maybe Text) (Maybe Natural) |
Instances
newDescribeQueries :: DescribeQueries Source #
Create a value of DescribeQueries 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:status:DescribeQueries', describeQueries_status - Limits the returned queries to only those that have the specified
status. Valid values are Cancelled, Complete, Failed, Running,
and Scheduled.
$sel:logGroupName:DescribeQueries', describeQueries_logGroupName - Limits the returned queries to only those for the specified log group.
$sel:nextToken:DescribeQueries', describeQueries_nextToken - Undocumented member.
$sel:maxResults:DescribeQueries', describeQueries_maxResults - Limits the number of returned queries to the specified number.
data DescribeQueriesResponse Source #
See: newDescribeQueriesResponse smart constructor.
Instances
newDescribeQueriesResponse Source #
Create a value of DescribeQueriesResponse 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:queries:DescribeQueriesResponse', describeQueriesResponse_queries - The list of queries that match the request.
$sel:nextToken:DescribeQueries', describeQueriesResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribeQueriesResponse', describeQueriesResponse_httpStatus - The response's http status code.
CreateLogStream
data CreateLogStream Source #
See: newCreateLogStream smart constructor.
Constructors
| CreateLogStream' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateLogStream |
Create a value of CreateLogStream 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:logGroupName:CreateLogStream', createLogStream_logGroupName - The name of the log group.
$sel:logStreamName:CreateLogStream', createLogStream_logStreamName - The name of the log stream.
data CreateLogStreamResponse Source #
See: newCreateLogStreamResponse smart constructor.
Constructors
| CreateLogStreamResponse' | |
Instances
newCreateLogStreamResponse :: CreateLogStreamResponse Source #
Create a value of CreateLogStreamResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateLogGroup
data CreateLogGroup Source #
See: newCreateLogGroup smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateLogGroup |
Create a value of CreateLogGroup 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:kmsKeyId:CreateLogGroup', createLogGroup_kmsKeyId - The Amazon Resource Name (ARN) of the CMK to use when encrypting log
data. For more information, see
Amazon Resource Names - Key Management Service.
$sel:tags:CreateLogGroup', createLogGroup_tags - The key-value pairs to use for the tags.
CloudWatch Logs doesn’t support IAM policies that prevent users from
assigning specified tags to log groups using the
aws:Resource/key-name or aws:TagKeys condition keys. For more
information about using tags to control access, see
Controlling access to Amazon Web Services resources using tags.
$sel:logGroupName:CreateLogGroup', createLogGroup_logGroupName - The name of the log group.
data CreateLogGroupResponse Source #
See: newCreateLogGroupResponse smart constructor.
Constructors
| CreateLogGroupResponse' | |
Instances
newCreateLogGroupResponse :: CreateLogGroupResponse Source #
Create a value of CreateLogGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeExportTasks (Paginated)
data DescribeExportTasks Source #
See: newDescribeExportTasks smart constructor.
Constructors
| DescribeExportTasks' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe ExportTaskStatusCode) |
Instances
newDescribeExportTasks :: DescribeExportTasks Source #
Create a value of DescribeExportTasks 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:taskId:DescribeExportTasks', describeExportTasks_taskId - The ID of the export task. Specifying a task ID filters the results to
zero or one export tasks.
$sel:nextToken:DescribeExportTasks', describeExportTasks_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:limit:DescribeExportTasks', describeExportTasks_limit - The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
$sel:statusCode:DescribeExportTasks', describeExportTasks_statusCode - The status code of the export task. Specifying a status code filters the
results to zero or more export tasks.
data DescribeExportTasksResponse Source #
See: newDescribeExportTasksResponse smart constructor.
Constructors
| DescribeExportTasksResponse' (Maybe Text) (Maybe [ExportTask]) Int |
Instances
newDescribeExportTasksResponse Source #
Create a value of DescribeExportTasksResponse 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:nextToken:DescribeExportTasks', describeExportTasksResponse_nextToken - Undocumented member.
$sel:exportTasks:DescribeExportTasksResponse', describeExportTasksResponse_exportTasks - The export tasks.
$sel:httpStatus:DescribeExportTasksResponse', describeExportTasksResponse_httpStatus - The response's http status code.
CancelExportTask
data CancelExportTask Source #
See: newCancelExportTask smart constructor.
Constructors
| CancelExportTask' Text |
Instances
Arguments
| :: Text | |
| -> CancelExportTask |
Create a value of CancelExportTask 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:taskId:CancelExportTask', cancelExportTask_taskId - The ID of the export task.
data CancelExportTaskResponse Source #
See: newCancelExportTaskResponse smart constructor.
Constructors
| CancelExportTaskResponse' | |
Instances
newCancelExportTaskResponse :: CancelExportTaskResponse Source #
Create a value of CancelExportTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutSubscriptionFilter
data PutSubscriptionFilter Source #
See: newPutSubscriptionFilter smart constructor.
Constructors
| PutSubscriptionFilter' (Maybe Distribution) (Maybe Text) Text Text Text Text |
Instances
newPutSubscriptionFilter Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> PutSubscriptionFilter |
Create a value of PutSubscriptionFilter 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:distribution:PutSubscriptionFilter', putSubscriptionFilter_distribution - The method used to distribute log data to the destination. By default,
log data is grouped by log stream, but the grouping can be set to random
for a more even distribution. This property is only applicable when the
destination is an Amazon Kinesis stream.
$sel:roleArn:PutSubscriptionFilter', putSubscriptionFilter_roleArn - The ARN of an IAM role that grants CloudWatch Logs permissions to
deliver ingested log events to the destination stream. You don't need
to provide the ARN when you are working with a logical destination for
cross-account delivery.
$sel:logGroupName:PutSubscriptionFilter', putSubscriptionFilter_logGroupName - The name of the log group.
$sel:filterName:PutSubscriptionFilter', putSubscriptionFilter_filterName - A name for the subscription filter. If you are updating an existing
filter, you must specify the correct name in filterName. To find the
name of the filter currently associated with a log group, use
DescribeSubscriptionFilters.
$sel:filterPattern:PutSubscriptionFilter', putSubscriptionFilter_filterPattern - A filter pattern for subscribing to a filtered stream of log events.
$sel:destinationArn:PutSubscriptionFilter', putSubscriptionFilter_destinationArn - The ARN of the destination to deliver matching log events to. Currently,
the supported destinations are:
- An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.
If you are setting up a cross-account subscription, the destination must have an IAM policy associated with it that allows the sender to send logs to the destination. For more information, see PutDestinationPolicy.
- An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.
- A Lambda function belonging to the same account as the subscription filter, for same-account delivery.
data PutSubscriptionFilterResponse Source #
See: newPutSubscriptionFilterResponse smart constructor.
Constructors
| PutSubscriptionFilterResponse' | |
Instances
| Eq PutSubscriptionFilterResponse Source # | |
| Read PutSubscriptionFilterResponse Source # | |
| Show PutSubscriptionFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods showsPrec :: Int -> PutSubscriptionFilterResponse -> ShowS # show :: PutSubscriptionFilterResponse -> String # showList :: [PutSubscriptionFilterResponse] -> ShowS # | |
| Generic PutSubscriptionFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Associated Types type Rep PutSubscriptionFilterResponse :: Type -> Type # | |
| NFData PutSubscriptionFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutSubscriptionFilter Methods rnf :: PutSubscriptionFilterResponse -> () # | |
| type Rep PutSubscriptionFilterResponse Source # | |
newPutSubscriptionFilterResponse :: PutSubscriptionFilterResponse Source #
Create a value of PutSubscriptionFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartQuery
data StartQuery Source #
See: newStartQuery smart constructor.
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> Text | |
| -> StartQuery |
Create a value of StartQuery 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:logGroupNames:StartQuery', startQuery_logGroupNames - The list of log groups to be queried. You can include up to 20 log
groups.
A StartQuery operation must include a logGroupNames or a
logGroupName parameter, but not both.
$sel:logGroupName:StartQuery', startQuery_logGroupName - The log group on which to perform the query.
A StartQuery operation must include a logGroupNames or a
logGroupName parameter, but not both.
$sel:limit:StartQuery', startQuery_limit - The maximum number of log events to return in the query. If the query
string uses the fields command, only the specified fields and their
values are returned. The default is 1000.
$sel:startTime:StartQuery', startQuery_startTime - The beginning of the time range to query. The range is inclusive, so the
specified start time is included in the query. Specified as epoch time,
the number of seconds since January 1, 1970, 00:00:00 UTC.
$sel:endTime:StartQuery', startQuery_endTime - The end of the time range to query. The range is inclusive, so the
specified end time is included in the query. Specified as epoch time,
the number of seconds since January 1, 1970, 00:00:00 UTC.
$sel:queryString:StartQuery', startQuery_queryString - The query string to use. For more information, see
CloudWatch Logs Insights Query Syntax.
data StartQueryResponse Source #
See: newStartQueryResponse smart constructor.
Constructors
| StartQueryResponse' (Maybe Text) Int |
Instances
newStartQueryResponse Source #
Arguments
| :: Int | |
| -> StartQueryResponse |
Create a value of StartQueryResponse 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:queryId:StartQueryResponse', startQueryResponse_queryId - The unique ID of the query.
$sel:httpStatus:StartQueryResponse', startQueryResponse_httpStatus - The response's http status code.
DeleteLogGroup
data DeleteLogGroup Source #
See: newDeleteLogGroup smart constructor.
Constructors
| DeleteLogGroup' Text |
Instances
Arguments
| :: Text | |
| -> DeleteLogGroup |
Create a value of DeleteLogGroup 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:logGroupName:DeleteLogGroup', deleteLogGroup_logGroupName - The name of the log group.
data DeleteLogGroupResponse Source #
See: newDeleteLogGroupResponse smart constructor.
Constructors
| DeleteLogGroupResponse' | |
Instances
newDeleteLogGroupResponse :: DeleteLogGroupResponse Source #
Create a value of DeleteLogGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteSubscriptionFilter
data DeleteSubscriptionFilter Source #
See: newDeleteSubscriptionFilter smart constructor.
Constructors
| DeleteSubscriptionFilter' Text Text |
Instances
newDeleteSubscriptionFilter Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteSubscriptionFilter |
Create a value of DeleteSubscriptionFilter 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:logGroupName:DeleteSubscriptionFilter', deleteSubscriptionFilter_logGroupName - The name of the log group.
$sel:filterName:DeleteSubscriptionFilter', deleteSubscriptionFilter_filterName - The name of the subscription filter.
data DeleteSubscriptionFilterResponse Source #
See: newDeleteSubscriptionFilterResponse smart constructor.
Constructors
| DeleteSubscriptionFilterResponse' | |
Instances
newDeleteSubscriptionFilterResponse :: DeleteSubscriptionFilterResponse Source #
Create a value of DeleteSubscriptionFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutLogEvents
data PutLogEvents Source #
See: newPutLogEvents smart constructor.
Constructors
| PutLogEvents' (Maybe Text) Text Text (NonEmpty InputLogEvent) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty InputLogEvent | |
| -> PutLogEvents |
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.
data PutLogEventsResponse Source #
See: newPutLogEventsResponse smart constructor.
Constructors
| PutLogEventsResponse' (Maybe RejectedLogEventsInfo) (Maybe Text) Int |
Instances
newPutLogEventsResponse Source #
Arguments
| :: Int | |
| -> PutLogEventsResponse |
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.
DescribeMetricFilters (Paginated)
data DescribeMetricFilters Source #
See: newDescribeMetricFilters smart constructor.
Constructors
| DescribeMetricFilters' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) |
Instances
newDescribeMetricFilters :: DescribeMetricFilters Source #
Create a value of DescribeMetricFilters 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:filterNamePrefix:DescribeMetricFilters', describeMetricFilters_filterNamePrefix - The prefix to match. CloudWatch Logs uses the value you set here only if
you also include the logGroupName parameter in your request.
$sel:metricName:DescribeMetricFilters', describeMetricFilters_metricName - Filters results to include only those with the specified metric name. If
you include this parameter in your request, you must also include the
metricNamespace parameter.
$sel:logGroupName:DescribeMetricFilters', describeMetricFilters_logGroupName - The name of the log group.
$sel:nextToken:DescribeMetricFilters', describeMetricFilters_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:metricNamespace:DescribeMetricFilters', describeMetricFilters_metricNamespace - Filters results to include only those in the specified namespace. If you
include this parameter in your request, you must also include the
metricName parameter.
$sel:limit:DescribeMetricFilters', describeMetricFilters_limit - The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
data DescribeMetricFiltersResponse Source #
See: newDescribeMetricFiltersResponse smart constructor.
Constructors
| DescribeMetricFiltersResponse' (Maybe Text) (Maybe [MetricFilter]) Int |
Instances
newDescribeMetricFiltersResponse Source #
Create a value of DescribeMetricFiltersResponse 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:nextToken:DescribeMetricFilters', describeMetricFiltersResponse_nextToken - Undocumented member.
$sel:metricFilters:DescribeMetricFiltersResponse', describeMetricFiltersResponse_metricFilters - The metric filters.
$sel:httpStatus:DescribeMetricFiltersResponse', describeMetricFiltersResponse_httpStatus - The response's http status code.
TestMetricFilter
data TestMetricFilter Source #
See: newTestMetricFilter smart constructor.
Constructors
| TestMetricFilter' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> TestMetricFilter |
Create a value of TestMetricFilter 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:filterPattern:TestMetricFilter', testMetricFilter_filterPattern - Undocumented member.
$sel:logEventMessages:TestMetricFilter', testMetricFilter_logEventMessages - The log event messages to test.
data TestMetricFilterResponse Source #
See: newTestMetricFilterResponse smart constructor.
Constructors
| TestMetricFilterResponse' (Maybe [MetricFilterMatchRecord]) Int |
Instances
newTestMetricFilterResponse Source #
Create a value of TestMetricFilterResponse 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:matches:TestMetricFilterResponse', testMetricFilterResponse_matches - The matched events.
$sel:httpStatus:TestMetricFilterResponse', testMetricFilterResponse_httpStatus - The response's http status code.
PutDestinationPolicy
data PutDestinationPolicy Source #
See: newPutDestinationPolicy smart constructor.
Constructors
| PutDestinationPolicy' Text Text |
Instances
newPutDestinationPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> PutDestinationPolicy |
Create a value of PutDestinationPolicy 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:destinationName:PutDestinationPolicy', putDestinationPolicy_destinationName - A name for an existing destination.
$sel:accessPolicy:PutDestinationPolicy', putDestinationPolicy_accessPolicy - An IAM policy document that authorizes cross-account users to deliver
their log events to the associated destination. This can be up to 5120
bytes.
data PutDestinationPolicyResponse Source #
See: newPutDestinationPolicyResponse smart constructor.
Constructors
| PutDestinationPolicyResponse' | |
Instances
| Eq PutDestinationPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy Methods (==) :: PutDestinationPolicyResponse -> PutDestinationPolicyResponse -> Bool # (/=) :: PutDestinationPolicyResponse -> PutDestinationPolicyResponse -> Bool # | |
| Read PutDestinationPolicyResponse Source # | |
| Show PutDestinationPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy Methods showsPrec :: Int -> PutDestinationPolicyResponse -> ShowS # show :: PutDestinationPolicyResponse -> String # showList :: [PutDestinationPolicyResponse] -> ShowS # | |
| Generic PutDestinationPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy Associated Types type Rep PutDestinationPolicyResponse :: Type -> Type # | |
| NFData PutDestinationPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy Methods rnf :: PutDestinationPolicyResponse -> () # | |
| type Rep PutDestinationPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutDestinationPolicy | |
newPutDestinationPolicyResponse :: PutDestinationPolicyResponse Source #
Create a value of PutDestinationPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutMetricFilter
data PutMetricFilter Source #
See: newPutMetricFilter smart constructor.
Constructors
| PutMetricFilter' Text Text Text (NonEmpty MetricTransformation) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> NonEmpty MetricTransformation | |
| -> PutMetricFilter |
Create a value of PutMetricFilter 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:logGroupName:PutMetricFilter', putMetricFilter_logGroupName - The name of the log group.
$sel:filterName:PutMetricFilter', putMetricFilter_filterName - A name for the metric filter.
$sel:filterPattern:PutMetricFilter', putMetricFilter_filterPattern - A filter pattern for extracting metric data out of ingested log events.
$sel:metricTransformations:PutMetricFilter', putMetricFilter_metricTransformations - A collection of information that defines how metric data gets emitted.
data PutMetricFilterResponse Source #
See: newPutMetricFilterResponse smart constructor.
Constructors
| PutMetricFilterResponse' | |
Instances
newPutMetricFilterResponse :: PutMetricFilterResponse Source #
Create a value of PutMetricFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRetentionPolicy
data DeleteRetentionPolicy Source #
See: newDeleteRetentionPolicy smart constructor.
Constructors
| DeleteRetentionPolicy' Text |
Instances
newDeleteRetentionPolicy Source #
Create a value of DeleteRetentionPolicy 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:logGroupName:DeleteRetentionPolicy', deleteRetentionPolicy_logGroupName - The name of the log group.
data DeleteRetentionPolicyResponse Source #
See: newDeleteRetentionPolicyResponse smart constructor.
Constructors
| DeleteRetentionPolicyResponse' | |
Instances
| Eq DeleteRetentionPolicyResponse Source # | |
| Read DeleteRetentionPolicyResponse Source # | |
| Show DeleteRetentionPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteRetentionPolicy Methods showsPrec :: Int -> DeleteRetentionPolicyResponse -> ShowS # show :: DeleteRetentionPolicyResponse -> String # showList :: [DeleteRetentionPolicyResponse] -> ShowS # | |
| Generic DeleteRetentionPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteRetentionPolicy Associated Types type Rep DeleteRetentionPolicyResponse :: Type -> Type # | |
| NFData DeleteRetentionPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteRetentionPolicy Methods rnf :: DeleteRetentionPolicyResponse -> () # | |
| type Rep DeleteRetentionPolicyResponse Source # | |
newDeleteRetentionPolicyResponse :: DeleteRetentionPolicyResponse Source #
Create a value of DeleteRetentionPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMetricFilter
data DeleteMetricFilter Source #
See: newDeleteMetricFilter smart constructor.
Constructors
| DeleteMetricFilter' Text Text |
Instances
newDeleteMetricFilter Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteMetricFilter |
Create a value of DeleteMetricFilter 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:logGroupName:DeleteMetricFilter', deleteMetricFilter_logGroupName - The name of the log group.
$sel:filterName:DeleteMetricFilter', deleteMetricFilter_filterName - The name of the metric filter.
data DeleteMetricFilterResponse Source #
See: newDeleteMetricFilterResponse smart constructor.
Constructors
| DeleteMetricFilterResponse' | |
Instances
newDeleteMetricFilterResponse :: DeleteMetricFilterResponse Source #
Create a value of DeleteMetricFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutRetentionPolicy
data PutRetentionPolicy Source #
See: newPutRetentionPolicy smart constructor.
Constructors
| PutRetentionPolicy' Text Int |
Instances
newPutRetentionPolicy Source #
Arguments
| :: Text | |
| -> Int | |
| -> PutRetentionPolicy |
Create a value of PutRetentionPolicy 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:logGroupName:PutRetentionPolicy', putRetentionPolicy_logGroupName - The name of the log group.
$sel:retentionInDays:PutRetentionPolicy', putRetentionPolicy_retentionInDays - Undocumented member.
data PutRetentionPolicyResponse Source #
See: newPutRetentionPolicyResponse smart constructor.
Constructors
| PutRetentionPolicyResponse' | |
Instances
newPutRetentionPolicyResponse :: PutRetentionPolicyResponse Source #
Create a value of PutRetentionPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListTagsLogGroup
data ListTagsLogGroup Source #
See: newListTagsLogGroup smart constructor.
Constructors
| ListTagsLogGroup' Text |
Instances
Arguments
| :: Text | |
| -> ListTagsLogGroup |
Create a value of ListTagsLogGroup 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:logGroupName:ListTagsLogGroup', listTagsLogGroup_logGroupName - The name of the log group.
data ListTagsLogGroupResponse Source #
See: newListTagsLogGroupResponse smart constructor.
Instances
newListTagsLogGroupResponse Source #
Create a value of ListTagsLogGroupResponse 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:tags:ListTagsLogGroupResponse', listTagsLogGroupResponse_tags - The tags for the log group.
$sel:httpStatus:ListTagsLogGroupResponse', listTagsLogGroupResponse_httpStatus - The response's http status code.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy smart constructor.
Constructors
| PutResourcePolicy' (Maybe Text) (Maybe Text) |
Instances
newPutResourcePolicy :: PutResourcePolicy Source #
Create a value of PutResourcePolicy 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:policyName:PutResourcePolicy', putResourcePolicy_policyName - Name of the new policy. This parameter is required.
$sel:policyDocument:PutResourcePolicy', putResourcePolicy_policyDocument - Details of the new policy, including the identity of the principal that
is enabled to put logs to this account. This is formatted as a JSON
string. This parameter is required.
The following example creates a resource policy enabling the Route 53
service to put DNS query logs in to the specified log group. Replace
"logArn" with the ARN of your CloudWatch Logs resource, such as a
log group or log stream.
CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.
In the example resource policy, you would replace the value of
SourceArn with the resource making the call from Route 53 to
CloudWatch Logs and replace the value of SourceAccount with the Amazon
Web Services account ID making that call.
{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse smart constructor.
Constructors
| PutResourcePolicyResponse' (Maybe ResourcePolicy) Int |
Instances
newPutResourcePolicyResponse Source #
Create a value of PutResourcePolicyResponse 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:resourcePolicy:PutResourcePolicyResponse', putResourcePolicyResponse_resourcePolicy - The new policy.
$sel:httpStatus:PutResourcePolicyResponse', putResourcePolicyResponse_httpStatus - The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy smart constructor.
Constructors
| DeleteResourcePolicy' (Maybe Text) |
Instances
newDeleteResourcePolicy :: DeleteResourcePolicy Source #
Create a value of DeleteResourcePolicy 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:policyName:DeleteResourcePolicy', deleteResourcePolicy_policyName - The name of the policy to be revoked. This parameter is required.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse smart constructor.
Constructors
| DeleteResourcePolicyResponse' | |
Instances
| Eq DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteResourcePolicy Methods (==) :: DeleteResourcePolicyResponse -> DeleteResourcePolicyResponse -> Bool # (/=) :: DeleteResourcePolicyResponse -> DeleteResourcePolicyResponse -> Bool # | |
| Read DeleteResourcePolicyResponse Source # | |
| Show DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteResourcePolicy Methods showsPrec :: Int -> DeleteResourcePolicyResponse -> ShowS # show :: DeleteResourcePolicyResponse -> String # showList :: [DeleteResourcePolicyResponse] -> ShowS # | |
| Generic DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteResourcePolicy Associated Types type Rep DeleteResourcePolicyResponse :: Type -> Type # | |
| NFData DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteResourcePolicy Methods rnf :: DeleteResourcePolicyResponse -> () # | |
| type Rep DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteResourcePolicy | |
newDeleteResourcePolicyResponse :: DeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AssociateKmsKey
data AssociateKmsKey Source #
See: newAssociateKmsKey smart constructor.
Constructors
| AssociateKmsKey' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AssociateKmsKey |
Create a value of AssociateKmsKey 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:logGroupName:AssociateKmsKey', associateKmsKey_logGroupName - The name of the log group.
$sel:kmsKeyId:AssociateKmsKey', associateKmsKey_kmsKeyId - The Amazon Resource Name (ARN) of the CMK to use when encrypting log
data. This must be a symmetric CMK. For more information, see
Amazon Resource Names - Key Management Service
and
Using Symmetric and Asymmetric Keys.
data AssociateKmsKeyResponse Source #
See: newAssociateKmsKeyResponse smart constructor.
Constructors
| AssociateKmsKeyResponse' | |
Instances
newAssociateKmsKeyResponse :: AssociateKmsKeyResponse Source #
Create a value of AssociateKmsKeyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetQueryResults
data GetQueryResults Source #
See: newGetQueryResults smart constructor.
Constructors
| GetQueryResults' Text |
Instances
Arguments
| :: Text | |
| -> GetQueryResults |
Create a value of GetQueryResults 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:queryId:GetQueryResults', getQueryResults_queryId - The ID number of the query.
data GetQueryResultsResponse Source #
See: newGetQueryResultsResponse smart constructor.
Constructors
| GetQueryResultsResponse' (Maybe QueryStatus) (Maybe [[ResultField]]) (Maybe QueryStatistics) Int |
Instances
newGetQueryResultsResponse Source #
Create a value of GetQueryResultsResponse 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:status:GetQueryResultsResponse', getQueryResultsResponse_status - The status of the most recent running of the query. Possible values are
Cancelled, Complete, Failed, Running, Scheduled, Timeout,
and Unknown.
Queries time out after 15 minutes of execution. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
$sel:results:GetQueryResultsResponse', getQueryResultsResponse_results - The log events that matched the query criteria during the most recent
time it ran.
The results value is an array of arrays. Each log event is one object
in the top-level array. Each of these log event objects is an array of
field/value pairs.
$sel:statistics:GetQueryResultsResponse', getQueryResultsResponse_statistics - Includes the number of log events scanned by the query, the number of
log events that matched the query criteria, and the total number of
bytes in the log events that were scanned. These values reflect the full
raw results of the query.
$sel:httpStatus:GetQueryResultsResponse', getQueryResultsResponse_httpStatus - The response's http status code.
DescribeLogStreams (Paginated)
data DescribeLogStreams Source #
See: newDescribeLogStreams smart constructor.
Constructors
| DescribeLogStreams' (Maybe OrderBy) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Natural) Text |
Instances
newDescribeLogStreams Source #
Arguments
| :: Text | |
| -> DescribeLogStreams |
Create a value of DescribeLogStreams 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:orderBy:DescribeLogStreams', describeLogStreams_orderBy - If the value is LogStreamName, the results are ordered by log stream
name. If the value is LastEventTime, the results are ordered by the
event time. The default value is LogStreamName.
If you order the results by event time, you cannot specify the
logStreamNamePrefix parameter.
lastEventTimestamp represents the time of the most recent log event in
the log stream in CloudWatch Logs. This number is expressed as the
number of milliseconds after Jan 1, 1970 00:00:00 UTC.
lastEventTimestamp updates on an eventual consistency basis. It
typically updates in less than an hour from ingestion, but in rare
situations might take longer.
$sel:descending:DescribeLogStreams', describeLogStreams_descending - If the value is true, results are returned in descending order. If the
value is to false, results are returned in ascending order. The default
value is false.
$sel:nextToken:DescribeLogStreams', describeLogStreams_nextToken - The token for the next set of items to return. (You received this token
from a previous call.)
$sel:logStreamNamePrefix:DescribeLogStreams', describeLogStreams_logStreamNamePrefix - The prefix to match.
If orderBy is LastEventTime, you cannot specify this parameter.
$sel:limit:DescribeLogStreams', describeLogStreams_limit - The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
$sel:logGroupName:DescribeLogStreams', describeLogStreams_logGroupName - The name of the log group.
data DescribeLogStreamsResponse Source #
See: newDescribeLogStreamsResponse smart constructor.
Instances
newDescribeLogStreamsResponse Source #
Create a value of DescribeLogStreamsResponse 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:nextToken:DescribeLogStreams', describeLogStreamsResponse_nextToken - Undocumented member.
$sel:logStreams:DescribeLogStreamsResponse', describeLogStreamsResponse_logStreams - The log streams.
$sel:httpStatus:DescribeLogStreamsResponse', describeLogStreamsResponse_httpStatus - The response's http status code.
Types
Distribution
newtype Distribution Source #
The method used to distribute log data to the destination, which can be either random or grouped by log stream.
Constructors
| Distribution' | |
Fields | |
Bundled Patterns
| pattern Distribution_ByLogStream :: Distribution | |
| pattern Distribution_Random :: Distribution |
Instances
ExportTaskStatusCode
newtype ExportTaskStatusCode Source #
Constructors
| ExportTaskStatusCode' | |
Fields | |
Bundled Patterns
| pattern ExportTaskStatusCode_CANCELLED :: ExportTaskStatusCode | |
| pattern ExportTaskStatusCode_COMPLETED :: ExportTaskStatusCode | |
| pattern ExportTaskStatusCode_FAILED :: ExportTaskStatusCode | |
| pattern ExportTaskStatusCode_PENDING :: ExportTaskStatusCode | |
| pattern ExportTaskStatusCode_PENDING_CANCEL :: ExportTaskStatusCode | |
| pattern ExportTaskStatusCode_RUNNING :: ExportTaskStatusCode |
Instances
OrderBy
Constructors
| OrderBy' | |
Fields
| |
Bundled Patterns
| pattern OrderBy_LastEventTime :: OrderBy | |
| pattern OrderBy_LogStreamName :: OrderBy |
Instances
QueryStatus
newtype QueryStatus Source #
Constructors
| QueryStatus' | |
Fields | |
Bundled Patterns
| pattern QueryStatus_Cancelled :: QueryStatus | |
| pattern QueryStatus_Complete :: QueryStatus | |
| pattern QueryStatus_Failed :: QueryStatus | |
| pattern QueryStatus_Running :: QueryStatus | |
| pattern QueryStatus_Scheduled :: QueryStatus | |
| pattern QueryStatus_Timeout :: QueryStatus | |
| pattern QueryStatus_Unknown :: QueryStatus |
Instances
StandardUnit
newtype StandardUnit Source #
Constructors
| StandardUnit' | |
Fields | |
Bundled Patterns
Instances
Destination
data Destination Source #
Represents a cross-account destination that receives subscription log events.
See: newDestination smart constructor.
Constructors
| Destination' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDestination :: Destination Source #
Create a value of Destination 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:targetArn:Destination', destination_targetArn - The Amazon Resource Name (ARN) of the physical target where the log
events are delivered (for example, a Kinesis stream).
$sel:creationTime:Destination', destination_creationTime - The creation time of the destination, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC.
$sel:arn:Destination', destination_arn - The ARN of this destination.
$sel:accessPolicy:Destination', destination_accessPolicy - An IAM policy document that governs which Amazon Web Services accounts
can create subscription filters against this destination.
$sel:destinationName:Destination', destination_destinationName - The name of the destination.
$sel:roleArn:Destination', destination_roleArn - A role for impersonation, used when delivering log events to the target.
ExportTask
data ExportTask Source #
Represents an export task.
See: newExportTask smart constructor.
Constructors
| ExportTask' (Maybe Text) (Maybe Text) (Maybe ExportTaskStatus) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe ExportTaskExecutionInfo) |
Instances
newExportTask :: ExportTask Source #
Create a value of ExportTask 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:destinationPrefix:ExportTask', exportTask_destinationPrefix - The prefix that was used as the start of Amazon S3 key for every object
exported.
$sel:destination:ExportTask', exportTask_destination - The name of the S3 bucket to which the log data was exported.
$sel:status:ExportTask', exportTask_status - The status of the export task.
$sel:taskName:ExportTask', exportTask_taskName - The name of the export task.
$sel:taskId:ExportTask', exportTask_taskId - The ID of the export task.
$sel:to:ExportTask', exportTask_to - The end time, expressed as the number of milliseconds after Jan 1, 1970
00:00:00 UTC. Events with a timestamp later than this time are not
exported.
$sel:from:ExportTask', exportTask_from - The start time, expressed as the number of milliseconds after Jan 1,
1970 00:00:00 UTC. Events with a timestamp before this time are not
exported.
$sel:logGroupName:ExportTask', exportTask_logGroupName - The name of the log group from which logs data was exported.
$sel:executionInfo:ExportTask', exportTask_executionInfo - Execution information about the export task.
ExportTaskExecutionInfo
data ExportTaskExecutionInfo Source #
Represents the status of an export task.
See: newExportTaskExecutionInfo smart constructor.
Constructors
| ExportTaskExecutionInfo' (Maybe Natural) (Maybe Natural) |
Instances
newExportTaskExecutionInfo :: ExportTaskExecutionInfo Source #
Create a value of ExportTaskExecutionInfo 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:creationTime:ExportTaskExecutionInfo', exportTaskExecutionInfo_creationTime - The creation time of the export task, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC.
$sel:completionTime:ExportTaskExecutionInfo', exportTaskExecutionInfo_completionTime - The completion time of the export task, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC.
ExportTaskStatus
data ExportTaskStatus Source #
Represents the status of an export task.
See: newExportTaskStatus smart constructor.
Constructors
| ExportTaskStatus' (Maybe ExportTaskStatusCode) (Maybe Text) |
Instances
newExportTaskStatus :: ExportTaskStatus Source #
Create a value of ExportTaskStatus 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:code:ExportTaskStatus', exportTaskStatus_code - The status code of the export task.
$sel:message:ExportTaskStatus', exportTaskStatus_message - The status message related to the status code.
FilteredLogEvent
data FilteredLogEvent Source #
Represents a matched event.
See: newFilteredLogEvent smart constructor.
Constructors
| FilteredLogEvent' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newFilteredLogEvent :: FilteredLogEvent Source #
Create a value of FilteredLogEvent 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:ingestionTime:FilteredLogEvent', filteredLogEvent_ingestionTime - The time the event was ingested, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
$sel:logStreamName:FilteredLogEvent', filteredLogEvent_logStreamName - The name of the log stream to which this event belongs.
$sel:message:FilteredLogEvent', filteredLogEvent_message - The data contained in the log event.
$sel:timestamp:FilteredLogEvent', filteredLogEvent_timestamp - The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
$sel:eventId:FilteredLogEvent', filteredLogEvent_eventId - The ID of the event.
InputLogEvent
data InputLogEvent Source #
Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.
See: newInputLogEvent smart constructor.
Constructors
| InputLogEvent' Natural Text |
Instances
Create a value of InputLogEvent 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:timestamp:InputLogEvent', inputLogEvent_timestamp - The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
$sel:message:InputLogEvent', inputLogEvent_message - The raw event message.
LogGroup
Represents a log group.
See: newLogGroup smart constructor.
Constructors
| LogGroup' (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Natural) |
Instances
newLogGroup :: LogGroup Source #
Create a value of LogGroup 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:creationTime:LogGroup', logGroup_creationTime - The creation time of the log group, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC.
$sel:metricFilterCount:LogGroup', logGroup_metricFilterCount - The number of metric filters.
$sel:arn:LogGroup', logGroup_arn - The Amazon Resource Name (ARN) of the log group.
$sel:logGroupName:LogGroup', logGroup_logGroupName - The name of the log group.
$sel:retentionInDays:LogGroup', logGroup_retentionInDays - Undocumented member.
$sel:kmsKeyId:LogGroup', logGroup_kmsKeyId - The Amazon Resource Name (ARN) of the CMK to use when encrypting log
data.
$sel:storedBytes:LogGroup', logGroup_storedBytes - The number of bytes stored.
LogGroupField
data LogGroupField Source #
The fields contained in log events found by a GetLogGroupFields
operation, along with the percentage of queried log events in which each
field appears.
See: newLogGroupField smart constructor.
Constructors
| LogGroupField' (Maybe Natural) (Maybe Text) |
Instances
newLogGroupField :: LogGroupField Source #
Create a value of LogGroupField 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:percent:LogGroupField', logGroupField_percent - The percentage of log events queried that contained the field.
$sel:name:LogGroupField', logGroupField_name - The name of a log field.
LogStream
Represents a log stream, which is a sequence of log events from a single emitter of logs.
See: newLogStream smart constructor.
Constructors
| LogStream' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) |
Instances
newLogStream :: LogStream Source #
Create a value of LogStream 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:creationTime:LogStream', logStream_creationTime - The creation time of the stream, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
$sel:uploadSequenceToken:LogStream', logStream_uploadSequenceToken - The sequence token.
$sel:arn:LogStream', logStream_arn - The Amazon Resource Name (ARN) of the log stream.
$sel:firstEventTimestamp:LogStream', logStream_firstEventTimestamp - The time of the first event, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
$sel:logStreamName:LogStream', logStream_logStreamName - The name of the log stream.
$sel:storedBytes:LogStream', logStream_storedBytes - The number of bytes stored.
Important: On June 17, 2019, this parameter was deprecated for log
streams, and is always reported as zero. This change applies only to log
streams. The storedBytes parameter for log groups is not affected.
$sel:lastIngestionTime:LogStream', logStream_lastIngestionTime - The ingestion time, expressed as the number of milliseconds after Jan 1,
1970 00:00:00 UTC.
$sel:lastEventTimestamp:LogStream', logStream_lastEventTimestamp - The time of the most recent log event in the log stream in CloudWatch
Logs. This number is expressed as the number of milliseconds after Jan
1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual
consistency basis. It typically updates in less than an hour from
ingestion, but in rare situations might take longer.
MetricFilter
data MetricFilter Source #
Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.
See: newMetricFilter smart constructor.
Constructors
| MetricFilter' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty MetricTransformation)) |
Instances
newMetricFilter :: MetricFilter Source #
Create a value of MetricFilter 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:creationTime:MetricFilter', metricFilter_creationTime - The creation time of the metric filter, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC.
$sel:filterName:MetricFilter', metricFilter_filterName - The name of the metric filter.
$sel:logGroupName:MetricFilter', metricFilter_logGroupName - The name of the log group.
$sel:filterPattern:MetricFilter', metricFilter_filterPattern - Undocumented member.
$sel:metricTransformations:MetricFilter', metricFilter_metricTransformations - The metric transformations.
MetricFilterMatchRecord
data MetricFilterMatchRecord Source #
Represents a matched event.
See: newMetricFilterMatchRecord smart constructor.
Instances
newMetricFilterMatchRecord :: MetricFilterMatchRecord Source #
Create a value of MetricFilterMatchRecord 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:extractedValues:MetricFilterMatchRecord', metricFilterMatchRecord_extractedValues - The values extracted from the event data by the filter.
$sel:eventNumber:MetricFilterMatchRecord', metricFilterMatchRecord_eventNumber - The event number.
$sel:eventMessage:MetricFilterMatchRecord', metricFilterMatchRecord_eventMessage - The raw event data.
MetricTransformation
data MetricTransformation Source #
Indicates how to transform ingested log events to metric data in a CloudWatch metric.
See: newMetricTransformation smart constructor.
Constructors
| MetricTransformation' (Maybe Double) (Maybe (HashMap Text Text)) (Maybe StandardUnit) Text Text Text |
Instances
newMetricTransformation Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> MetricTransformation |
Create a value of MetricTransformation 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:defaultValue:MetricTransformation', metricTransformation_defaultValue - (Optional) The value to emit when a filter pattern does not match a log
event. This value can be null.
$sel:dimensions:MetricTransformation', metricTransformation_dimensions - The fields to use as dimensions for the metric. One metric filter can
include as many as three dimensions.
Metrics extracted from log events are charged as custom metrics. To
prevent unexpected high charges, do not specify high-cardinality fields
such as IPAddress or requestID as dimensions. Each different value
found for a dimension is treated as a separate metric and accrues
charges as a separate custom metric.
To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
$sel:unit:MetricTransformation', metricTransformation_unit - The unit to assign to the metric. If you omit this, the unit is set as
None.
$sel:metricName:MetricTransformation', metricTransformation_metricName - The name of the CloudWatch metric.
$sel:metricNamespace:MetricTransformation', metricTransformation_metricNamespace - A custom namespace to contain your metric in CloudWatch. Use namespaces
to group together metrics that are similar. For more information, see
Namespaces.
$sel:metricValue:MetricTransformation', metricTransformation_metricValue - The value to publish to the CloudWatch metric when a filter pattern
matches a log event.
OutputLogEvent
data OutputLogEvent Source #
Represents a log event.
See: newOutputLogEvent smart constructor.
Instances
newOutputLogEvent :: OutputLogEvent Source #
Create a value of OutputLogEvent 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:ingestionTime:OutputLogEvent', outputLogEvent_ingestionTime - The time the event was ingested, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
$sel:message:OutputLogEvent', outputLogEvent_message - The data contained in the log event.
$sel:timestamp:OutputLogEvent', outputLogEvent_timestamp - The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC.
QueryDefinition
data QueryDefinition Source #
This structure contains details about a saved CloudWatch Logs Insights query definition.
See: newQueryDefinition smart constructor.
Instances
newQueryDefinition :: QueryDefinition Source #
Create a value of QueryDefinition 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:logGroupNames:QueryDefinition', queryDefinition_logGroupNames - If this query definition contains a list of log groups that it is
limited to, that list appears here.
$sel:queryDefinitionId:QueryDefinition', queryDefinition_queryDefinitionId - The unique ID of the query definition.
$sel:name:QueryDefinition', queryDefinition_name - The name of the query definition.
$sel:queryString:QueryDefinition', queryDefinition_queryString - The query string to use for this definition. For more information, see
CloudWatch Logs Insights Query Syntax.
$sel:lastModified:QueryDefinition', queryDefinition_lastModified - The date that the query definition was most recently modified.
QueryInfo
Information about one CloudWatch Logs Insights query that matches the
request in a DescribeQueries operation.
See: newQueryInfo smart constructor.
Instances
newQueryInfo :: QueryInfo Source #
Create a value of QueryInfo 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:status:QueryInfo', queryInfo_status - The status of this query. Possible values are Cancelled, Complete,
Failed, Running, Scheduled, and Unknown.
$sel:queryId:QueryInfo', queryInfo_queryId - The unique ID number of this query.
$sel:logGroupName:QueryInfo', queryInfo_logGroupName - The name of the log group scanned by this query.
$sel:queryString:QueryInfo', queryInfo_queryString - The query string used in this query.
$sel:createTime:QueryInfo', queryInfo_createTime - The date and time that this query was created.
QueryStatistics
data QueryStatistics Source #
Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.
See: newQueryStatistics smart constructor.
Instances
newQueryStatistics :: QueryStatistics Source #
Create a value of QueryStatistics 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:recordsScanned:QueryStatistics', queryStatistics_recordsScanned - The total number of log events scanned during the query.
$sel:bytesScanned:QueryStatistics', queryStatistics_bytesScanned - The total number of bytes in the log events scanned during the query.
$sel:recordsMatched:QueryStatistics', queryStatistics_recordsMatched - The number of log events that matched the query string.
RejectedLogEventsInfo
data RejectedLogEventsInfo Source #
Represents the rejected events.
See: newRejectedLogEventsInfo smart constructor.
Instances
newRejectedLogEventsInfo :: RejectedLogEventsInfo Source #
Create a value of RejectedLogEventsInfo 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:tooOldLogEventEndIndex:RejectedLogEventsInfo', rejectedLogEventsInfo_tooOldLogEventEndIndex - The log events that are too old.
$sel:tooNewLogEventStartIndex:RejectedLogEventsInfo', rejectedLogEventsInfo_tooNewLogEventStartIndex - The log events that are too new.
$sel:expiredLogEventEndIndex:RejectedLogEventsInfo', rejectedLogEventsInfo_expiredLogEventEndIndex - The expired log events.
ResourcePolicy
data ResourcePolicy Source #
A policy enabling one or more entities to put logs to a log group in this account.
See: newResourcePolicy smart constructor.
Instances
newResourcePolicy :: ResourcePolicy Source #
Create a value of ResourcePolicy 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:policyName:ResourcePolicy', resourcePolicy_policyName - The name of the resource policy.
$sel:policyDocument:ResourcePolicy', resourcePolicy_policyDocument - The details of the policy.
$sel:lastUpdatedTime:ResourcePolicy', resourcePolicy_lastUpdatedTime - Timestamp showing when this policy was last updated, expressed as the
number of milliseconds after Jan 1, 1970 00:00:00 UTC.
ResultField
data ResultField Source #
Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.
For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.
See: newResultField smart constructor.
Constructors
| ResultField' (Maybe Text) (Maybe Text) |
Instances
newResultField :: ResultField Source #
Create a value of ResultField 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:field:ResultField', resultField_field - The log event field.
$sel:value:ResultField', resultField_value - The value of this field.
SearchedLogStream
data SearchedLogStream Source #
Represents the search status of a log stream.
See: newSearchedLogStream smart constructor.
Constructors
| SearchedLogStream' (Maybe Text) (Maybe Bool) |
Instances
newSearchedLogStream :: SearchedLogStream Source #
Create a value of SearchedLogStream 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:logStreamName:SearchedLogStream', searchedLogStream_logStreamName - The name of the log stream.
$sel:searchedCompletely:SearchedLogStream', searchedLogStream_searchedCompletely - Indicates whether all the events in this log stream were searched.
SubscriptionFilter
data SubscriptionFilter Source #
Represents a subscription filter.
See: newSubscriptionFilter smart constructor.
Constructors
| SubscriptionFilter' (Maybe Natural) (Maybe Text) (Maybe Distribution) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newSubscriptionFilter :: SubscriptionFilter Source #
Create a value of SubscriptionFilter 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:creationTime:SubscriptionFilter', subscriptionFilter_creationTime - The creation time of the subscription filter, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC.
$sel:filterName:SubscriptionFilter', subscriptionFilter_filterName - The name of the subscription filter.
$sel:distribution:SubscriptionFilter', subscriptionFilter_distribution - Undocumented member.
$sel:destinationArn:SubscriptionFilter', subscriptionFilter_destinationArn - The Amazon Resource Name (ARN) of the destination.
$sel:logGroupName:SubscriptionFilter', subscriptionFilter_logGroupName - The name of the log group.
$sel:filterPattern:SubscriptionFilter', subscriptionFilter_filterPattern - Undocumented member.
$sel:roleArn:SubscriptionFilter', subscriptionFilter_roleArn -