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 |
- Operations
- AssociateKmsKey
- CancelExportTask
- CreateExportTask
- CreateLogGroup
- CreateLogStream
- DeleteDataProtectionPolicy
- DeleteDestination
- DeleteLogGroup
- DeleteLogStream
- DeleteMetricFilter
- DeleteQueryDefinition
- DeleteResourcePolicy
- DeleteRetentionPolicy
- DeleteSubscriptionFilter
- DescribeDestinations
- DescribeExportTasks
- DescribeLogGroups
- DescribeLogStreams
- DescribeMetricFilters
- DescribeQueries
- DescribeQueryDefinitions
- DescribeResourcePolicies
- DescribeSubscriptionFilters
- DisassociateKmsKey
- FilterLogEvents
- GetDataProtectionPolicy
- GetLogEvents
- GetLogGroupFields
- GetLogRecord
- GetQueryResults
- ListTagsForResource
- PutDataProtectionPolicy
- PutDestination
- PutDestinationPolicy
- PutLogEvents
- PutMetricFilter
- PutQueryDefinition
- PutResourcePolicy
- PutRetentionPolicy
- PutSubscriptionFilter
- StartQuery
- StopQuery
- TagResource
- TestMetricFilter
- UntagResource
- Types
- Destination
- ExportTask
- ExportTaskExecutionInfo
- ExportTaskStatus
- FilteredLogEvent
- InputLogEvent
- LogGroup
- LogGroupField
- LogStream
- MetricFilter
- MetricFilterMatchRecord
- MetricTransformation
- OutputLogEvent
- QueryDefinition
- QueryInfo
- QueryStatistics
- RejectedLogEventsInfo
- ResourcePolicy
- ResultField
- SearchedLogStream
- SubscriptionFilter
Synopsis
- associateKmsKey_logGroupName :: Lens' AssociateKmsKey Text
- associateKmsKey_kmsKeyId :: Lens' AssociateKmsKey Text
- cancelExportTask_taskId :: Lens' CancelExportTask Text
- createExportTask_destinationPrefix :: Lens' CreateExportTask (Maybe Text)
- createExportTask_logStreamNamePrefix :: Lens' CreateExportTask (Maybe Text)
- createExportTask_taskName :: Lens' CreateExportTask (Maybe Text)
- createExportTask_logGroupName :: Lens' CreateExportTask Text
- createExportTask_from :: Lens' CreateExportTask Natural
- createExportTask_to :: Lens' CreateExportTask Natural
- createExportTask_destination :: Lens' CreateExportTask Text
- createExportTaskResponse_taskId :: Lens' CreateExportTaskResponse (Maybe Text)
- createExportTaskResponse_httpStatus :: Lens' CreateExportTaskResponse Int
- createLogGroup_kmsKeyId :: Lens' CreateLogGroup (Maybe Text)
- createLogGroup_tags :: Lens' CreateLogGroup (Maybe (HashMap Text Text))
- createLogGroup_logGroupName :: Lens' CreateLogGroup Text
- createLogStream_logGroupName :: Lens' CreateLogStream Text
- createLogStream_logStreamName :: Lens' CreateLogStream Text
- deleteDataProtectionPolicy_logGroupIdentifier :: Lens' DeleteDataProtectionPolicy Text
- deleteDestination_destinationName :: Lens' DeleteDestination Text
- deleteLogGroup_logGroupName :: Lens' DeleteLogGroup Text
- deleteLogStream_logGroupName :: Lens' DeleteLogStream Text
- deleteLogStream_logStreamName :: Lens' DeleteLogStream Text
- deleteMetricFilter_logGroupName :: Lens' DeleteMetricFilter Text
- deleteMetricFilter_filterName :: Lens' DeleteMetricFilter Text
- deleteQueryDefinition_queryDefinitionId :: Lens' DeleteQueryDefinition Text
- deleteQueryDefinitionResponse_success :: Lens' DeleteQueryDefinitionResponse (Maybe Bool)
- deleteQueryDefinitionResponse_httpStatus :: Lens' DeleteQueryDefinitionResponse Int
- deleteResourcePolicy_policyName :: Lens' DeleteResourcePolicy (Maybe Text)
- deleteRetentionPolicy_logGroupName :: Lens' DeleteRetentionPolicy Text
- deleteSubscriptionFilter_logGroupName :: Lens' DeleteSubscriptionFilter Text
- deleteSubscriptionFilter_filterName :: Lens' DeleteSubscriptionFilter Text
- describeDestinations_destinationNamePrefix :: Lens' DescribeDestinations (Maybe Text)
- describeDestinations_limit :: Lens' DescribeDestinations (Maybe Natural)
- describeDestinations_nextToken :: Lens' DescribeDestinations (Maybe Text)
- describeDestinationsResponse_destinations :: Lens' DescribeDestinationsResponse (Maybe [Destination])
- describeDestinationsResponse_nextToken :: Lens' DescribeDestinationsResponse (Maybe Text)
- describeDestinationsResponse_httpStatus :: Lens' DescribeDestinationsResponse Int
- describeExportTasks_limit :: Lens' DescribeExportTasks (Maybe Natural)
- describeExportTasks_nextToken :: Lens' DescribeExportTasks (Maybe Text)
- describeExportTasks_statusCode :: Lens' DescribeExportTasks (Maybe ExportTaskStatusCode)
- describeExportTasks_taskId :: Lens' DescribeExportTasks (Maybe Text)
- describeExportTasksResponse_exportTasks :: Lens' DescribeExportTasksResponse (Maybe [ExportTask])
- describeExportTasksResponse_nextToken :: Lens' DescribeExportTasksResponse (Maybe Text)
- describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int
- describeLogGroups_accountIdentifiers :: Lens' DescribeLogGroups (Maybe [Text])
- describeLogGroups_includeLinkedAccounts :: Lens' DescribeLogGroups (Maybe Bool)
- describeLogGroups_limit :: Lens' DescribeLogGroups (Maybe Natural)
- describeLogGroups_logGroupNamePattern :: Lens' DescribeLogGroups (Maybe Text)
- describeLogGroups_logGroupNamePrefix :: Lens' DescribeLogGroups (Maybe Text)
- describeLogGroups_nextToken :: Lens' DescribeLogGroups (Maybe Text)
- describeLogGroupsResponse_logGroups :: Lens' DescribeLogGroupsResponse (Maybe [LogGroup])
- describeLogGroupsResponse_nextToken :: Lens' DescribeLogGroupsResponse (Maybe Text)
- describeLogGroupsResponse_httpStatus :: Lens' DescribeLogGroupsResponse Int
- describeLogStreams_descending :: Lens' DescribeLogStreams (Maybe Bool)
- describeLogStreams_limit :: Lens' DescribeLogStreams (Maybe Natural)
- describeLogStreams_logGroupIdentifier :: Lens' DescribeLogStreams (Maybe Text)
- describeLogStreams_logStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text)
- describeLogStreams_nextToken :: Lens' DescribeLogStreams (Maybe Text)
- describeLogStreams_orderBy :: Lens' DescribeLogStreams (Maybe OrderBy)
- describeLogStreams_logGroupName :: Lens' DescribeLogStreams Text
- describeLogStreamsResponse_logStreams :: Lens' DescribeLogStreamsResponse (Maybe [LogStream])
- describeLogStreamsResponse_nextToken :: Lens' DescribeLogStreamsResponse (Maybe Text)
- describeLogStreamsResponse_httpStatus :: Lens' DescribeLogStreamsResponse Int
- describeMetricFilters_filterNamePrefix :: Lens' DescribeMetricFilters (Maybe Text)
- describeMetricFilters_limit :: Lens' DescribeMetricFilters (Maybe Natural)
- describeMetricFilters_logGroupName :: Lens' DescribeMetricFilters (Maybe Text)
- describeMetricFilters_metricName :: Lens' DescribeMetricFilters (Maybe Text)
- describeMetricFilters_metricNamespace :: Lens' DescribeMetricFilters (Maybe Text)
- describeMetricFilters_nextToken :: Lens' DescribeMetricFilters (Maybe Text)
- describeMetricFiltersResponse_metricFilters :: Lens' DescribeMetricFiltersResponse (Maybe [MetricFilter])
- describeMetricFiltersResponse_nextToken :: Lens' DescribeMetricFiltersResponse (Maybe Text)
- describeMetricFiltersResponse_httpStatus :: Lens' DescribeMetricFiltersResponse Int
- describeQueries_logGroupName :: Lens' DescribeQueries (Maybe Text)
- describeQueries_maxResults :: Lens' DescribeQueries (Maybe Natural)
- describeQueries_nextToken :: Lens' DescribeQueries (Maybe Text)
- describeQueries_status :: Lens' DescribeQueries (Maybe QueryStatus)
- describeQueriesResponse_nextToken :: Lens' DescribeQueriesResponse (Maybe Text)
- describeQueriesResponse_queries :: Lens' DescribeQueriesResponse (Maybe [QueryInfo])
- describeQueriesResponse_httpStatus :: Lens' DescribeQueriesResponse Int
- describeQueryDefinitions_maxResults :: Lens' DescribeQueryDefinitions (Maybe Natural)
- describeQueryDefinitions_nextToken :: Lens' DescribeQueryDefinitions (Maybe Text)
- describeQueryDefinitions_queryDefinitionNamePrefix :: Lens' DescribeQueryDefinitions (Maybe Text)
- describeQueryDefinitionsResponse_nextToken :: Lens' DescribeQueryDefinitionsResponse (Maybe Text)
- describeQueryDefinitionsResponse_queryDefinitions :: Lens' DescribeQueryDefinitionsResponse (Maybe [QueryDefinition])
- describeQueryDefinitionsResponse_httpStatus :: Lens' DescribeQueryDefinitionsResponse Int
- describeResourcePolicies_limit :: Lens' DescribeResourcePolicies (Maybe Natural)
- describeResourcePolicies_nextToken :: Lens' DescribeResourcePolicies (Maybe Text)
- describeResourcePoliciesResponse_nextToken :: Lens' DescribeResourcePoliciesResponse (Maybe Text)
- describeResourcePoliciesResponse_resourcePolicies :: Lens' DescribeResourcePoliciesResponse (Maybe [ResourcePolicy])
- describeResourcePoliciesResponse_httpStatus :: Lens' DescribeResourcePoliciesResponse Int
- describeSubscriptionFilters_filterNamePrefix :: Lens' DescribeSubscriptionFilters (Maybe Text)
- describeSubscriptionFilters_limit :: Lens' DescribeSubscriptionFilters (Maybe Natural)
- describeSubscriptionFilters_nextToken :: Lens' DescribeSubscriptionFilters (Maybe Text)
- describeSubscriptionFilters_logGroupName :: Lens' DescribeSubscriptionFilters Text
- describeSubscriptionFiltersResponse_nextToken :: Lens' DescribeSubscriptionFiltersResponse (Maybe Text)
- describeSubscriptionFiltersResponse_subscriptionFilters :: Lens' DescribeSubscriptionFiltersResponse (Maybe [SubscriptionFilter])
- describeSubscriptionFiltersResponse_httpStatus :: Lens' DescribeSubscriptionFiltersResponse Int
- disassociateKmsKey_logGroupName :: Lens' DisassociateKmsKey Text
- filterLogEvents_endTime :: Lens' FilterLogEvents (Maybe Natural)
- filterLogEvents_filterPattern :: Lens' FilterLogEvents (Maybe Text)
- filterLogEvents_interleaved :: Lens' FilterLogEvents (Maybe Bool)
- filterLogEvents_limit :: Lens' FilterLogEvents (Maybe Natural)
- filterLogEvents_logGroupIdentifier :: Lens' FilterLogEvents (Maybe Text)
- filterLogEvents_logStreamNamePrefix :: Lens' FilterLogEvents (Maybe Text)
- filterLogEvents_logStreamNames :: Lens' FilterLogEvents (Maybe (NonEmpty Text))
- filterLogEvents_nextToken :: Lens' FilterLogEvents (Maybe Text)
- filterLogEvents_startTime :: Lens' FilterLogEvents (Maybe Natural)
- filterLogEvents_unmask :: Lens' FilterLogEvents (Maybe Bool)
- filterLogEvents_logGroupName :: Lens' FilterLogEvents Text
- filterLogEventsResponse_events :: Lens' FilterLogEventsResponse (Maybe [FilteredLogEvent])
- filterLogEventsResponse_nextToken :: Lens' FilterLogEventsResponse (Maybe Text)
- filterLogEventsResponse_searchedLogStreams :: Lens' FilterLogEventsResponse (Maybe [SearchedLogStream])
- filterLogEventsResponse_httpStatus :: Lens' FilterLogEventsResponse Int
- getDataProtectionPolicy_logGroupIdentifier :: Lens' GetDataProtectionPolicy Text
- getDataProtectionPolicyResponse_lastUpdatedTime :: Lens' GetDataProtectionPolicyResponse (Maybe Natural)
- getDataProtectionPolicyResponse_logGroupIdentifier :: Lens' GetDataProtectionPolicyResponse (Maybe Text)
- getDataProtectionPolicyResponse_policyDocument :: Lens' GetDataProtectionPolicyResponse (Maybe Text)
- getDataProtectionPolicyResponse_httpStatus :: Lens' GetDataProtectionPolicyResponse Int
- getLogEvents_endTime :: Lens' GetLogEvents (Maybe Natural)
- getLogEvents_limit :: Lens' GetLogEvents (Maybe Natural)
- getLogEvents_logGroupIdentifier :: Lens' GetLogEvents (Maybe Text)
- getLogEvents_nextToken :: Lens' GetLogEvents (Maybe Text)
- getLogEvents_startFromHead :: Lens' GetLogEvents (Maybe Bool)
- getLogEvents_startTime :: Lens' GetLogEvents (Maybe Natural)
- getLogEvents_unmask :: Lens' GetLogEvents (Maybe Bool)
- getLogEvents_logGroupName :: Lens' GetLogEvents Text
- getLogEvents_logStreamName :: Lens' GetLogEvents Text
- getLogEventsResponse_events :: Lens' GetLogEventsResponse (Maybe [OutputLogEvent])
- getLogEventsResponse_nextBackwardToken :: Lens' GetLogEventsResponse (Maybe Text)
- getLogEventsResponse_nextForwardToken :: Lens' GetLogEventsResponse (Maybe Text)
- getLogEventsResponse_httpStatus :: Lens' GetLogEventsResponse Int
- getLogGroupFields_logGroupIdentifier :: Lens' GetLogGroupFields (Maybe Text)
- getLogGroupFields_time :: Lens' GetLogGroupFields (Maybe Natural)
- getLogGroupFields_logGroupName :: Lens' GetLogGroupFields Text
- getLogGroupFieldsResponse_logGroupFields :: Lens' GetLogGroupFieldsResponse (Maybe [LogGroupField])
- getLogGroupFieldsResponse_httpStatus :: Lens' GetLogGroupFieldsResponse Int
- getLogRecord_unmask :: Lens' GetLogRecord (Maybe Bool)
- getLogRecord_logRecordPointer :: Lens' GetLogRecord Text
- getLogRecordResponse_logRecord :: Lens' GetLogRecordResponse (Maybe (HashMap Text Text))
- getLogRecordResponse_httpStatus :: Lens' GetLogRecordResponse Int
- getQueryResults_queryId :: Lens' GetQueryResults Text
- getQueryResultsResponse_results :: Lens' GetQueryResultsResponse (Maybe [[ResultField]])
- getQueryResultsResponse_statistics :: Lens' GetQueryResultsResponse (Maybe QueryStatistics)
- getQueryResultsResponse_status :: Lens' GetQueryResultsResponse (Maybe QueryStatus)
- getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- putDataProtectionPolicy_logGroupIdentifier :: Lens' PutDataProtectionPolicy Text
- putDataProtectionPolicy_policyDocument :: Lens' PutDataProtectionPolicy Text
- putDataProtectionPolicyResponse_lastUpdatedTime :: Lens' PutDataProtectionPolicyResponse (Maybe Natural)
- putDataProtectionPolicyResponse_logGroupIdentifier :: Lens' PutDataProtectionPolicyResponse (Maybe Text)
- putDataProtectionPolicyResponse_policyDocument :: Lens' PutDataProtectionPolicyResponse (Maybe Text)
- putDataProtectionPolicyResponse_httpStatus :: Lens' PutDataProtectionPolicyResponse Int
- putDestination_tags :: Lens' PutDestination (Maybe (HashMap Text Text))
- putDestination_destinationName :: Lens' PutDestination Text
- putDestination_targetArn :: Lens' PutDestination Text
- putDestination_roleArn :: Lens' PutDestination Text
- putDestinationResponse_destination :: Lens' PutDestinationResponse (Maybe Destination)
- putDestinationResponse_httpStatus :: Lens' PutDestinationResponse Int
- putDestinationPolicy_forceUpdate :: Lens' PutDestinationPolicy (Maybe Bool)
- putDestinationPolicy_destinationName :: Lens' PutDestinationPolicy Text
- putDestinationPolicy_accessPolicy :: Lens' PutDestinationPolicy Text
- putLogEvents_sequenceToken :: Lens' PutLogEvents (Maybe Text)
- putLogEvents_logGroupName :: Lens' PutLogEvents Text
- putLogEvents_logStreamName :: Lens' PutLogEvents Text
- putLogEvents_logEvents :: Lens' PutLogEvents (NonEmpty InputLogEvent)
- putLogEventsResponse_nextSequenceToken :: Lens' PutLogEventsResponse (Maybe Text)
- putLogEventsResponse_rejectedLogEventsInfo :: Lens' PutLogEventsResponse (Maybe RejectedLogEventsInfo)
- putLogEventsResponse_httpStatus :: Lens' PutLogEventsResponse Int
- putMetricFilter_logGroupName :: Lens' PutMetricFilter Text
- putMetricFilter_filterName :: Lens' PutMetricFilter Text
- putMetricFilter_filterPattern :: Lens' PutMetricFilter Text
- putMetricFilter_metricTransformations :: Lens' PutMetricFilter (NonEmpty MetricTransformation)
- putQueryDefinition_logGroupNames :: Lens' PutQueryDefinition (Maybe [Text])
- putQueryDefinition_queryDefinitionId :: Lens' PutQueryDefinition (Maybe Text)
- putQueryDefinition_name :: Lens' PutQueryDefinition Text
- putQueryDefinition_queryString :: Lens' PutQueryDefinition Text
- putQueryDefinitionResponse_queryDefinitionId :: Lens' PutQueryDefinitionResponse (Maybe Text)
- putQueryDefinitionResponse_httpStatus :: Lens' PutQueryDefinitionResponse Int
- putResourcePolicy_policyDocument :: Lens' PutResourcePolicy (Maybe Text)
- putResourcePolicy_policyName :: Lens' PutResourcePolicy (Maybe Text)
- putResourcePolicyResponse_resourcePolicy :: Lens' PutResourcePolicyResponse (Maybe ResourcePolicy)
- putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int
- putRetentionPolicy_logGroupName :: Lens' PutRetentionPolicy Text
- putRetentionPolicy_retentionInDays :: Lens' PutRetentionPolicy Int
- putSubscriptionFilter_distribution :: Lens' PutSubscriptionFilter (Maybe Distribution)
- putSubscriptionFilter_roleArn :: Lens' PutSubscriptionFilter (Maybe Text)
- putSubscriptionFilter_logGroupName :: Lens' PutSubscriptionFilter Text
- putSubscriptionFilter_filterName :: Lens' PutSubscriptionFilter Text
- putSubscriptionFilter_filterPattern :: Lens' PutSubscriptionFilter Text
- putSubscriptionFilter_destinationArn :: Lens' PutSubscriptionFilter Text
- startQuery_limit :: Lens' StartQuery (Maybe Natural)
- startQuery_logGroupIdentifiers :: Lens' StartQuery (Maybe [Text])
- startQuery_logGroupName :: Lens' StartQuery (Maybe Text)
- startQuery_logGroupNames :: Lens' StartQuery (Maybe [Text])
- startQuery_startTime :: Lens' StartQuery Natural
- startQuery_endTime :: Lens' StartQuery Natural
- startQuery_queryString :: Lens' StartQuery Text
- startQueryResponse_queryId :: Lens' StartQueryResponse (Maybe Text)
- startQueryResponse_httpStatus :: Lens' StartQueryResponse Int
- stopQuery_queryId :: Lens' StopQuery Text
- stopQueryResponse_success :: Lens' StopQueryResponse (Maybe Bool)
- stopQueryResponse_httpStatus :: Lens' StopQueryResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- testMetricFilter_filterPattern :: Lens' TestMetricFilter Text
- testMetricFilter_logEventMessages :: Lens' TestMetricFilter (NonEmpty Text)
- testMetricFilterResponse_matches :: Lens' TestMetricFilterResponse (Maybe [MetricFilterMatchRecord])
- testMetricFilterResponse_httpStatus :: Lens' TestMetricFilterResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- destination_accessPolicy :: Lens' Destination (Maybe Text)
- destination_arn :: Lens' Destination (Maybe Text)
- destination_creationTime :: Lens' Destination (Maybe Natural)
- destination_destinationName :: Lens' Destination (Maybe Text)
- destination_roleArn :: Lens' Destination (Maybe Text)
- destination_targetArn :: Lens' Destination (Maybe Text)
- exportTask_destination :: Lens' ExportTask (Maybe Text)
- exportTask_destinationPrefix :: Lens' ExportTask (Maybe Text)
- exportTask_executionInfo :: Lens' ExportTask (Maybe ExportTaskExecutionInfo)
- exportTask_from :: Lens' ExportTask (Maybe Natural)
- exportTask_logGroupName :: Lens' ExportTask (Maybe Text)
- exportTask_status :: Lens' ExportTask (Maybe ExportTaskStatus)
- exportTask_taskId :: Lens' ExportTask (Maybe Text)
- exportTask_taskName :: Lens' ExportTask (Maybe Text)
- exportTask_to :: Lens' ExportTask (Maybe Natural)
- exportTaskExecutionInfo_completionTime :: Lens' ExportTaskExecutionInfo (Maybe Natural)
- exportTaskExecutionInfo_creationTime :: Lens' ExportTaskExecutionInfo (Maybe Natural)
- exportTaskStatus_code :: Lens' ExportTaskStatus (Maybe ExportTaskStatusCode)
- exportTaskStatus_message :: Lens' ExportTaskStatus (Maybe Text)
- filteredLogEvent_eventId :: Lens' FilteredLogEvent (Maybe Text)
- filteredLogEvent_ingestionTime :: Lens' FilteredLogEvent (Maybe Natural)
- filteredLogEvent_logStreamName :: Lens' FilteredLogEvent (Maybe Text)
- filteredLogEvent_message :: Lens' FilteredLogEvent (Maybe Text)
- filteredLogEvent_timestamp :: Lens' FilteredLogEvent (Maybe Natural)
- inputLogEvent_timestamp :: Lens' InputLogEvent Natural
- inputLogEvent_message :: Lens' InputLogEvent Text
- logGroup_arn :: Lens' LogGroup (Maybe Text)
- logGroup_creationTime :: Lens' LogGroup (Maybe Natural)
- logGroup_dataProtectionStatus :: Lens' LogGroup (Maybe DataProtectionStatus)
- logGroup_kmsKeyId :: Lens' LogGroup (Maybe Text)
- logGroup_logGroupName :: Lens' LogGroup (Maybe Text)
- logGroup_metricFilterCount :: Lens' LogGroup (Maybe Int)
- logGroup_retentionInDays :: Lens' LogGroup (Maybe Int)
- logGroup_storedBytes :: Lens' LogGroup (Maybe Natural)
- logGroupField_name :: Lens' LogGroupField (Maybe Text)
- logGroupField_percent :: Lens' LogGroupField (Maybe Natural)
- logStream_arn :: Lens' LogStream (Maybe Text)
- logStream_creationTime :: Lens' LogStream (Maybe Natural)
- logStream_firstEventTimestamp :: Lens' LogStream (Maybe Natural)
- logStream_lastEventTimestamp :: Lens' LogStream (Maybe Natural)
- logStream_lastIngestionTime :: Lens' LogStream (Maybe Natural)
- logStream_logStreamName :: Lens' LogStream (Maybe Text)
- logStream_storedBytes :: Lens' LogStream (Maybe Natural)
- logStream_uploadSequenceToken :: Lens' LogStream (Maybe Text)
- metricFilter_creationTime :: Lens' MetricFilter (Maybe Natural)
- metricFilter_filterName :: Lens' MetricFilter (Maybe Text)
- metricFilter_filterPattern :: Lens' MetricFilter (Maybe Text)
- metricFilter_logGroupName :: Lens' MetricFilter (Maybe Text)
- metricFilter_metricTransformations :: Lens' MetricFilter (Maybe (NonEmpty MetricTransformation))
- metricFilterMatchRecord_eventMessage :: Lens' MetricFilterMatchRecord (Maybe Text)
- metricFilterMatchRecord_eventNumber :: Lens' MetricFilterMatchRecord (Maybe Integer)
- metricFilterMatchRecord_extractedValues :: Lens' MetricFilterMatchRecord (Maybe (HashMap Text Text))
- metricTransformation_defaultValue :: Lens' MetricTransformation (Maybe Double)
- metricTransformation_dimensions :: Lens' MetricTransformation (Maybe (HashMap Text Text))
- metricTransformation_unit :: Lens' MetricTransformation (Maybe StandardUnit)
- metricTransformation_metricName :: Lens' MetricTransformation Text
- metricTransformation_metricNamespace :: Lens' MetricTransformation Text
- metricTransformation_metricValue :: Lens' MetricTransformation Text
- outputLogEvent_ingestionTime :: Lens' OutputLogEvent (Maybe Natural)
- outputLogEvent_message :: Lens' OutputLogEvent (Maybe Text)
- outputLogEvent_timestamp :: Lens' OutputLogEvent (Maybe Natural)
- queryDefinition_lastModified :: Lens' QueryDefinition (Maybe Natural)
- queryDefinition_logGroupNames :: Lens' QueryDefinition (Maybe [Text])
- queryDefinition_name :: Lens' QueryDefinition (Maybe Text)
- queryDefinition_queryDefinitionId :: Lens' QueryDefinition (Maybe Text)
- queryDefinition_queryString :: Lens' QueryDefinition (Maybe Text)
- queryInfo_createTime :: Lens' QueryInfo (Maybe Natural)
- queryInfo_logGroupName :: Lens' QueryInfo (Maybe Text)
- queryInfo_queryId :: Lens' QueryInfo (Maybe Text)
- queryInfo_queryString :: Lens' QueryInfo (Maybe Text)
- queryInfo_status :: Lens' QueryInfo (Maybe QueryStatus)
- queryStatistics_bytesScanned :: Lens' QueryStatistics (Maybe Double)
- queryStatistics_recordsMatched :: Lens' QueryStatistics (Maybe Double)
- queryStatistics_recordsScanned :: Lens' QueryStatistics (Maybe Double)
- rejectedLogEventsInfo_expiredLogEventEndIndex :: Lens' RejectedLogEventsInfo (Maybe Int)
- rejectedLogEventsInfo_tooNewLogEventStartIndex :: Lens' RejectedLogEventsInfo (Maybe Int)
- rejectedLogEventsInfo_tooOldLogEventEndIndex :: Lens' RejectedLogEventsInfo (Maybe Int)
- resourcePolicy_lastUpdatedTime :: Lens' ResourcePolicy (Maybe Natural)
- resourcePolicy_policyDocument :: Lens' ResourcePolicy (Maybe Text)
- resourcePolicy_policyName :: Lens' ResourcePolicy (Maybe Text)
- resultField_field :: Lens' ResultField (Maybe Text)
- resultField_value :: Lens' ResultField (Maybe Text)
- searchedLogStream_logStreamName :: Lens' SearchedLogStream (Maybe Text)
- searchedLogStream_searchedCompletely :: Lens' SearchedLogStream (Maybe Bool)
- subscriptionFilter_creationTime :: Lens' SubscriptionFilter (Maybe Natural)
- subscriptionFilter_destinationArn :: Lens' SubscriptionFilter (Maybe Text)
- subscriptionFilter_distribution :: Lens' SubscriptionFilter (Maybe Distribution)
- subscriptionFilter_filterName :: Lens' SubscriptionFilter (Maybe Text)
- subscriptionFilter_filterPattern :: Lens' SubscriptionFilter (Maybe Text)
- subscriptionFilter_logGroupName :: Lens' SubscriptionFilter (Maybe Text)
- subscriptionFilter_roleArn :: Lens' SubscriptionFilter (Maybe Text)
Operations
AssociateKmsKey
associateKmsKey_logGroupName :: Lens' AssociateKmsKey Text Source #
The name of the log group.
associateKmsKey_kmsKeyId :: Lens' AssociateKmsKey Text Source #
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.
CancelExportTask
cancelExportTask_taskId :: Lens' CancelExportTask Text Source #
The ID of the export task.
CreateExportTask
createExportTask_destinationPrefix :: Lens' CreateExportTask (Maybe Text) Source #
The prefix used as the start of the key for every object exported. If
you don't specify a value, the default is exportedlogs
.
createExportTask_logStreamNamePrefix :: Lens' CreateExportTask (Maybe Text) Source #
Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
createExportTask_taskName :: Lens' CreateExportTask (Maybe Text) Source #
The name of the export task.
createExportTask_logGroupName :: Lens' CreateExportTask Text Source #
The name of the log group.
createExportTask_from :: Lens' CreateExportTask Natural Source #
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_to :: Lens' CreateExportTask Natural Source #
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_destination :: Lens' CreateExportTask Text Source #
The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.
createExportTaskResponse_taskId :: Lens' CreateExportTaskResponse (Maybe Text) Source #
The ID of the export task.
createExportTaskResponse_httpStatus :: Lens' CreateExportTaskResponse Int Source #
The response's http status code.
CreateLogGroup
createLogGroup_kmsKeyId :: Lens' CreateLogGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. For more information, see Amazon Resource Names.
createLogGroup_tags :: Lens' CreateLogGroup (Maybe (HashMap Text Text)) Source #
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_logGroupName :: Lens' CreateLogGroup Text Source #
The name of the log group.
CreateLogStream
createLogStream_logGroupName :: Lens' CreateLogStream Text Source #
The name of the log group.
createLogStream_logStreamName :: Lens' CreateLogStream Text Source #
The name of the log stream.
DeleteDataProtectionPolicy
deleteDataProtectionPolicy_logGroupIdentifier :: Lens' DeleteDataProtectionPolicy Text Source #
The name or ARN of the log group that you want to delete the data protection policy for.
DeleteDestination
deleteDestination_destinationName :: Lens' DeleteDestination Text Source #
The name of the destination.
DeleteLogGroup
deleteLogGroup_logGroupName :: Lens' DeleteLogGroup Text Source #
The name of the log group.
DeleteLogStream
deleteLogStream_logGroupName :: Lens' DeleteLogStream Text Source #
The name of the log group.
deleteLogStream_logStreamName :: Lens' DeleteLogStream Text Source #
The name of the log stream.
DeleteMetricFilter
deleteMetricFilter_logGroupName :: Lens' DeleteMetricFilter Text Source #
The name of the log group.
deleteMetricFilter_filterName :: Lens' DeleteMetricFilter Text Source #
The name of the metric filter.
DeleteQueryDefinition
deleteQueryDefinition_queryDefinitionId :: Lens' DeleteQueryDefinition Text Source #
The ID of the query definition that you want to delete. You can use DescribeQueryDefinitions to retrieve the IDs of your saved query definitions.
deleteQueryDefinitionResponse_success :: Lens' DeleteQueryDefinitionResponse (Maybe Bool) Source #
A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation failed.
deleteQueryDefinitionResponse_httpStatus :: Lens' DeleteQueryDefinitionResponse Int Source #
The response's http status code.
DeleteResourcePolicy
deleteResourcePolicy_policyName :: Lens' DeleteResourcePolicy (Maybe Text) Source #
The name of the policy to be revoked. This parameter is required.
DeleteRetentionPolicy
deleteRetentionPolicy_logGroupName :: Lens' DeleteRetentionPolicy Text Source #
The name of the log group.
DeleteSubscriptionFilter
deleteSubscriptionFilter_logGroupName :: Lens' DeleteSubscriptionFilter Text Source #
The name of the log group.
deleteSubscriptionFilter_filterName :: Lens' DeleteSubscriptionFilter Text Source #
The name of the subscription filter.
DescribeDestinations
describeDestinations_destinationNamePrefix :: Lens' DescribeDestinations (Maybe Text) Source #
The prefix to match. If you don't specify a value, no prefix filter is applied.
describeDestinations_limit :: Lens' DescribeDestinations (Maybe Natural) Source #
The maximum number of items returned. If you don't specify a value, the default maximum value of 50 items is used.
describeDestinations_nextToken :: Lens' DescribeDestinations (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeDestinationsResponse_destinations :: Lens' DescribeDestinationsResponse (Maybe [Destination]) Source #
The destinations.
describeDestinationsResponse_nextToken :: Lens' DescribeDestinationsResponse (Maybe Text) Source #
Undocumented member.
describeDestinationsResponse_httpStatus :: Lens' DescribeDestinationsResponse Int Source #
The response's http status code.
DescribeExportTasks
describeExportTasks_limit :: Lens' DescribeExportTasks (Maybe Natural) Source #
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
describeExportTasks_nextToken :: Lens' DescribeExportTasks (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeExportTasks_statusCode :: Lens' DescribeExportTasks (Maybe ExportTaskStatusCode) Source #
The status code of the export task. Specifying a status code filters the results to zero or more export tasks.
describeExportTasks_taskId :: Lens' DescribeExportTasks (Maybe Text) Source #
The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.
describeExportTasksResponse_exportTasks :: Lens' DescribeExportTasksResponse (Maybe [ExportTask]) Source #
The export tasks.
describeExportTasksResponse_nextToken :: Lens' DescribeExportTasksResponse (Maybe Text) Source #
Undocumented member.
describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int Source #
The response's http status code.
DescribeLogGroups
describeLogGroups_accountIdentifiers :: Lens' DescribeLogGroups (Maybe [Text]) Source #
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.
describeLogGroups_includeLinkedAccounts :: Lens' DescribeLogGroups (Maybe Bool) Source #
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.
describeLogGroups_limit :: Lens' DescribeLogGroups (Maybe Natural) Source #
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
describeLogGroups_logGroupNamePattern :: Lens' DescribeLogGroups (Maybe Text) Source #
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.
describeLogGroups_logGroupNamePrefix :: Lens' DescribeLogGroups (Maybe Text) Source #
The prefix to match.
logGroupNamePrefix
and logGroupNamePattern
are mutually exclusive.
Only one of these parameters can be passed.
describeLogGroups_nextToken :: Lens' DescribeLogGroups (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeLogGroupsResponse_logGroups :: Lens' DescribeLogGroupsResponse (Maybe [LogGroup]) Source #
The log groups.
If the retentionInDays
value is not included for a log group, then
that log group's events do not expire.
describeLogGroupsResponse_nextToken :: Lens' DescribeLogGroupsResponse (Maybe Text) Source #
Undocumented member.
describeLogGroupsResponse_httpStatus :: Lens' DescribeLogGroupsResponse Int Source #
The response's http status code.
DescribeLogStreams
describeLogStreams_descending :: Lens' DescribeLogStreams (Maybe Bool) Source #
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.
describeLogStreams_limit :: Lens' DescribeLogStreams (Maybe Natural) Source #
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
describeLogStreams_logGroupIdentifier :: Lens' DescribeLogStreams (Maybe Text) Source #
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.
describeLogStreams_logStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text) Source #
The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
describeLogStreams_nextToken :: Lens' DescribeLogStreams (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeLogStreams_orderBy :: Lens' DescribeLogStreams (Maybe OrderBy) Source #
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_logGroupName :: Lens' DescribeLogStreams Text Source #
The name of the log group.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
describeLogStreamsResponse_logStreams :: Lens' DescribeLogStreamsResponse (Maybe [LogStream]) Source #
The log streams.
describeLogStreamsResponse_nextToken :: Lens' DescribeLogStreamsResponse (Maybe Text) Source #
Undocumented member.
describeLogStreamsResponse_httpStatus :: Lens' DescribeLogStreamsResponse Int Source #
The response's http status code.
DescribeMetricFilters
describeMetricFilters_filterNamePrefix :: Lens' DescribeMetricFilters (Maybe Text) Source #
The prefix to match. CloudWatch Logs uses the value that you set here
only if you also include the logGroupName
parameter in your request.
describeMetricFilters_limit :: Lens' DescribeMetricFilters (Maybe Natural) Source #
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
describeMetricFilters_logGroupName :: Lens' DescribeMetricFilters (Maybe Text) Source #
The name of the log group.
describeMetricFilters_metricName :: Lens' DescribeMetricFilters (Maybe Text) Source #
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_metricNamespace :: Lens' DescribeMetricFilters (Maybe Text) Source #
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_nextToken :: Lens' DescribeMetricFilters (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeMetricFiltersResponse_metricFilters :: Lens' DescribeMetricFiltersResponse (Maybe [MetricFilter]) Source #
The metric filters.
describeMetricFiltersResponse_nextToken :: Lens' DescribeMetricFiltersResponse (Maybe Text) Source #
Undocumented member.
describeMetricFiltersResponse_httpStatus :: Lens' DescribeMetricFiltersResponse Int Source #
The response's http status code.
DescribeQueries
describeQueries_logGroupName :: Lens' DescribeQueries (Maybe Text) Source #
Limits the returned queries to only those for the specified log group.
describeQueries_maxResults :: Lens' DescribeQueries (Maybe Natural) Source #
Limits the number of returned queries to the specified number.
describeQueries_nextToken :: Lens' DescribeQueries (Maybe Text) Source #
Undocumented member.
describeQueries_status :: Lens' DescribeQueries (Maybe QueryStatus) Source #
Limits the returned queries to only those that have the specified
status. Valid values are Cancelled
, Complete
, Failed
, Running
,
and Scheduled
.
describeQueriesResponse_nextToken :: Lens' DescribeQueriesResponse (Maybe Text) Source #
Undocumented member.
describeQueriesResponse_queries :: Lens' DescribeQueriesResponse (Maybe [QueryInfo]) Source #
The list of queries that match the request.
describeQueriesResponse_httpStatus :: Lens' DescribeQueriesResponse Int Source #
The response's http status code.
DescribeQueryDefinitions
describeQueryDefinitions_maxResults :: Lens' DescribeQueryDefinitions (Maybe Natural) Source #
Limits the number of returned query definitions to the specified number.
describeQueryDefinitions_nextToken :: Lens' DescribeQueryDefinitions (Maybe Text) Source #
Undocumented member.
describeQueryDefinitions_queryDefinitionNamePrefix :: Lens' DescribeQueryDefinitions (Maybe Text) Source #
Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.
describeQueryDefinitionsResponse_nextToken :: Lens' DescribeQueryDefinitionsResponse (Maybe Text) Source #
Undocumented member.
describeQueryDefinitionsResponse_queryDefinitions :: Lens' DescribeQueryDefinitionsResponse (Maybe [QueryDefinition]) Source #
The list of query definitions that match your request.
describeQueryDefinitionsResponse_httpStatus :: Lens' DescribeQueryDefinitionsResponse Int Source #
The response's http status code.
DescribeResourcePolicies
describeResourcePolicies_limit :: Lens' DescribeResourcePolicies (Maybe Natural) Source #
The maximum number of resource policies to be displayed with one call of this API.
describeResourcePolicies_nextToken :: Lens' DescribeResourcePolicies (Maybe Text) Source #
Undocumented member.
describeResourcePoliciesResponse_nextToken :: Lens' DescribeResourcePoliciesResponse (Maybe Text) Source #
Undocumented member.
describeResourcePoliciesResponse_resourcePolicies :: Lens' DescribeResourcePoliciesResponse (Maybe [ResourcePolicy]) Source #
The resource policies that exist in this account.
describeResourcePoliciesResponse_httpStatus :: Lens' DescribeResourcePoliciesResponse Int Source #
The response's http status code.
DescribeSubscriptionFilters
describeSubscriptionFilters_filterNamePrefix :: Lens' DescribeSubscriptionFilters (Maybe Text) Source #
The prefix to match. If you don't specify a value, no prefix filter is applied.
describeSubscriptionFilters_limit :: Lens' DescribeSubscriptionFilters (Maybe Natural) Source #
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
describeSubscriptionFilters_nextToken :: Lens' DescribeSubscriptionFilters (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
describeSubscriptionFilters_logGroupName :: Lens' DescribeSubscriptionFilters Text Source #
The name of the log group.
describeSubscriptionFiltersResponse_nextToken :: Lens' DescribeSubscriptionFiltersResponse (Maybe Text) Source #
Undocumented member.
describeSubscriptionFiltersResponse_subscriptionFilters :: Lens' DescribeSubscriptionFiltersResponse (Maybe [SubscriptionFilter]) Source #
The subscription filters.
describeSubscriptionFiltersResponse_httpStatus :: Lens' DescribeSubscriptionFiltersResponse Int Source #
The response's http status code.
DisassociateKmsKey
disassociateKmsKey_logGroupName :: Lens' DisassociateKmsKey Text Source #
The name of the log group.
FilterLogEvents
filterLogEvents_endTime :: Lens' FilterLogEvents (Maybe Natural) Source #
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_filterPattern :: Lens' FilterLogEvents (Maybe Text) Source #
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
filterLogEvents_interleaved :: Lens' FilterLogEvents (Maybe Bool) Source #
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.
filterLogEvents_limit :: Lens' FilterLogEvents (Maybe Natural) Source #
The maximum number of events to return. The default is 10,000 events.
filterLogEvents_logGroupIdentifier :: Lens' FilterLogEvents (Maybe Text) Source #
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.
filterLogEvents_logStreamNamePrefix :: Lens' FilterLogEvents (Maybe Text) Source #
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.
filterLogEvents_logStreamNames :: Lens' FilterLogEvents (Maybe (NonEmpty Text)) Source #
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_nextToken :: Lens' FilterLogEvents (Maybe Text) Source #
The token for the next set of events to return. (You received this token from a previous call.)
filterLogEvents_startTime :: Lens' FilterLogEvents (Maybe Natural) Source #
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.
filterLogEvents_unmask :: Lens' FilterLogEvents (Maybe Bool) Source #
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_logGroupName :: Lens' FilterLogEvents Text Source #
The name of the log group to search.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
filterLogEventsResponse_events :: Lens' FilterLogEventsResponse (Maybe [FilteredLogEvent]) Source #
The matched events.
filterLogEventsResponse_nextToken :: Lens' FilterLogEventsResponse (Maybe Text) Source #
The token to use when requesting the next set of items. The token expires after 24 hours.
filterLogEventsResponse_searchedLogStreams :: Lens' FilterLogEventsResponse (Maybe [SearchedLogStream]) Source #
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.
filterLogEventsResponse_httpStatus :: Lens' FilterLogEventsResponse Int Source #
The response's http status code.
GetDataProtectionPolicy
getDataProtectionPolicy_logGroupIdentifier :: Lens' GetDataProtectionPolicy Text Source #
The name or ARN of the log group that contains the data protection policy that you want to see.
getDataProtectionPolicyResponse_lastUpdatedTime :: Lens' GetDataProtectionPolicyResponse (Maybe Natural) Source #
The date and time that this policy was most recently updated.
getDataProtectionPolicyResponse_logGroupIdentifier :: Lens' GetDataProtectionPolicyResponse (Maybe Text) Source #
The log group name or ARN that you specified in your request.
getDataProtectionPolicyResponse_policyDocument :: Lens' GetDataProtectionPolicyResponse (Maybe Text) Source #
The data protection policy document for this log group.
getDataProtectionPolicyResponse_httpStatus :: Lens' GetDataProtectionPolicyResponse Int Source #
The response's http status code.
GetLogEvents
getLogEvents_endTime :: Lens' GetLogEvents (Maybe Natural) Source #
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.
getLogEvents_limit :: Lens' GetLogEvents (Maybe Natural) Source #
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).
getLogEvents_logGroupIdentifier :: Lens' GetLogEvents (Maybe Text) Source #
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.
getLogEvents_nextToken :: Lens' GetLogEvents (Maybe Text) Source #
The token for the next set of items to return. (You received this token from a previous call.)
getLogEvents_startFromHead :: Lens' GetLogEvents (Maybe Bool) Source #
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
.
getLogEvents_startTime :: Lens' GetLogEvents (Maybe Natural) Source #
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.
getLogEvents_unmask :: Lens' GetLogEvents (Maybe Bool) Source #
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_logGroupName :: Lens' GetLogEvents Text Source #
The name of the log group.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
getLogEvents_logStreamName :: Lens' GetLogEvents Text Source #
The name of the log stream.
getLogEventsResponse_events :: Lens' GetLogEventsResponse (Maybe [OutputLogEvent]) Source #
The events.
getLogEventsResponse_nextBackwardToken :: Lens' GetLogEventsResponse (Maybe Text) Source #
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.
getLogEventsResponse_nextForwardToken :: Lens' GetLogEventsResponse (Maybe Text) Source #
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.
getLogEventsResponse_httpStatus :: Lens' GetLogEventsResponse Int Source #
The response's http status code.
GetLogGroupFields
getLogGroupFields_logGroupIdentifier :: Lens' GetLogGroupFields (Maybe Text) Source #
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.
getLogGroupFields_time :: Lens' GetLogGroupFields (Maybe Natural) Source #
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_logGroupName :: Lens' GetLogGroupFields Text Source #
The name of the log group to search.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
getLogGroupFieldsResponse_logGroupFields :: Lens' GetLogGroupFieldsResponse (Maybe [LogGroupField]) Source #
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.
getLogGroupFieldsResponse_httpStatus :: Lens' GetLogGroupFieldsResponse Int Source #
The response's http status code.
GetLogRecord
getLogRecord_unmask :: Lens' GetLogRecord (Maybe Bool) Source #
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.
getLogRecord_logRecordPointer :: Lens' GetLogRecord Text Source #
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.
getLogRecordResponse_logRecord :: Lens' GetLogRecordResponse (Maybe (HashMap Text Text)) Source #
The requested log event, as a JSON string.
getLogRecordResponse_httpStatus :: Lens' GetLogRecordResponse Int Source #
The response's http status code.
GetQueryResults
getQueryResults_queryId :: Lens' GetQueryResults Text Source #
The ID number of the query.
getQueryResultsResponse_results :: Lens' GetQueryResultsResponse (Maybe [[ResultField]]) Source #
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.
getQueryResultsResponse_statistics :: Lens' GetQueryResultsResponse (Maybe QueryStatistics) Source #
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_status :: Lens' GetQueryResultsResponse (Maybe QueryStatus) Source #
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.
getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
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.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The list of tags associated with the requested resource.>
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
PutDataProtectionPolicy
putDataProtectionPolicy_logGroupIdentifier :: Lens' PutDataProtectionPolicy Text Source #
Specify either the log group name or log group ARN.
putDataProtectionPolicy_policyDocument :: Lens' PutDataProtectionPolicy Text Source #
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.
putDataProtectionPolicyResponse_lastUpdatedTime :: Lens' PutDataProtectionPolicyResponse (Maybe Natural) Source #
The date and time that this policy was most recently updated.
putDataProtectionPolicyResponse_logGroupIdentifier :: Lens' PutDataProtectionPolicyResponse (Maybe Text) Source #
The log group name or ARN that you specified in your request.
putDataProtectionPolicyResponse_policyDocument :: Lens' PutDataProtectionPolicyResponse (Maybe Text) Source #
The data protection policy used for this log group.
putDataProtectionPolicyResponse_httpStatus :: Lens' PutDataProtectionPolicyResponse Int Source #
The response's http status code.
PutDestination
putDestination_tags :: Lens' PutDestination (Maybe (HashMap Text Text)) Source #
An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
putDestination_destinationName :: Lens' PutDestination Text Source #
A name for the destination.
putDestination_targetArn :: Lens' PutDestination Text Source #
The ARN of an Amazon Kinesis stream to which to deliver matching log events.
putDestination_roleArn :: Lens' PutDestination Text Source #
The ARN of an IAM role that grants CloudWatch Logs permissions to call
the Amazon Kinesis PutRecord
operation on the destination stream.
putDestinationResponse_destination :: Lens' PutDestinationResponse (Maybe Destination) Source #
The destination.
putDestinationResponse_httpStatus :: Lens' PutDestinationResponse Int Source #
The response's http status code.
PutDestinationPolicy
putDestinationPolicy_forceUpdate :: Lens' PutDestinationPolicy (Maybe Bool) Source #
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_destinationName :: Lens' PutDestinationPolicy Text Source #
A name for an existing destination.
putDestinationPolicy_accessPolicy :: Lens' PutDestinationPolicy Text Source #
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.
PutLogEvents
putLogEvents_sequenceToken :: Lens' PutLogEvents (Maybe Text) Source #
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_logGroupName :: Lens' PutLogEvents Text Source #
The name of the log group.
putLogEvents_logStreamName :: Lens' PutLogEvents Text Source #
The name of the log stream.
putLogEvents_logEvents :: Lens' PutLogEvents (NonEmpty InputLogEvent) Source #
The log events.
putLogEventsResponse_nextSequenceToken :: Lens' PutLogEventsResponse (Maybe Text) Source #
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.
putLogEventsResponse_rejectedLogEventsInfo :: Lens' PutLogEventsResponse (Maybe RejectedLogEventsInfo) Source #
The rejected events.
putLogEventsResponse_httpStatus :: Lens' PutLogEventsResponse Int Source #
The response's http status code.
PutMetricFilter
putMetricFilter_logGroupName :: Lens' PutMetricFilter Text Source #
The name of the log group.
putMetricFilter_filterName :: Lens' PutMetricFilter Text Source #
A name for the metric filter.
putMetricFilter_filterPattern :: Lens' PutMetricFilter Text Source #
A filter pattern for extracting metric data out of ingested log events.
putMetricFilter_metricTransformations :: Lens' PutMetricFilter (NonEmpty MetricTransformation) Source #
A collection of information that defines how metric data gets emitted.
PutQueryDefinition
putQueryDefinition_logGroupNames :: Lens' PutQueryDefinition (Maybe [Text]) Source #
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_queryDefinitionId :: Lens' PutQueryDefinition (Maybe Text) Source #
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_name :: Lens' PutQueryDefinition Text Source #
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_queryString :: Lens' PutQueryDefinition Text Source #
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
putQueryDefinitionResponse_queryDefinitionId :: Lens' PutQueryDefinitionResponse (Maybe Text) Source #
The ID of the query definition.
putQueryDefinitionResponse_httpStatus :: Lens' PutQueryDefinitionResponse Int Source #
The response's http status code.
PutResourcePolicy
putResourcePolicy_policyDocument :: Lens' PutResourcePolicy (Maybe Text) Source #
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_policyName :: Lens' PutResourcePolicy (Maybe Text) Source #
Name of the new policy. This parameter is required.
putResourcePolicyResponse_resourcePolicy :: Lens' PutResourcePolicyResponse (Maybe ResourcePolicy) Source #
The new policy.
putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #
The response's http status code.
PutRetentionPolicy
putRetentionPolicy_logGroupName :: Lens' PutRetentionPolicy Text Source #
The name of the log group.
putRetentionPolicy_retentionInDays :: Lens' PutRetentionPolicy Int Source #
Undocumented member.
PutSubscriptionFilter
putSubscriptionFilter_distribution :: Lens' PutSubscriptionFilter (Maybe Distribution) Source #
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_roleArn :: Lens' PutSubscriptionFilter (Maybe Text) Source #
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_logGroupName :: Lens' PutSubscriptionFilter Text Source #
The name of the log group.
putSubscriptionFilter_filterName :: Lens' PutSubscriptionFilter Text Source #
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_filterPattern :: Lens' PutSubscriptionFilter Text Source #
A filter pattern for subscribing to a filtered stream of log events.
putSubscriptionFilter_destinationArn :: Lens' PutSubscriptionFilter Text Source #
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.
StartQuery
startQuery_limit :: Lens' StartQuery (Maybe Natural) Source #
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.
startQuery_logGroupIdentifiers :: Lens' StartQuery (Maybe [Text]) Source #
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_logGroupName :: Lens' StartQuery (Maybe Text) Source #
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_logGroupNames :: Lens' StartQuery (Maybe [Text]) Source #
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
.
startQuery_startTime :: Lens' StartQuery Natural Source #
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
.
startQuery_endTime :: Lens' StartQuery Natural Source #
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_queryString :: Lens' StartQuery Text Source #
The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
startQueryResponse_queryId :: Lens' StartQueryResponse (Maybe Text) Source #
The unique ID of the query.
startQueryResponse_httpStatus :: Lens' StartQueryResponse Int Source #
The response's http status code.
StopQuery
stopQuery_queryId :: Lens' StopQuery Text Source #
The ID number of the query to stop. To find this ID number, use
DescribeQueries
.
stopQueryResponse_success :: Lens' StopQueryResponse (Maybe Bool) Source #
This is true if the query was stopped by the StopQuery
operation.
stopQueryResponse_httpStatus :: Lens' StopQueryResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
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.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
The list of key-value pairs to associate with the resource.
TestMetricFilter
testMetricFilter_filterPattern :: Lens' TestMetricFilter Text Source #
Undocumented member.
testMetricFilter_logEventMessages :: Lens' TestMetricFilter (NonEmpty Text) Source #
The log event messages to test.
testMetricFilterResponse_matches :: Lens' TestMetricFilterResponse (Maybe [MetricFilterMatchRecord]) Source #
The matched events.
testMetricFilterResponse_httpStatus :: Lens' TestMetricFilterResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
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.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The list of tag keys to remove from the resource.
Types
Destination
destination_accessPolicy :: Lens' Destination (Maybe Text) Source #
An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.
destination_arn :: Lens' Destination (Maybe Text) Source #
The ARN of this destination.
destination_creationTime :: Lens' Destination (Maybe Natural) Source #
The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
destination_destinationName :: Lens' Destination (Maybe Text) Source #
The name of the destination.
destination_roleArn :: Lens' Destination (Maybe Text) Source #
A role for impersonation, used when delivering log events to the target.
destination_targetArn :: Lens' Destination (Maybe Text) Source #
The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).
ExportTask
exportTask_destination :: Lens' ExportTask (Maybe Text) Source #
The name of the S3 bucket to which the log data was exported.
exportTask_destinationPrefix :: Lens' ExportTask (Maybe Text) Source #
The prefix that was used as the start of Amazon S3 key for every object exported.
exportTask_executionInfo :: Lens' ExportTask (Maybe ExportTaskExecutionInfo) Source #
Execution information about the export task.
exportTask_from :: Lens' ExportTask (Maybe Natural) Source #
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.
exportTask_logGroupName :: Lens' ExportTask (Maybe Text) Source #
The name of the log group from which logs data was exported.
exportTask_status :: Lens' ExportTask (Maybe ExportTaskStatus) Source #
The status of the export task.
exportTask_taskId :: Lens' ExportTask (Maybe Text) Source #
The ID of the export task.
exportTask_taskName :: Lens' ExportTask (Maybe Text) Source #
The name of the export task.
exportTask_to :: Lens' ExportTask (Maybe Natural) Source #
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
exportTaskExecutionInfo_completionTime :: Lens' ExportTaskExecutionInfo (Maybe Natural) Source #
The completion time of the export task, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC
.
exportTaskExecutionInfo_creationTime :: Lens' ExportTaskExecutionInfo (Maybe Natural) Source #
The creation time of the export task, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC
.
ExportTaskStatus
exportTaskStatus_code :: Lens' ExportTaskStatus (Maybe ExportTaskStatusCode) Source #
The status code of the export task.
exportTaskStatus_message :: Lens' ExportTaskStatus (Maybe Text) Source #
The status message related to the status code.
FilteredLogEvent
filteredLogEvent_eventId :: Lens' FilteredLogEvent (Maybe Text) Source #
The ID of the event.
filteredLogEvent_ingestionTime :: Lens' FilteredLogEvent (Maybe Natural) Source #
The time the event was ingested, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
filteredLogEvent_logStreamName :: Lens' FilteredLogEvent (Maybe Text) Source #
The name of the log stream to which this event belongs.
filteredLogEvent_message :: Lens' FilteredLogEvent (Maybe Text) Source #
The data contained in the log event.
filteredLogEvent_timestamp :: Lens' FilteredLogEvent (Maybe Natural) Source #
The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
InputLogEvent
inputLogEvent_timestamp :: Lens' InputLogEvent Natural Source #
The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
inputLogEvent_message :: Lens' InputLogEvent Text Source #
The raw event message.
LogGroup
logGroup_arn :: Lens' LogGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the log group.
logGroup_creationTime :: Lens' LogGroup (Maybe Natural) Source #
The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
logGroup_dataProtectionStatus :: Lens' LogGroup (Maybe DataProtectionStatus) Source #
Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see PutDataProtectionPolicy.
logGroup_kmsKeyId :: Lens' LogGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data.
LogGroupField
logGroupField_name :: Lens' LogGroupField (Maybe Text) Source #
The name of a log field.
logGroupField_percent :: Lens' LogGroupField (Maybe Natural) Source #
The percentage of log events queried that contained the field.
LogStream
logStream_arn :: Lens' LogStream (Maybe Text) Source #
The Amazon Resource Name (ARN) of the log stream.
logStream_creationTime :: Lens' LogStream (Maybe Natural) Source #
The creation time of the stream, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
logStream_firstEventTimestamp :: Lens' LogStream (Maybe Natural) Source #
The time of the first event, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
logStream_lastEventTimestamp :: Lens' LogStream (Maybe Natural) Source #
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.
logStream_lastIngestionTime :: Lens' LogStream (Maybe Natural) Source #
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.
logStream_storedBytes :: Lens' LogStream (Maybe Natural) Source #
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.
logStream_uploadSequenceToken :: Lens' LogStream (Maybe Text) Source #
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
metricFilter_creationTime :: Lens' MetricFilter (Maybe Natural) Source #
The creation time of the metric filter, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC
.
metricFilter_filterName :: Lens' MetricFilter (Maybe Text) Source #
The name of the metric filter.
metricFilter_filterPattern :: Lens' MetricFilter (Maybe Text) Source #
Undocumented member.
metricFilter_logGroupName :: Lens' MetricFilter (Maybe Text) Source #
The name of the log group.
metricFilter_metricTransformations :: Lens' MetricFilter (Maybe (NonEmpty MetricTransformation)) Source #
The metric transformations.
MetricFilterMatchRecord
metricFilterMatchRecord_eventMessage :: Lens' MetricFilterMatchRecord (Maybe Text) Source #
The raw event data.
metricFilterMatchRecord_eventNumber :: Lens' MetricFilterMatchRecord (Maybe Integer) Source #
The event number.
metricFilterMatchRecord_extractedValues :: Lens' MetricFilterMatchRecord (Maybe (HashMap Text Text)) Source #
The values extracted from the event data by the filter.
MetricTransformation
metricTransformation_defaultValue :: Lens' MetricTransformation (Maybe Double) Source #
(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
metricTransformation_dimensions :: Lens' MetricTransformation (Maybe (HashMap Text Text)) Source #
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.
metricTransformation_unit :: Lens' MetricTransformation (Maybe StandardUnit) Source #
The unit to assign to the metric. If you omit this, the unit is set as
None
.
metricTransformation_metricName :: Lens' MetricTransformation Text Source #
The name of the CloudWatch metric.
metricTransformation_metricNamespace :: Lens' MetricTransformation Text Source #
A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
metricTransformation_metricValue :: Lens' MetricTransformation Text Source #
The value to publish to the CloudWatch metric when a filter pattern matches a log event.
OutputLogEvent
outputLogEvent_ingestionTime :: Lens' OutputLogEvent (Maybe Natural) Source #
The time the event was ingested, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
outputLogEvent_message :: Lens' OutputLogEvent (Maybe Text) Source #
The data contained in the log event.
outputLogEvent_timestamp :: Lens' OutputLogEvent (Maybe Natural) Source #
The time the event occurred, expressed as the number of milliseconds
after Jan 1, 1970 00:00:00 UTC
.
QueryDefinition
queryDefinition_lastModified :: Lens' QueryDefinition (Maybe Natural) Source #
The date that the query definition was most recently modified.
queryDefinition_logGroupNames :: Lens' QueryDefinition (Maybe [Text]) Source #
If this query definition contains a list of log groups that it is limited to, that list appears here.
queryDefinition_name :: Lens' QueryDefinition (Maybe Text) Source #
The name of the query definition.
queryDefinition_queryDefinitionId :: Lens' QueryDefinition (Maybe Text) Source #
The unique ID of the query definition.
queryDefinition_queryString :: Lens' QueryDefinition (Maybe Text) Source #
The query string to use for this definition. For more information, see CloudWatch Logs Insights Query Syntax.
QueryInfo
queryInfo_createTime :: Lens' QueryInfo (Maybe Natural) Source #
The date and time that this query was created.
queryInfo_logGroupName :: Lens' QueryInfo (Maybe Text) Source #
The name of the log group scanned by this query.
queryInfo_status :: Lens' QueryInfo (Maybe QueryStatus) Source #
The status of this query. Possible values are Cancelled
, Complete
,
Failed
, Running
, Scheduled
, and Unknown
.
QueryStatistics
queryStatistics_bytesScanned :: Lens' QueryStatistics (Maybe Double) Source #
The total number of bytes in the log events scanned during the query.
queryStatistics_recordsMatched :: Lens' QueryStatistics (Maybe Double) Source #
The number of log events that matched the query string.
queryStatistics_recordsScanned :: Lens' QueryStatistics (Maybe Double) Source #
The total number of log events scanned during the query.
RejectedLogEventsInfo
rejectedLogEventsInfo_expiredLogEventEndIndex :: Lens' RejectedLogEventsInfo (Maybe Int) Source #
The expired log events.
rejectedLogEventsInfo_tooNewLogEventStartIndex :: Lens' RejectedLogEventsInfo (Maybe Int) Source #
The log events that are too new.
rejectedLogEventsInfo_tooOldLogEventEndIndex :: Lens' RejectedLogEventsInfo (Maybe Int) Source #
The log events that are dated too far in the past.
ResourcePolicy
resourcePolicy_lastUpdatedTime :: Lens' ResourcePolicy (Maybe Natural) Source #
Timestamp showing when this policy was last updated, expressed as the
number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
resourcePolicy_policyDocument :: Lens' ResourcePolicy (Maybe Text) Source #
The details of the policy.
resourcePolicy_policyName :: Lens' ResourcePolicy (Maybe Text) Source #
The name of the resource policy.
ResultField
resultField_field :: Lens' ResultField (Maybe Text) Source #
The log event field.
resultField_value :: Lens' ResultField (Maybe Text) Source #
The value of this field.
SearchedLogStream
searchedLogStream_logStreamName :: Lens' SearchedLogStream (Maybe Text) Source #
The name of the log stream.
searchedLogStream_searchedCompletely :: Lens' SearchedLogStream (Maybe Bool) Source #
Indicates whether all the events in this log stream were searched.
SubscriptionFilter
subscriptionFilter_creationTime :: Lens' SubscriptionFilter (Maybe Natural) Source #
The creation time of the subscription filter, expressed as the number of
milliseconds after Jan 1, 1970 00:00:00 UTC
.
subscriptionFilter_destinationArn :: Lens' SubscriptionFilter (Maybe Text) Source #
The Amazon Resource Name (ARN) of the destination.
subscriptionFilter_distribution :: Lens' SubscriptionFilter (Maybe Distribution) Source #
Undocumented member.
subscriptionFilter_filterName :: Lens' SubscriptionFilter (Maybe Text) Source #
The name of the subscription filter.
subscriptionFilter_filterPattern :: Lens' SubscriptionFilter (Maybe Text) Source #
Undocumented member.
subscriptionFilter_logGroupName :: Lens' SubscriptionFilter (Maybe Text) Source #
The name of the log group.