Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- DataAlreadyAcceptedException
- InvalidOperationException
- InvalidParameterException
- InvalidSequenceTokenException
- LimitExceededException
- MalformedQueryException
- OperationAbortedException
- ResourceAlreadyExistsException
- ResourceNotFoundException
- ServiceUnavailableException
- TooManyTagsException
- UnrecognizedClientException
- Waiters
- Operations
- AssociateKmsKey
- CancelExportTask
- CreateExportTask
- CreateLogGroup
- CreateLogStream
- DeleteDataProtectionPolicy
- DeleteDestination
- DeleteLogGroup
- DeleteLogStream
- DeleteMetricFilter
- DeleteQueryDefinition
- DeleteResourcePolicy
- DeleteRetentionPolicy
- DeleteSubscriptionFilter
- DescribeDestinations (Paginated)
- DescribeExportTasks (Paginated)
- DescribeLogGroups (Paginated)
- DescribeLogStreams (Paginated)
- DescribeMetricFilters (Paginated)
- DescribeQueries (Paginated)
- DescribeQueryDefinitions
- DescribeResourcePolicies (Paginated)
- DescribeSubscriptionFilters (Paginated)
- DisassociateKmsKey
- FilterLogEvents (Paginated)
- GetDataProtectionPolicy
- GetLogEvents
- GetLogGroupFields
- GetLogRecord
- GetQueryResults
- ListTagsForResource
- PutDataProtectionPolicy
- PutDestination
- PutDestinationPolicy
- PutLogEvents
- PutMetricFilter
- PutQueryDefinition
- PutResourcePolicy
- PutRetentionPolicy
- PutSubscriptionFilter
- StartQuery
- StopQuery
- TagResource
- TestMetricFilter
- UntagResource
- Types
- DataProtectionStatus
- 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
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. Alternatively, you can use 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. Then, it can 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"). You can also 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 earlier than this setting are automatically deleted. The CloudWatch Logs agent helps 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
- _DataAlreadyAcceptedException :: AsError a => Fold a ServiceError
- _InvalidOperationException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidSequenceTokenException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MalformedQueryException :: AsError a => Fold a ServiceError
- _OperationAbortedException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _UnrecognizedClientException :: AsError a => Fold a ServiceError
- data AssociateKmsKey = AssociateKmsKey' Text Text
- newAssociateKmsKey :: Text -> Text -> AssociateKmsKey
- data AssociateKmsKeyResponse = AssociateKmsKeyResponse' {
- newAssociateKmsKeyResponse :: AssociateKmsKeyResponse
- data CancelExportTask = CancelExportTask' Text
- newCancelExportTask :: Text -> CancelExportTask
- data CancelExportTaskResponse = CancelExportTaskResponse' {
- newCancelExportTaskResponse :: CancelExportTaskResponse
- 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 CreateLogGroup = CreateLogGroup' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateLogGroup :: Text -> CreateLogGroup
- data CreateLogGroupResponse = CreateLogGroupResponse' {
- newCreateLogGroupResponse :: CreateLogGroupResponse
- data CreateLogStream = CreateLogStream' Text Text
- newCreateLogStream :: Text -> Text -> CreateLogStream
- data CreateLogStreamResponse = CreateLogStreamResponse' {
- newCreateLogStreamResponse :: CreateLogStreamResponse
- data DeleteDataProtectionPolicy = DeleteDataProtectionPolicy' Text
- newDeleteDataProtectionPolicy :: Text -> DeleteDataProtectionPolicy
- data DeleteDataProtectionPolicyResponse = DeleteDataProtectionPolicyResponse' {
- newDeleteDataProtectionPolicyResponse :: DeleteDataProtectionPolicyResponse
- data DeleteDestination = DeleteDestination' Text
- newDeleteDestination :: Text -> DeleteDestination
- data DeleteDestinationResponse = DeleteDestinationResponse' {
- newDeleteDestinationResponse :: DeleteDestinationResponse
- data DeleteLogGroup = DeleteLogGroup' Text
- newDeleteLogGroup :: Text -> DeleteLogGroup
- data DeleteLogGroupResponse = DeleteLogGroupResponse' {
- newDeleteLogGroupResponse :: DeleteLogGroupResponse
- data DeleteLogStream = DeleteLogStream' Text Text
- newDeleteLogStream :: Text -> Text -> DeleteLogStream
- data DeleteLogStreamResponse = DeleteLogStreamResponse' {
- newDeleteLogStreamResponse :: DeleteLogStreamResponse
- data DeleteMetricFilter = DeleteMetricFilter' Text Text
- newDeleteMetricFilter :: Text -> Text -> DeleteMetricFilter
- data DeleteMetricFilterResponse = DeleteMetricFilterResponse' {
- newDeleteMetricFilterResponse :: DeleteMetricFilterResponse
- data DeleteQueryDefinition = DeleteQueryDefinition' Text
- newDeleteQueryDefinition :: Text -> DeleteQueryDefinition
- data DeleteQueryDefinitionResponse = DeleteQueryDefinitionResponse' (Maybe Bool) Int
- newDeleteQueryDefinitionResponse :: Int -> DeleteQueryDefinitionResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' (Maybe Text)
- newDeleteResourcePolicy :: DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' {
- newDeleteResourcePolicyResponse :: DeleteResourcePolicyResponse
- data DeleteRetentionPolicy = DeleteRetentionPolicy' Text
- newDeleteRetentionPolicy :: Text -> DeleteRetentionPolicy
- data DeleteRetentionPolicyResponse = DeleteRetentionPolicyResponse' {
- newDeleteRetentionPolicyResponse :: DeleteRetentionPolicyResponse
- data DeleteSubscriptionFilter = DeleteSubscriptionFilter' Text Text
- newDeleteSubscriptionFilter :: Text -> Text -> DeleteSubscriptionFilter
- data DeleteSubscriptionFilterResponse = DeleteSubscriptionFilterResponse' {
- newDeleteSubscriptionFilterResponse :: DeleteSubscriptionFilterResponse
- data DescribeDestinations = DescribeDestinations' (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeDestinations :: DescribeDestinations
- data DescribeDestinationsResponse = DescribeDestinationsResponse' (Maybe [Destination]) (Maybe Text) Int
- newDescribeDestinationsResponse :: Int -> DescribeDestinationsResponse
- data DescribeExportTasks = DescribeExportTasks' (Maybe Natural) (Maybe Text) (Maybe ExportTaskStatusCode) (Maybe Text)
- newDescribeExportTasks :: DescribeExportTasks
- data DescribeExportTasksResponse = DescribeExportTasksResponse' (Maybe [ExportTask]) (Maybe Text) Int
- newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
- data DescribeLogGroups = DescribeLogGroups' (Maybe [Text]) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeLogGroups :: DescribeLogGroups
- data DescribeLogGroupsResponse = DescribeLogGroupsResponse' (Maybe [LogGroup]) (Maybe Text) Int
- newDescribeLogGroupsResponse :: Int -> DescribeLogGroupsResponse
- data DescribeLogStreams = DescribeLogStreams' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OrderBy) Text
- newDescribeLogStreams :: Text -> DescribeLogStreams
- data DescribeLogStreamsResponse = DescribeLogStreamsResponse' (Maybe [LogStream]) (Maybe Text) Int
- newDescribeLogStreamsResponse :: Int -> DescribeLogStreamsResponse
- data DescribeMetricFilters = DescribeMetricFilters' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeMetricFilters :: DescribeMetricFilters
- data DescribeMetricFiltersResponse = DescribeMetricFiltersResponse' (Maybe [MetricFilter]) (Maybe Text) Int
- newDescribeMetricFiltersResponse :: Int -> DescribeMetricFiltersResponse
- data DescribeQueries = DescribeQueries' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe QueryStatus)
- newDescribeQueries :: DescribeQueries
- data DescribeQueriesResponse = DescribeQueriesResponse' (Maybe Text) (Maybe [QueryInfo]) Int
- newDescribeQueriesResponse :: Int -> DescribeQueriesResponse
- data DescribeQueryDefinitions = DescribeQueryDefinitions' (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeQueryDefinitions :: DescribeQueryDefinitions
- data DescribeQueryDefinitionsResponse = DescribeQueryDefinitionsResponse' (Maybe Text) (Maybe [QueryDefinition]) Int
- newDescribeQueryDefinitionsResponse :: Int -> DescribeQueryDefinitionsResponse
- data DescribeResourcePolicies = DescribeResourcePolicies' (Maybe Natural) (Maybe Text)
- newDescribeResourcePolicies :: DescribeResourcePolicies
- data DescribeResourcePoliciesResponse = DescribeResourcePoliciesResponse' (Maybe Text) (Maybe [ResourcePolicy]) Int
- newDescribeResourcePoliciesResponse :: Int -> DescribeResourcePoliciesResponse
- data DescribeSubscriptionFilters = DescribeSubscriptionFilters' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newDescribeSubscriptionFilters :: Text -> DescribeSubscriptionFilters
- data DescribeSubscriptionFiltersResponse = DescribeSubscriptionFiltersResponse' (Maybe Text) (Maybe [SubscriptionFilter]) Int
- newDescribeSubscriptionFiltersResponse :: Int -> DescribeSubscriptionFiltersResponse
- data DisassociateKmsKey = DisassociateKmsKey' Text
- newDisassociateKmsKey :: Text -> DisassociateKmsKey
- data DisassociateKmsKeyResponse = DisassociateKmsKeyResponse' {
- newDisassociateKmsKeyResponse :: DisassociateKmsKeyResponse
- data FilterLogEvents = FilterLogEvents' (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) (Maybe Bool) Text
- newFilterLogEvents :: Text -> FilterLogEvents
- data FilterLogEventsResponse = FilterLogEventsResponse' (Maybe [FilteredLogEvent]) (Maybe Text) (Maybe [SearchedLogStream]) Int
- newFilterLogEventsResponse :: Int -> FilterLogEventsResponse
- data GetDataProtectionPolicy = GetDataProtectionPolicy' Text
- newGetDataProtectionPolicy :: Text -> GetDataProtectionPolicy
- data GetDataProtectionPolicyResponse = GetDataProtectionPolicyResponse' (Maybe Natural) (Maybe Text) (Maybe Text) Int
- newGetDataProtectionPolicyResponse :: Int -> GetDataProtectionPolicyResponse
- data GetLogEvents = GetLogEvents' (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Bool) Text Text
- newGetLogEvents :: Text -> Text -> GetLogEvents
- data GetLogEventsResponse = GetLogEventsResponse' (Maybe [OutputLogEvent]) (Maybe Text) (Maybe Text) Int
- newGetLogEventsResponse :: Int -> GetLogEventsResponse
- data GetLogGroupFields = GetLogGroupFields' (Maybe Text) (Maybe Natural) Text
- newGetLogGroupFields :: Text -> GetLogGroupFields
- data GetLogGroupFieldsResponse = GetLogGroupFieldsResponse' (Maybe [LogGroupField]) Int
- newGetLogGroupFieldsResponse :: Int -> GetLogGroupFieldsResponse
- data GetLogRecord = GetLogRecord' (Maybe Bool) Text
- newGetLogRecord :: Text -> GetLogRecord
- data GetLogRecordResponse = GetLogRecordResponse' (Maybe (HashMap Text Text)) Int
- newGetLogRecordResponse :: Int -> GetLogRecordResponse
- data GetQueryResults = GetQueryResults' Text
- newGetQueryResults :: Text -> GetQueryResults
- data GetQueryResultsResponse = GetQueryResultsResponse' (Maybe [[ResultField]]) (Maybe QueryStatistics) (Maybe QueryStatus) Int
- newGetQueryResultsResponse :: Int -> GetQueryResultsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutDataProtectionPolicy = PutDataProtectionPolicy' Text Text
- newPutDataProtectionPolicy :: Text -> Text -> PutDataProtectionPolicy
- data PutDataProtectionPolicyResponse = PutDataProtectionPolicyResponse' (Maybe Natural) (Maybe Text) (Maybe Text) Int
- newPutDataProtectionPolicyResponse :: Int -> PutDataProtectionPolicyResponse
- data PutDestination = PutDestination' (Maybe (HashMap Text Text)) Text Text Text
- newPutDestination :: Text -> Text -> Text -> PutDestination
- data PutDestinationResponse = PutDestinationResponse' (Maybe Destination) Int
- newPutDestinationResponse :: Int -> PutDestinationResponse
- data PutDestinationPolicy = PutDestinationPolicy' (Maybe Bool) Text Text
- newPutDestinationPolicy :: Text -> Text -> PutDestinationPolicy
- data PutDestinationPolicyResponse = PutDestinationPolicyResponse' {
- newPutDestinationPolicyResponse :: PutDestinationPolicyResponse
- data PutLogEvents = PutLogEvents' (Maybe Text) Text Text (NonEmpty InputLogEvent)
- newPutLogEvents :: Text -> Text -> NonEmpty InputLogEvent -> PutLogEvents
- data PutLogEventsResponse = PutLogEventsResponse' (Maybe Text) (Maybe RejectedLogEventsInfo) Int
- newPutLogEventsResponse :: Int -> PutLogEventsResponse
- data PutMetricFilter = PutMetricFilter' Text Text Text (NonEmpty MetricTransformation)
- newPutMetricFilter :: Text -> Text -> Text -> NonEmpty MetricTransformation -> PutMetricFilter
- data PutMetricFilterResponse = PutMetricFilterResponse' {
- newPutMetricFilterResponse :: PutMetricFilterResponse
- data PutQueryDefinition = PutQueryDefinition' (Maybe [Text]) (Maybe Text) Text Text
- newPutQueryDefinition :: Text -> Text -> PutQueryDefinition
- data PutQueryDefinitionResponse = PutQueryDefinitionResponse' (Maybe Text) Int
- newPutQueryDefinitionResponse :: Int -> PutQueryDefinitionResponse
- data PutResourcePolicy = PutResourcePolicy' (Maybe Text) (Maybe Text)
- newPutResourcePolicy :: PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' (Maybe ResourcePolicy) Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data PutRetentionPolicy = PutRetentionPolicy' Text Int
- newPutRetentionPolicy :: Text -> Int -> PutRetentionPolicy
- data PutRetentionPolicyResponse = PutRetentionPolicyResponse' {
- newPutRetentionPolicyResponse :: PutRetentionPolicyResponse
- 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 Natural) (Maybe [Text]) (Maybe Text) (Maybe [Text]) Natural Natural Text
- newStartQuery :: Natural -> Natural -> Text -> StartQuery
- data StartQueryResponse = StartQueryResponse' (Maybe Text) Int
- newStartQueryResponse :: Int -> StartQueryResponse
- data StopQuery = StopQuery' Text
- newStopQuery :: Text -> StopQuery
- data StopQueryResponse = StopQueryResponse' (Maybe Bool) Int
- newStopQueryResponse :: Int -> StopQueryResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data TestMetricFilter = TestMetricFilter' Text (NonEmpty Text)
- newTestMetricFilter :: Text -> NonEmpty Text -> TestMetricFilter
- data TestMetricFilterResponse = TestMetricFilterResponse' (Maybe [MetricFilterMatchRecord]) Int
- newTestMetricFilterResponse :: Int -> TestMetricFilterResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- newtype DataProtectionStatus where
- 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 Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text)
- newDestination :: Destination
- data ExportTask = ExportTask' (Maybe Text) (Maybe Text) (Maybe ExportTaskExecutionInfo) (Maybe Natural) (Maybe Text) (Maybe ExportTaskStatus) (Maybe Text) (Maybe Text) (Maybe Natural)
- newExportTask :: ExportTask
- data ExportTaskExecutionInfo = ExportTaskExecutionInfo' (Maybe Natural) (Maybe Natural)
- newExportTaskExecutionInfo :: ExportTaskExecutionInfo
- data ExportTaskStatus = ExportTaskStatus' (Maybe ExportTaskStatusCode) (Maybe Text)
- newExportTaskStatus :: ExportTaskStatus
- data FilteredLogEvent = FilteredLogEvent' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Natural)
- newFilteredLogEvent :: FilteredLogEvent
- data InputLogEvent = InputLogEvent' Natural Text
- newInputLogEvent :: Natural -> Text -> InputLogEvent
- data LogGroup = LogGroup' (Maybe Text) (Maybe Natural) (Maybe DataProtectionStatus) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Natural)
- newLogGroup :: LogGroup
- data LogGroupField = LogGroupField' (Maybe Text) (Maybe Natural)
- newLogGroupField :: LogGroupField
- data LogStream = LogStream' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Text)
- newLogStream :: LogStream
- data MetricFilter = MetricFilter' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty MetricTransformation))
- newMetricFilter :: MetricFilter
- data MetricFilterMatchRecord = MetricFilterMatchRecord' (Maybe Text) (Maybe Integer) (Maybe (HashMap Text 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 Natural) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text)
- newQueryDefinition :: QueryDefinition
- data QueryInfo = QueryInfo' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QueryStatus)
- 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 Natural) (Maybe Text) (Maybe Text)
- 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
.
DataAlreadyAcceptedException
_DataAlreadyAcceptedException :: AsError a => Fold a ServiceError Source #
The event was already logged.
PutLogEvents
actions are now always accepted and never return
DataAlreadyAcceptedException
regardless of whether a given batch of
log events has already been accepted.
InvalidOperationException
_InvalidOperationException :: AsError a => Fold a ServiceError Source #
The operation is not valid on the specified resource.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
A parameter is specified incorrectly.
InvalidSequenceTokenException
_InvalidSequenceTokenException :: AsError a => Fold a ServiceError Source #
The sequence token is not valid. You can get the correct sequence token
in the expectedSequenceToken
field in the
InvalidSequenceTokenException
message.
PutLogEvents
actions are now always accepted and never return
InvalidSequenceTokenException
regardless of receiving an invalid
sequence token.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
You have reached the maximum number of resources that can be created.
MalformedQueryException
_MalformedQueryException :: AsError a => Fold 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.
OperationAbortedException
_OperationAbortedException :: AsError a => Fold a ServiceError Source #
Multiple concurrent requests to update the same resource were in conflict.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The specified resource already exists.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource does not exist.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The service cannot complete the request.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
A resource can have no more than 50 tags.
UnrecognizedClientException
_UnrecognizedClientException :: AsError a => Fold a ServiceError Source #
The most likely cause is an Amazon Web Services access key ID or secret key that's not valid.
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.
AssociateKmsKey
data AssociateKmsKey Source #
See: newAssociateKmsKey
smart constructor.
Instances
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:
AssociateKmsKey
, associateKmsKey_logGroupName
- The name of the log group.
AssociateKmsKey
, associateKmsKey_kmsKeyId
- The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
data. This must be a symmetric KMS key. For more information, see
Amazon Resource Names
and
Using Symmetric and Asymmetric Keys.
data AssociateKmsKeyResponse Source #
See: newAssociateKmsKeyResponse
smart constructor.
Instances
Generic AssociateKmsKeyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.AssociateKmsKey type Rep AssociateKmsKeyResponse :: Type -> Type # | |
Read AssociateKmsKeyResponse Source # | |
Show AssociateKmsKeyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.AssociateKmsKey showsPrec :: Int -> AssociateKmsKeyResponse -> ShowS # show :: AssociateKmsKeyResponse -> String # showList :: [AssociateKmsKeyResponse] -> ShowS # | |
NFData AssociateKmsKeyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.AssociateKmsKey rnf :: AssociateKmsKeyResponse -> () # | |
Eq AssociateKmsKeyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.AssociateKmsKey | |
type Rep AssociateKmsKeyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.AssociateKmsKey |
newAssociateKmsKeyResponse :: AssociateKmsKeyResponse Source #
Create a value of AssociateKmsKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CancelExportTask
data CancelExportTask Source #
See: newCancelExportTask
smart constructor.
Instances
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:
CancelExportTask
, cancelExportTask_taskId
- The ID of the export task.
data CancelExportTaskResponse Source #
See: newCancelExportTaskResponse
smart constructor.
Instances
Generic CancelExportTaskResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CancelExportTask type Rep CancelExportTaskResponse :: Type -> Type # | |
Read CancelExportTaskResponse Source # | |
Show CancelExportTaskResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CancelExportTask showsPrec :: Int -> CancelExportTaskResponse -> ShowS # show :: CancelExportTaskResponse -> String # showList :: [CancelExportTaskResponse] -> ShowS # | |
NFData CancelExportTaskResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CancelExportTask rnf :: CancelExportTaskResponse -> () # | |
Eq CancelExportTaskResponse Source # | |
type Rep CancelExportTaskResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CancelExportTask |
newCancelExportTaskResponse :: CancelExportTaskResponse Source #
Create a value of CancelExportTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateExportTask
data CreateExportTask Source #
See: newCreateExportTask
smart constructor.
Instances
:: 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:
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: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.
CreateExportTask
, createExportTask_taskName
- The name of the export task.
CreateExportTask
, createExportTask_logGroupName
- The name of the log group.
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.
CreateExportTask
, createExportTask_to
- The end 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
later than this time are not exported.
You must specify a time that is not earlier than when this log group was created.
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.
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:
CreateExportTaskResponse
, createExportTaskResponse_taskId
- The ID of the export task.
$sel:httpStatus:CreateExportTaskResponse'
, createExportTaskResponse_httpStatus
- The response's http status code.
CreateLogGroup
data CreateLogGroup Source #
See: newCreateLogGroup
smart constructor.
Instances
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:
CreateLogGroup
, createLogGroup_kmsKeyId
- The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
data. For more information, see
Amazon Resource Names.
$sel:tags:CreateLogGroup'
, createLogGroup_tags
- The key-value pairs to use for the tags.
You can grant users access to certain log groups while preventing them
from accessing other log groups. To do so, tag your groups and use IAM
policies that refer to those tags. To assign tags when you create a log
group, you must have either the logs:TagResource
or logs:TagLogGroup
permission. For more information about tagging, see
Tagging Amazon Web Services resources.
For more information about using tags to control access, see
Controlling access to Amazon Web Services resources using tags.
CreateLogGroup
, createLogGroup_logGroupName
- The name of the log group.
data CreateLogGroupResponse Source #
See: newCreateLogGroupResponse
smart constructor.
Instances
Generic CreateLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogGroup type Rep CreateLogGroupResponse :: Type -> Type # | |
Read CreateLogGroupResponse Source # | |
Show CreateLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogGroup showsPrec :: Int -> CreateLogGroupResponse -> ShowS # show :: CreateLogGroupResponse -> String # showList :: [CreateLogGroupResponse] -> ShowS # | |
NFData CreateLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogGroup rnf :: CreateLogGroupResponse -> () # | |
Eq CreateLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogGroup | |
type Rep CreateLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogGroup |
newCreateLogGroupResponse :: CreateLogGroupResponse Source #
Create a value of CreateLogGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateLogStream
data CreateLogStream Source #
See: newCreateLogStream
smart constructor.
Instances
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:
CreateLogStream
, createLogStream_logGroupName
- The name of the log group.
CreateLogStream
, createLogStream_logStreamName
- The name of the log stream.
data CreateLogStreamResponse Source #
See: newCreateLogStreamResponse
smart constructor.
Instances
Generic CreateLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogStream type Rep CreateLogStreamResponse :: Type -> Type # | |
Read CreateLogStreamResponse Source # | |
Show CreateLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogStream showsPrec :: Int -> CreateLogStreamResponse -> ShowS # show :: CreateLogStreamResponse -> String # showList :: [CreateLogStreamResponse] -> ShowS # | |
NFData CreateLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogStream rnf :: CreateLogStreamResponse -> () # | |
Eq CreateLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogStream | |
type Rep CreateLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.CreateLogStream |
newCreateLogStreamResponse :: CreateLogStreamResponse Source #
Create a value of CreateLogStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDataProtectionPolicy
data DeleteDataProtectionPolicy Source #
See: newDeleteDataProtectionPolicy
smart constructor.
Instances
newDeleteDataProtectionPolicy Source #
Create a value of DeleteDataProtectionPolicy
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:logGroupIdentifier:DeleteDataProtectionPolicy'
, deleteDataProtectionPolicy_logGroupIdentifier
- The name or ARN of the log group that you want to delete the data
protection policy for.
data DeleteDataProtectionPolicyResponse Source #
See: newDeleteDataProtectionPolicyResponse
smart constructor.
Instances
Generic DeleteDataProtectionPolicyResponse Source # | |
Read DeleteDataProtectionPolicyResponse Source # | |
Show DeleteDataProtectionPolicyResponse Source # | |
NFData DeleteDataProtectionPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteDataProtectionPolicy rnf :: DeleteDataProtectionPolicyResponse -> () # | |
Eq DeleteDataProtectionPolicyResponse Source # | |
type Rep DeleteDataProtectionPolicyResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteDataProtectionPolicy type Rep DeleteDataProtectionPolicyResponse = D1 ('MetaData "DeleteDataProtectionPolicyResponse" "Amazonka.CloudWatchLogs.DeleteDataProtectionPolicy" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "DeleteDataProtectionPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteDataProtectionPolicyResponse :: DeleteDataProtectionPolicyResponse Source #
Create a value of DeleteDataProtectionPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDestination
data DeleteDestination Source #
See: newDeleteDestination
smart constructor.
Instances
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:
DeleteDestination
, deleteDestination_destinationName
- The name of the destination.
data DeleteDestinationResponse Source #
See: newDeleteDestinationResponse
smart constructor.
Instances
newDeleteDestinationResponse :: DeleteDestinationResponse Source #
Create a value of DeleteDestinationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteLogGroup
data DeleteLogGroup Source #
See: newDeleteLogGroup
smart constructor.
Instances
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:
DeleteLogGroup
, deleteLogGroup_logGroupName
- The name of the log group.
data DeleteLogGroupResponse Source #
See: newDeleteLogGroupResponse
smart constructor.
Instances
Generic DeleteLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogGroup type Rep DeleteLogGroupResponse :: Type -> Type # | |
Read DeleteLogGroupResponse Source # | |
Show DeleteLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogGroup showsPrec :: Int -> DeleteLogGroupResponse -> ShowS # show :: DeleteLogGroupResponse -> String # showList :: [DeleteLogGroupResponse] -> ShowS # | |
NFData DeleteLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogGroup rnf :: DeleteLogGroupResponse -> () # | |
Eq DeleteLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogGroup | |
type Rep DeleteLogGroupResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogGroup |
newDeleteLogGroupResponse :: DeleteLogGroupResponse Source #
Create a value of DeleteLogGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteLogStream
data DeleteLogStream Source #
See: newDeleteLogStream
smart constructor.
Instances
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:
DeleteLogStream
, deleteLogStream_logGroupName
- The name of the log group.
DeleteLogStream
, deleteLogStream_logStreamName
- The name of the log stream.
data DeleteLogStreamResponse Source #
See: newDeleteLogStreamResponse
smart constructor.
Instances
Generic DeleteLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogStream type Rep DeleteLogStreamResponse :: Type -> Type # | |
Read DeleteLogStreamResponse Source # | |
Show DeleteLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogStream showsPrec :: Int -> DeleteLogStreamResponse -> ShowS # show :: DeleteLogStreamResponse -> String # showList :: [DeleteLogStreamResponse] -> ShowS # | |
NFData DeleteLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogStream rnf :: DeleteLogStreamResponse -> () # | |
Eq DeleteLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogStream | |
type Rep DeleteLogStreamResponse Source # | |
Defined in Amazonka.CloudWatchLogs.DeleteLogStream |
newDeleteLogStreamResponse :: DeleteLogStreamResponse Source #
Create a value of DeleteLogStreamResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMetricFilter
data DeleteMetricFilter Source #
See: newDeleteMetricFilter
smart constructor.
Instances
newDeleteMetricFilter Source #
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:
DeleteMetricFilter
, deleteMetricFilter_logGroupName
- The name of the log group.
DeleteMetricFilter
, deleteMetricFilter_filterName
- The name of the metric filter.
data DeleteMetricFilterResponse Source #
See: newDeleteMetricFilterResponse
smart constructor.
Instances
newDeleteMetricFilterResponse :: DeleteMetricFilterResponse Source #
Create a value of DeleteMetricFilterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteQueryDefinition
data DeleteQueryDefinition Source #
See: newDeleteQueryDefinition
smart constructor.
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:
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.
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.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy
smart constructor.
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:
DeleteResourcePolicy
, deleteResourcePolicy_policyName
- The name of the policy to be revoked. This parameter is required.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse
smart constructor.
Instances
newDeleteResourcePolicyResponse :: DeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRetentionPolicy
data DeleteRetentionPolicy Source #
See: newDeleteRetentionPolicy
smart constructor.
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:
DeleteRetentionPolicy
, deleteRetentionPolicy_logGroupName
- The name of the log group.
data DeleteRetentionPolicyResponse Source #
See: newDeleteRetentionPolicyResponse
smart constructor.
Instances
newDeleteRetentionPolicyResponse :: DeleteRetentionPolicyResponse Source #
Create a value of DeleteRetentionPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteSubscriptionFilter
data DeleteSubscriptionFilter Source #
See: newDeleteSubscriptionFilter
smart constructor.
Instances
newDeleteSubscriptionFilter Source #
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:
DeleteSubscriptionFilter
, deleteSubscriptionFilter_logGroupName
- The name of the log group.
DeleteSubscriptionFilter
, deleteSubscriptionFilter_filterName
- The name of the subscription filter.
data DeleteSubscriptionFilterResponse Source #
See: newDeleteSubscriptionFilterResponse
smart constructor.
Instances
newDeleteSubscriptionFilterResponse :: DeleteSubscriptionFilterResponse Source #
Create a value of DeleteSubscriptionFilterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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:destinationNamePrefix:DescribeDestinations'
, describeDestinations_destinationNamePrefix
- The prefix to match. If you don't specify a value, no prefix filter is
applied.
$sel:limit:DescribeDestinations'
, describeDestinations_limit
- The maximum number of items returned. If you don't specify a value, the
default maximum value of 50 items is used.
DescribeDestinations
, describeDestinations_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
data DescribeDestinationsResponse Source #
See: newDescribeDestinationsResponse
smart constructor.
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:destinations:DescribeDestinationsResponse'
, describeDestinationsResponse_destinations
- The destinations.
DescribeDestinations
, describeDestinationsResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeDestinationsResponse'
, describeDestinationsResponse_httpStatus
- The response's http status code.
DescribeExportTasks (Paginated)
data DescribeExportTasks Source #
See: newDescribeExportTasks
smart constructor.
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:limit:DescribeExportTasks'
, describeExportTasks_limit
- The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
DescribeExportTasks
, describeExportTasks_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
$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.
DescribeExportTasks
, describeExportTasks_taskId
- The ID of the export task. Specifying a task ID filters the results to
one or zero export tasks.
data DescribeExportTasksResponse Source #
See: newDescribeExportTasksResponse
smart constructor.
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:exportTasks:DescribeExportTasksResponse'
, describeExportTasksResponse_exportTasks
- The export tasks.
DescribeExportTasks
, describeExportTasksResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeExportTasksResponse'
, describeExportTasksResponse_httpStatus
- The response's http status code.
DescribeLogGroups (Paginated)
data DescribeLogGroups Source #
See: newDescribeLogGroups
smart constructor.
DescribeLogGroups' (Maybe [Text]) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) |
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:accountIdentifiers:DescribeLogGroups'
, describeLogGroups_accountIdentifiers
- When includeLinkedAccounts
is set to True
, use this parameter to
specify the list of accounts to search. You can specify as many as 20
account IDs in the array.
$sel:includeLinkedAccounts:DescribeLogGroups'
, describeLogGroups_includeLinkedAccounts
- If you are using a monitoring account, set this to True
to have the
operation return log groups in the accounts listed in
accountIdentifiers
.
If this parameter is set to true
and accountIdentifiers
contains a
null value, the operation returns all log groups in the monitoring
account and all log groups in all source accounts that are linked to the
monitoring account.
If you specify includeLinkedAccounts
in your request, then
metricFilterCount
, retentionInDays
, and storedBytes
are not
included in the response.
$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.
$sel:logGroupNamePattern:DescribeLogGroups'
, describeLogGroups_logGroupNamePattern
- If you specify a string for this parameter, the operation returns only
log groups that have names that match the string based on a
case-sensitive substring search. For example, if you specify Foo
, log
groups named FooBar
, aws/Foo
, and GroupFoo
would match, but
foo
, F/o/o
and Froo
would not match.
logGroupNamePattern
and logGroupNamePrefix
are mutually exclusive.
Only one of these parameters can be passed.
$sel:logGroupNamePrefix:DescribeLogGroups'
, describeLogGroups_logGroupNamePrefix
- The prefix to match.
logGroupNamePrefix
and logGroupNamePattern
are mutually exclusive.
Only one of these parameters can be passed.
DescribeLogGroups
, describeLogGroups_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
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 is not included for a log group, then
that log group's events do not expire.
DescribeLogGroups
, describeLogGroupsResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeLogGroupsResponse'
, describeLogGroupsResponse_httpStatus
- The response's http status code.
DescribeLogStreams (Paginated)
data DescribeLogStreams Source #
See: newDescribeLogStreams
smart constructor.
DescribeLogStreams' (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe OrderBy) Text |
Instances
newDescribeLogStreams Source #
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: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: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:logGroupIdentifier:DescribeLogStreams'
, describeLogStreams_logGroupIdentifier
- Specify either the name or ARN of the log group to view. If the log
group is in a source account and you are using a monitoring account, you
must use the log group ARN.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
$sel:logStreamNamePrefix:DescribeLogStreams'
, describeLogStreams_logStreamNamePrefix
- The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
DescribeLogStreams
, describeLogStreams_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
$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.
DescribeLogStreams
, describeLogStreams_logGroupName
- The name of the log group.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
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:logStreams:DescribeLogStreamsResponse'
, describeLogStreamsResponse_logStreams
- The log streams.
DescribeLogStreams
, describeLogStreamsResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeLogStreamsResponse'
, describeLogStreamsResponse_httpStatus
- The response's http status code.
DescribeMetricFilters (Paginated)
data DescribeMetricFilters Source #
See: newDescribeMetricFilters
smart constructor.
DescribeMetricFilters' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
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 that you set here
only if you also include the logGroupName
parameter in your request.
$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.
DescribeMetricFilters
, describeMetricFilters_logGroupName
- The name of the log group.
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.
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.
DescribeMetricFilters
, describeMetricFilters_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
data DescribeMetricFiltersResponse Source #
See: newDescribeMetricFiltersResponse
smart constructor.
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:metricFilters:DescribeMetricFiltersResponse'
, describeMetricFiltersResponse_metricFilters
- The metric filters.
DescribeMetricFilters
, describeMetricFiltersResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeMetricFiltersResponse'
, describeMetricFiltersResponse_httpStatus
- The response's http status code.
DescribeQueries (Paginated)
data DescribeQueries Source #
See: newDescribeQueries
smart constructor.
DescribeQueries' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe QueryStatus) |
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:
DescribeQueries
, describeQueries_logGroupName
- Limits the returned queries to only those for the specified log group.
$sel:maxResults:DescribeQueries'
, describeQueries_maxResults
- Limits the number of returned queries to the specified number.
DescribeQueries
, describeQueries_nextToken
- Undocumented member.
DescribeQueries
, describeQueries_status
- Limits the returned queries to only those that have the specified
status. Valid values are Cancelled
, Complete
, Failed
, Running
,
and Scheduled
.
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:
DescribeQueries
, describeQueriesResponse_nextToken
- Undocumented member.
$sel:queries:DescribeQueriesResponse'
, describeQueriesResponse_queries
- The list of queries that match the request.
$sel:httpStatus:DescribeQueriesResponse'
, describeQueriesResponse_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:maxResults:DescribeQueryDefinitions'
, describeQueryDefinitions_maxResults
- Limits the number of returned query definitions to the specified number.
DescribeQueryDefinitions
, describeQueryDefinitions_nextToken
- Undocumented member.
$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.
data DescribeQueryDefinitionsResponse Source #
See: newDescribeQueryDefinitionsResponse
smart constructor.
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:
DescribeQueryDefinitions
, describeQueryDefinitionsResponse_nextToken
- Undocumented member.
$sel:queryDefinitions:DescribeQueryDefinitionsResponse'
, describeQueryDefinitionsResponse_queryDefinitions
- The list of query definitions that match your request.
$sel:httpStatus:DescribeQueryDefinitionsResponse'
, describeQueryDefinitionsResponse_httpStatus
- The response's http status code.
DescribeResourcePolicies (Paginated)
data DescribeResourcePolicies Source #
See: newDescribeResourcePolicies
smart constructor.
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:limit:DescribeResourcePolicies'
, describeResourcePolicies_limit
- The maximum number of resource policies to be displayed with one call of
this API.
DescribeResourcePolicies
, describeResourcePolicies_nextToken
- Undocumented member.
data DescribeResourcePoliciesResponse Source #
See: newDescribeResourcePoliciesResponse
smart constructor.
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:
DescribeResourcePolicies
, describeResourcePoliciesResponse_nextToken
- Undocumented member.
$sel:resourcePolicies:DescribeResourcePoliciesResponse'
, describeResourcePoliciesResponse_resourcePolicies
- The resource policies that exist in this account.
$sel:httpStatus:DescribeResourcePoliciesResponse'
, describeResourcePoliciesResponse_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:limit:DescribeSubscriptionFilters'
, describeSubscriptionFilters_limit
- The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
DescribeSubscriptionFilters
, describeSubscriptionFilters_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
DescribeSubscriptionFilters
, describeSubscriptionFilters_logGroupName
- The name of the log group.
data DescribeSubscriptionFiltersResponse Source #
See: newDescribeSubscriptionFiltersResponse
smart constructor.
Instances
newDescribeSubscriptionFiltersResponse Source #
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:
DescribeSubscriptionFilters
, describeSubscriptionFiltersResponse_nextToken
- Undocumented member.
$sel:subscriptionFilters:DescribeSubscriptionFiltersResponse'
, describeSubscriptionFiltersResponse_subscriptionFilters
- The subscription filters.
$sel:httpStatus:DescribeSubscriptionFiltersResponse'
, describeSubscriptionFiltersResponse_httpStatus
- The response's http status code.
DisassociateKmsKey
data DisassociateKmsKey Source #
See: newDisassociateKmsKey
smart constructor.
Instances
newDisassociateKmsKey Source #
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:
DisassociateKmsKey
, disassociateKmsKey_logGroupName
- The name of the log group.
data DisassociateKmsKeyResponse Source #
See: newDisassociateKmsKeyResponse
smart constructor.
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.
FilterLogEvents' (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) (Maybe Bool) Text |
Instances
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: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.
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 attempts 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.
Important As of 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:limit:FilterLogEvents'
, filterLogEvents_limit
- The maximum number of events to return. The default is 10,000 events.
$sel:logGroupIdentifier:FilterLogEvents'
, filterLogEvents_logGroupIdentifier
- Specify either the name or ARN of the log group to view log events from.
If the log group is in a source account and you are using a monitoring
account, you must use the log group ARN.
If you specify values for both logGroupName
and logGroupIdentifier
,
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: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.
FilterLogEvents
, filterLogEvents_nextToken
- The token for the next set of events to return. (You received this token
from a previous call.)
$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:unmask:FilterLogEvents'
, filterLogEvents_unmask
- Specify true
to display the log event fields with all sensitive data
unmasked and visible. The default is false
.
To use this operation with this parameter, you must be signed into an
account with the logs:Unmask
permission.
FilterLogEvents
, filterLogEvents_logGroupName
- The name of the log group to search.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
data FilterLogEventsResponse Source #
See: newFilterLogEventsResponse
smart constructor.
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:events:FilterLogEventsResponse'
, filterLogEventsResponse_events
- The matched events.
FilterLogEvents
, filterLogEventsResponse_nextToken
- The token to use when requesting the next set of items. The token
expires after 24 hours.
$sel:searchedLogStreams:FilterLogEventsResponse'
, filterLogEventsResponse_searchedLogStreams
- Important As of May 15, 2020, this parameter is no longer supported.
This parameter returns an empty list.
Indicates which log streams have been searched and whether each has been searched completely.
$sel:httpStatus:FilterLogEventsResponse'
, filterLogEventsResponse_httpStatus
- The response's http status code.
GetDataProtectionPolicy
data GetDataProtectionPolicy Source #
See: newGetDataProtectionPolicy
smart constructor.
Instances
newGetDataProtectionPolicy Source #
Create a value of GetDataProtectionPolicy
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:
GetDataProtectionPolicy
, getDataProtectionPolicy_logGroupIdentifier
- The name or ARN of the log group that contains the data protection
policy that you want to see.
data GetDataProtectionPolicyResponse Source #
See: newGetDataProtectionPolicyResponse
smart constructor.
Instances
newGetDataProtectionPolicyResponse Source #
Create a value of GetDataProtectionPolicyResponse
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:
GetDataProtectionPolicyResponse
, getDataProtectionPolicyResponse_lastUpdatedTime
- The date and time that this policy was most recently updated.
GetDataProtectionPolicy
, getDataProtectionPolicyResponse_logGroupIdentifier
- The log group name or ARN that you specified in your request.
GetDataProtectionPolicyResponse
, getDataProtectionPolicyResponse_policyDocument
- The data protection policy document for this log group.
$sel:httpStatus:GetDataProtectionPolicyResponse'
, getDataProtectionPolicyResponse_httpStatus
- The response's http status code.
GetLogEvents
data GetLogEvents Source #
See: newGetLogEvents
smart constructor.
GetLogEvents' (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Natural) (Maybe Bool) Text Text |
Instances
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: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
limit, the default is as many log events as can fit in a response size
of 1 MB (up to 10,000 log events).
$sel:logGroupIdentifier:GetLogEvents'
, getLogEvents_logGroupIdentifier
- Specify either the name or ARN of the log group to view events from. If
the log group is in a source account and you are using a monitoring
account, you must use the log group ARN.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
$sel:nextToken:GetLogEvents'
, getLogEvents_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
$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: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:unmask:GetLogEvents'
, getLogEvents_unmask
- Specify true
to display the log event fields with all sensitive data
unmasked and visible. The default is false
.
To use this operation with this parameter, you must be signed into an
account with the logs:Unmask
permission.
GetLogEvents
, getLogEvents_logGroupName
- The name of the log group.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
GetLogEvents
, getLogEvents_logStreamName
- The name of the log stream.
data GetLogEventsResponse Source #
See: newGetLogEventsResponse
smart constructor.
Instances
newGetLogEventsResponse Source #
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:events:GetLogEventsResponse'
, getLogEventsResponse_events
- The events.
$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 not 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:httpStatus:GetLogEventsResponse'
, getLogEventsResponse_httpStatus
- The response's http status code.
GetLogGroupFields
data GetLogGroupFields Source #
See: newGetLogGroupFields
smart constructor.
Instances
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:logGroupIdentifier:GetLogGroupFields'
, getLogGroupFields_logGroupIdentifier
- Specify either the name or ARN of the log group to view. If the log
group is in a source account and you are using a monitoring account, you
must specify the ARN.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
$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, which is the number of
seconds since January 1, 1970, 00:00:00 UTC
.
GetLogGroupFields
, getLogGroupFields_logGroupName
- The name of the log group to search.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
data GetLogGroupFieldsResponse Source #
See: newGetLogGroupFieldsResponse
smart constructor.
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.
Instances
Create a value of GetLogRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unmask:GetLogRecord'
, getLogRecord_unmask
- Specify true
to display the log event fields with all sensitive data
unmasked and visible. The default is false
.
To use this operation with this parameter, you must be signed into an
account with the logs:Unmask
permission.
$sel:logRecordPointer:GetLogRecord'
, getLogRecord_logRecordPointer
- The pointer corresponding to the log event record you want to retrieve.
You get this from the response of a GetQueryResults
operation. In that
response, the value of the @ptr
field for a log event is the value to
use as logRecordPointer
to retrieve that complete log event record.
data GetLogRecordResponse Source #
See: newGetLogRecordResponse
smart constructor.
Instances
newGetLogRecordResponse Source #
Create a value of GetLogRecordResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logRecord:GetLogRecordResponse'
, getLogRecordResponse_logRecord
- The requested log event, as a JSON string.
$sel:httpStatus:GetLogRecordResponse'
, getLogRecordResponse_httpStatus
- The response's http status code.
GetQueryResults
data GetQueryResults Source #
See: newGetQueryResults
smart constructor.
Instances
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:
GetQueryResults
, getQueryResults_queryId
- The ID number of the query.
data GetQueryResultsResponse Source #
See: newGetQueryResultsResponse
smart constructor.
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: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.
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 runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.
$sel:httpStatus:GetQueryResultsResponse'
, getQueryResultsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The ARN of the resource that you want to view tags for.
The ARN format of a log group is
arn:aws:logs:
Region
:
account-id
:log-group:
log-group-name
The ARN format of a destination is
arn:aws:logs:
Region
:
account-id
:destination:
destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The list of tags associated with the requested resource.>
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutDataProtectionPolicy
data PutDataProtectionPolicy Source #
See: newPutDataProtectionPolicy
smart constructor.
Instances
newPutDataProtectionPolicy Source #
Create a value of PutDataProtectionPolicy
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:
PutDataProtectionPolicy
, putDataProtectionPolicy_logGroupIdentifier
- Specify either the log group name or log group ARN.
PutDataProtectionPolicy
, putDataProtectionPolicy_policyDocument
- Specify the data protection policy, in JSON.
This policy must include two JSON blocks:
The first block must include both a
DataIdentifer
array and anOperation
property with anAudit
action. TheDataIdentifer
array lists the types of sensitive data that you want to mask. For more information about the available options, see Types of data that you can mask.The
Operation
property with anAudit
action is required to find the sensitive data terms. ThisAudit
action must contain aFindingsDestination
object. You can optionally use thatFindingsDestination
object to list one or more destinations to send audit findings to. If you specify destinations such as log groups, Kinesis Data Firehose streams, and S3 buckets, they must already exist.The second block must include both a
DataIdentifer
array and anOperation
property with anDeidentify
action. TheDataIdentifer
array must exactly match theDataIdentifer
array in the first block of the policy.The
Operation
property with theDeidentify
action is what actually masks the data, and it must contain the"MaskConfig": {}
object. The"MaskConfig": {}
object must be empty.
For an example data protection policy, see the Examples section on this page.
The contents of two DataIdentifer
arrays must match exactly.
data PutDataProtectionPolicyResponse Source #
See: newPutDataProtectionPolicyResponse
smart constructor.
Instances
newPutDataProtectionPolicyResponse Source #
Create a value of PutDataProtectionPolicyResponse
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:
PutDataProtectionPolicyResponse
, putDataProtectionPolicyResponse_lastUpdatedTime
- The date and time that this policy was most recently updated.
PutDataProtectionPolicy
, putDataProtectionPolicyResponse_logGroupIdentifier
- The log group name or ARN that you specified in your request.
PutDataProtectionPolicy
, putDataProtectionPolicyResponse_policyDocument
- The data protection policy used for this log group.
$sel:httpStatus:PutDataProtectionPolicyResponse'
, putDataProtectionPolicyResponse_httpStatus
- The response's http status code.
PutDestination
data PutDestination Source #
See: newPutDestination
smart constructor.
Instances
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:tags:PutDestination'
, putDestination_tags
- An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
PutDestination
, putDestination_destinationName
- A name for the destination.
PutDestination
, putDestination_targetArn
- The ARN of an Amazon Kinesis stream to which to deliver matching log
events.
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.
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:
PutDestinationResponse
, putDestinationResponse_destination
- The destination.
$sel:httpStatus:PutDestinationResponse'
, putDestinationResponse_httpStatus
- The response's http status code.
PutDestinationPolicy
data PutDestinationPolicy Source #
See: newPutDestinationPolicy
smart constructor.
Instances
newPutDestinationPolicy Source #
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:forceUpdate:PutDestinationPolicy'
, putDestinationPolicy_forceUpdate
- Specify true if you are updating an existing destination policy to grant
permission to an organization ID instead of granting permission to
individual AWS accounts. Before you update a destination policy this
way, you must first update the subscription filters in the accounts that
send logs to this destination. If you do not, the subscription filters
might stop working. By specifying true
for forceUpdate
, you are
affirming that you have already updated the subscription filters. For
more information, see
Updating an existing cross-account subscription
If you omit this parameter, the default of false
is used.
PutDestinationPolicy
, putDestinationPolicy_destinationName
- A name for an existing destination.
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.
Instances
newPutDestinationPolicyResponse :: PutDestinationPolicyResponse Source #
Create a value of PutDestinationPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutLogEvents
data PutLogEvents Source #
See: newPutLogEvents
smart constructor.
Instances
:: 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.
The sequenceToken
parameter is now ignored in PutLogEvents
actions.
PutLogEvents
actions are now accepted and never return
InvalidSequenceTokenException
or DataAlreadyAcceptedException
even
if the sequence token is not valid.
PutLogEvents
, putLogEvents_logGroupName
- The name of the log group.
PutLogEvents
, putLogEvents_logStreamName
- The name of the log stream.
$sel:logEvents:PutLogEvents'
, putLogEvents_logEvents
- The log events.
data PutLogEventsResponse Source #
See: newPutLogEventsResponse
smart constructor.
Instances
newPutLogEventsResponse Source #
Create a value of PutLogEventsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextSequenceToken:PutLogEventsResponse'
, putLogEventsResponse_nextSequenceToken
- The next sequence token.
This field has been deprecated.
The sequence token is now ignored in PutLogEvents
actions.
PutLogEvents
actions are always accepted even if the sequence token is
not valid. You can use parallel PutLogEvents
actions on the same log
stream and you do not need to wait for the response of a previous
PutLogEvents
action to obtain the nextSequenceToken
value.
$sel:rejectedLogEventsInfo:PutLogEventsResponse'
, putLogEventsResponse_rejectedLogEventsInfo
- The rejected events.
$sel:httpStatus:PutLogEventsResponse'
, putLogEventsResponse_httpStatus
- The response's http status code.
PutMetricFilter
data PutMetricFilter Source #
See: newPutMetricFilter
smart constructor.
Instances
:: 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:
PutMetricFilter
, putMetricFilter_logGroupName
- The name of the log group.
PutMetricFilter
, putMetricFilter_filterName
- A name for the metric filter.
PutMetricFilter
, putMetricFilter_filterPattern
- A filter pattern for extracting metric data out of ingested log events.
PutMetricFilter
, putMetricFilter_metricTransformations
- A collection of information that defines how metric data gets emitted.
data PutMetricFilterResponse Source #
See: newPutMetricFilterResponse
smart constructor.
Instances
Generic PutMetricFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutMetricFilter type Rep PutMetricFilterResponse :: Type -> Type # | |
Read PutMetricFilterResponse Source # | |
Show PutMetricFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutMetricFilter showsPrec :: Int -> PutMetricFilterResponse -> ShowS # show :: PutMetricFilterResponse -> String # showList :: [PutMetricFilterResponse] -> ShowS # | |
NFData PutMetricFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutMetricFilter rnf :: PutMetricFilterResponse -> () # | |
Eq PutMetricFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutMetricFilter | |
type Rep PutMetricFilterResponse Source # | |
Defined in Amazonka.CloudWatchLogs.PutMetricFilter |
newPutMetricFilterResponse :: PutMetricFilterResponse Source #
Create a value of PutMetricFilterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutQueryDefinition
data PutQueryDefinition Source #
See: newPutQueryDefinition
smart constructor.
Instances
newPutQueryDefinition Source #
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:
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.
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.
PutQueryDefinition
, putQueryDefinition_name
- A name for the query definition. If you are saving numerous query
definitions, we recommend that you name them. This way, you can find the
ones you want by using the first part of the name as a filter in the
queryDefinitionNamePrefix
parameter of
DescribeQueryDefinitions.
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.
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:
PutQueryDefinition
, putQueryDefinitionResponse_queryDefinitionId
- The ID of the query definition.
$sel:httpStatus:PutQueryDefinitionResponse'
, putQueryDefinitionResponse_httpStatus
- The response's http status code.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy
smart constructor.
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:
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. You would also 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" } } } ] }
PutResourcePolicy
, putResourcePolicy_policyName
- Name of the new policy. This parameter is required.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse
smart constructor.
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.
PutRetentionPolicy
data PutRetentionPolicy Source #
See: newPutRetentionPolicy
smart constructor.
Instances
newPutRetentionPolicy Source #
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:
PutRetentionPolicy
, putRetentionPolicy_logGroupName
- The name of the log group.
PutRetentionPolicy
, putRetentionPolicy_retentionInDays
- Undocumented member.
data PutRetentionPolicyResponse Source #
See: newPutRetentionPolicyResponse
smart constructor.
Instances
newPutRetentionPolicyResponse :: PutRetentionPolicyResponse Source #
Create a value of PutRetentionPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutSubscriptionFilter
data PutSubscriptionFilter Source #
See: newPutSubscriptionFilter
smart constructor.
Instances
newPutSubscriptionFilter Source #
:: 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:
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 data stream.
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.
PutSubscriptionFilter
, putSubscriptionFilter_logGroupName
- The name of the log group.
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.
PutSubscriptionFilter
, putSubscriptionFilter_filterPattern
- A filter pattern for subscribing to a filtered stream of log events.
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're setting up a cross-account subscription, the destination must have an IAM policy associated with it. The IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.
- A Kinesis Data 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.
Instances
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
:: 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: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:logGroupIdentifiers:StartQuery'
, startQuery_logGroupIdentifiers
- The list of log groups to query. You can include up to 50 log groups.
You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.
If you specify an ARN, the ARN can't end with an asterisk (*).
A StartQuery
operation must include exactly one of the following
parameters: logGroupName
, logGroupNames
or logGroupIdentifiers
.
StartQuery
, startQuery_logGroupName
- The log group on which to perform the query.
A StartQuery
operation must include exactly one of the following
parameters: logGroupName
, logGroupNames
or logGroupIdentifiers
.
StartQuery
, startQuery_logGroupNames
- The list of log groups to be queried. You can include up to 50 log
groups.
A StartQuery
operation must include exactly one of the following
parameters: logGroupName
, logGroupNames
or logGroupIdentifiers
.
$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
.
StartQuery
, startQuery_queryString
- The query string to use. For more information, see
CloudWatch Logs Insights Query Syntax.
data StartQueryResponse Source #
See: newStartQueryResponse
smart constructor.
Instances
newStartQueryResponse Source #
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:
StartQueryResponse
, startQueryResponse_queryId
- The unique ID of the query.
$sel:httpStatus:StartQueryResponse'
, startQueryResponse_httpStatus
- The response's http status code.
StopQuery
See: newStopQuery
smart constructor.
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:
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.
Instances
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.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The ARN of the resource that you're adding tags to.
The ARN format of a log group is
arn:aws:logs:
Region
:
account-id
:log-group:
log-group-name
The ARN format of a destination is
arn:aws:logs:
Region
:
account-id
:destination:
destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
$sel:tags:TagResource'
, tagResource_tags
- The list of key-value pairs to associate with the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Generic TagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
Read TagResourceResponse Source # | |
Show TagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.TagResource rnf :: TagResourceResponse -> () # | |
Eq TagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TestMetricFilter
data TestMetricFilter Source #
See: newTestMetricFilter
smart constructor.
Instances
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:
TestMetricFilter
, testMetricFilter_filterPattern
- Undocumented member.
$sel:logEventMessages:TestMetricFilter'
, testMetricFilter_logEventMessages
- The log event messages to test.
data TestMetricFilterResponse Source #
See: newTestMetricFilterResponse
smart constructor.
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.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The ARN of the CloudWatch Logs resource that you're removing tags from.
The ARN format of a log group is
arn:aws:logs:
Region
:
account-id
:log-group:
log-group-name
The ARN format of a destination is
arn:aws:logs:
Region
:
account-id
:destination:
destination-name
For more information about ARN format, see CloudWatch Logs resources and operations.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of tag keys to remove from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Generic UntagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.UntagResource rnf :: UntagResourceResponse -> () # | |
Eq UntagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
type Rep UntagResourceResponse Source # | |
Defined in Amazonka.CloudWatchLogs.UntagResource |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
DataProtectionStatus
newtype DataProtectionStatus Source #
pattern DataProtectionStatus_ACTIVATED :: DataProtectionStatus | |
pattern DataProtectionStatus_ARCHIVED :: DataProtectionStatus | |
pattern DataProtectionStatus_DELETED :: DataProtectionStatus | |
pattern DataProtectionStatus_DISABLED :: DataProtectionStatus |
Instances
Distribution
newtype Distribution Source #
The method used to distribute log data to the destination, which can be either random or grouped by log stream.
pattern Distribution_ByLogStream :: Distribution | |
pattern Distribution_Random :: Distribution |
Instances
ExportTaskStatusCode
newtype ExportTaskStatusCode Source #
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
pattern OrderBy_LastEventTime :: OrderBy | |
pattern OrderBy_LogStreamName :: OrderBy |
Instances
QueryStatus
newtype QueryStatus Source #
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 #
Instances
Destination
data Destination Source #
Represents a cross-account destination that receives subscription log events.
See: newDestination
smart constructor.
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:accessPolicy:Destination'
, destination_accessPolicy
- An IAM policy document that governs which Amazon Web Services accounts
can create subscription filters against this destination.
$sel:arn:Destination'
, destination_arn
- The ARN of this destination.
$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: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.
$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).
ExportTask
data ExportTask Source #
Represents an export task.
See: newExportTask
smart constructor.
ExportTask' (Maybe Text) (Maybe Text) (Maybe ExportTaskExecutionInfo) (Maybe Natural) (Maybe Text) (Maybe ExportTaskStatus) (Maybe Text) (Maybe Text) (Maybe Natural) |
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:destination:ExportTask'
, exportTask_destination
- The name of the S3 bucket to which the log data was exported.
$sel:destinationPrefix:ExportTask'
, exportTask_destinationPrefix
- The prefix that was used as the start of Amazon S3 key for every object
exported.
$sel:executionInfo:ExportTask'
, exportTask_executionInfo
- Execution information about the export task.
$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:status:ExportTask'
, exportTask_status
- The status of the export task.
$sel:taskId:ExportTask'
, exportTask_taskId
- The ID of the export task.
$sel:taskName:ExportTask'
, exportTask_taskName
- The name 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.
ExportTaskExecutionInfo
data ExportTaskExecutionInfo Source #
Represents the status of an export task.
See: newExportTaskExecutionInfo
smart constructor.
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: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
.
$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
.
ExportTaskStatus
data ExportTaskStatus Source #
Represents the status of an export task.
See: newExportTaskStatus
smart constructor.
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.
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:eventId:FilteredLogEvent'
, filteredLogEvent_eventId
- The ID of the event.
$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
.
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.
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.
LogGroup' (Maybe Text) (Maybe Natural) (Maybe DataProtectionStatus) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (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:arn:LogGroup'
, logGroup_arn
- The Amazon Resource Name (ARN) of the log group.
$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:dataProtectionStatus:LogGroup'
, logGroup_dataProtectionStatus
- Displays whether this log group has a protection policy, or whether it
had one in the past. For more information, see
PutDataProtectionPolicy.
$sel:kmsKeyId:LogGroup'
, logGroup_kmsKeyId
- The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
data.
$sel:logGroupName:LogGroup'
, logGroup_logGroupName
- The name of the log group.
$sel:metricFilterCount:LogGroup'
, logGroup_metricFilterCount
- The number of metric filters.
$sel:retentionInDays:LogGroup'
, logGroup_retentionInDays
- Undocumented member.
$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.
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:name:LogGroupField'
, logGroupField_name
- The name of a log field.
$sel:percent:LogGroupField'
, logGroupField_percent
- The percentage of log events queried that contained the field.
LogStream
Represents a log stream, which is a sequence of log events from a single emitter of logs.
See: newLogStream
smart constructor.
LogStream' (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Text) |
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:arn:LogStream'
, logStream_arn
- The Amazon Resource Name (ARN) of the log stream.
$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: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: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.
$sel:lastIngestionTime:LogStream'
, logStream_lastIngestionTime
- The ingestion time, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
The lastIngestionTime
value updates on an
eventual consistency basis. It typically updates in less than an hour
after ingestion, but in rare situations might take longer.
$sel:logStreamName:LogStream'
, logStream_logStreamName
- The name of the log stream.
$sel:storedBytes:LogStream'
, logStream_storedBytes
- The number of bytes stored.
Important: As of June 17, 2019, this parameter is no longer
supported 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:uploadSequenceToken:LogStream'
, logStream_uploadSequenceToken
- The sequence token.
The sequence token is now ignored in PutLogEvents
actions.
PutLogEvents
actions are always accepted regardless of receiving an
invalid sequence token. You don't need to obtain uploadSequenceToken
to use a PutLogEvents
action.
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.
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:filterPattern:MetricFilter'
, metricFilter_filterPattern
- Undocumented member.
$sel:logGroupName:MetricFilter'
, metricFilter_logGroupName
- The name of the log group.
$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:eventMessage:MetricFilterMatchRecord'
, metricFilterMatchRecord_eventMessage
- The raw event data.
$sel:eventNumber:MetricFilterMatchRecord'
, metricFilterMatchRecord_eventNumber
- The event number.
$sel:extractedValues:MetricFilterMatchRecord'
, metricFilterMatchRecord_extractedValues
- The values extracted from the event data by the filter.
MetricTransformation
data MetricTransformation Source #
Indicates how to transform ingested log events to metric data in a CloudWatch metric.
See: newMetricTransformation
smart constructor.
MetricTransformation' (Maybe Double) (Maybe (HashMap Text Text)) (Maybe StandardUnit) Text Text Text |
Instances
newMetricTransformation Source #
:: 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.
CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges.
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:lastModified:QueryDefinition'
, queryDefinition_lastModified
- The date that the query definition was most recently modified.
$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:name:QueryDefinition'
, queryDefinition_name
- The name of the query definition.
$sel:queryDefinitionId:QueryDefinition'
, queryDefinition_queryDefinitionId
- The unique ID 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.
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:createTime:QueryInfo'
, queryInfo_createTime
- The date and time that this query was created.
$sel:logGroupName:QueryInfo'
, queryInfo_logGroupName
- The name of the log group scanned by this query.
$sel:queryId:QueryInfo'
, queryInfo_queryId
- The unique ID number of this query.
$sel:queryString:QueryInfo'
, queryInfo_queryString
- The query string used in this query.
$sel:status:QueryInfo'
, queryInfo_status
- The status of this query. Possible values are Cancelled
, Complete
,
Failed
, Running
, Scheduled
, and Unknown
.
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: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.
$sel:recordsScanned:QueryStatistics'
, queryStatistics_recordsScanned
- The total number of log events scanned during the query.
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:expiredLogEventEndIndex:RejectedLogEventsInfo'
, rejectedLogEventsInfo_expiredLogEventEndIndex
- The expired log events.
$sel:tooNewLogEventStartIndex:RejectedLogEventsInfo'
, rejectedLogEventsInfo_tooNewLogEventStartIndex
- The log events that are too new.
$sel:tooOldLogEventEndIndex:RejectedLogEventsInfo'
, rejectedLogEventsInfo_tooOldLogEventEndIndex
- The log events that are dated too far in the past.
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: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
.
$sel:policyDocument:ResourcePolicy'
, resourcePolicy_policyDocument
- The details of the policy.
$sel:policyName:ResourcePolicy'
, resourcePolicy_policyName
- The name of the resource policy.
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.
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.
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.
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:destinationArn:SubscriptionFilter'
, subscriptionFilter_destinationArn
- The Amazon Resource Name (ARN) of the destination.
$sel:distribution:SubscriptionFilter'
, subscriptionFilter_distribution
- Undocumented member.
$sel:filterName:SubscriptionFilter'
, subscriptionFilter_filterName
- The name of the subscription filter.
$sel:filterPattern:SubscriptionFilter'
, subscriptionFilter_filterPattern
- Undocumented member.
$sel:logGroupName:SubscriptionFilter'
, subscriptionFilter_logGroupName
- The name of the log group.
$sel:roleArn:SubscriptionFilter'
, subscriptionFilter_roleArn
-