diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ ## Description -Amazon CloudWatch Logs enables you to monitor, store, and access your system, application, and custom log files. + Amazon CloudWatch Logs enables you to monitor, store, and access your system, + application, and custom log files. Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-cloudwatch-logs) and [AWS API Reference](http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/Welcome.html). diff --git a/amazonka-cloudwatch-logs.cabal b/amazonka-cloudwatch-logs.cabal --- a/amazonka-cloudwatch-logs.cabal +++ b/amazonka-cloudwatch-logs.cabal @@ -1,5 +1,5 @@ name: amazonka-cloudwatch-logs -version: 0.0.1 +version: 0.0.2 synopsis: Amazon CloudWatch Logs SDK. homepage: https://github.com/brendanhay/amazonka license: OtherLicense @@ -13,8 +13,8 @@ cabal-version: >= 1.10 description: - Amazon CloudWatch Logs enables you to monitor, store, and access your - system, application, and custom log files. + Amazon CloudWatch Logs enables you to monitor, store, and access your system, + application, and custom log files. . /See:/ . @@ -52,5 +52,5 @@ other-modules: build-depends: - amazonka-core == 0.0.1.* + amazonka-core == 0.0.2.* , base >= 4.7 && < 5 diff --git a/gen/Network/AWS/CloudWatchLogs.hs b/gen/Network/AWS/CloudWatchLogs.hs --- a/gen/Network/AWS/CloudWatchLogs.hs +++ b/gen/Network/AWS/CloudWatchLogs.hs @@ -8,8 +8,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Amazon CloudWatch Logs enables you to monitor, store, and access your --- system, application, and custom log files. +-- | Amazon CloudWatch Logs enables you to monitor, store, and access your system, +-- application, and custom log files. module Network.AWS.CloudWatchLogs ( module Network.AWS.CloudWatchLogs.CreateLogGroup , module Network.AWS.CloudWatchLogs.CreateLogStream diff --git a/gen/Network/AWS/CloudWatchLogs/CreateLogGroup.hs b/gen/Network/AWS/CloudWatchLogs/CreateLogGroup.hs --- a/gen/Network/AWS/CloudWatchLogs/CreateLogGroup.hs +++ b/gen/Network/AWS/CloudWatchLogs/CreateLogGroup.hs @@ -22,10 +22,12 @@ -- | Creates a new log group with the specified name. The name of the log group -- must be unique within a region for an AWS account. You can create up to 500 --- log groups per account. You must use the following guidelines when naming a --- log group: Log group names can be between 1 and 512 characters long. --- Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' --- (forward slash), and '.' (period). +-- log groups per account. +-- +-- You must use the following guidelines when naming a log group: Log group +-- names can be between 1 and 512 characters long. Allowed characters are a-z, +-- A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' +-- (period). -- -- module Network.AWS.CloudWatchLogs.CreateLogGroup diff --git a/gen/Network/AWS/CloudWatchLogs/CreateLogStream.hs b/gen/Network/AWS/CloudWatchLogs/CreateLogStream.hs --- a/gen/Network/AWS/CloudWatchLogs/CreateLogStream.hs +++ b/gen/Network/AWS/CloudWatchLogs/CreateLogStream.hs @@ -22,9 +22,11 @@ -- | Creates a new log stream in the specified log group. The name of the log -- stream must be unique within the log group. There is no limit on the number --- of log streams that can exist in a log group. You must use the following --- guidelines when naming a log stream: Log stream names can be between 1 and --- 512 characters long. The ':' colon character is not allowed. +-- of log streams that can exist in a log group. +-- +-- You must use the following guidelines when naming a log stream: Log stream +-- names can be between 1 and 512 characters long. The ':' colon character is +-- not allowed. -- -- module Network.AWS.CloudWatchLogs.CreateLogStream diff --git a/gen/Network/AWS/CloudWatchLogs/DescribeLogGroups.hs b/gen/Network/AWS/CloudWatchLogs/DescribeLogGroups.hs --- a/gen/Network/AWS/CloudWatchLogs/DescribeLogGroups.hs +++ b/gen/Network/AWS/CloudWatchLogs/DescribeLogGroups.hs @@ -22,11 +22,13 @@ -- | Returns all the log groups that are associated with the AWS account making -- the request. The list returned in the response is ASCII-sorted by log group --- name. By default, this operation returns up to 50 log groups. If there are --- more log groups to list, the response would contain a nextToken value in --- the response body. You can also limit the number of log groups returned in --- the response by specifying the limit parameter in the request. +-- name. -- +-- By default, this operation returns up to 50 log groups. If there are more +-- log groups to list, the response would contain a 'nextToken' value in the +-- response body. You can also limit the number of log groups returned in the +-- response by specifying the 'limit' parameter in the request. +-- -- module Network.AWS.CloudWatchLogs.DescribeLogGroups ( @@ -76,8 +78,8 @@ , _dlgLimit = Nothing } --- | The maximum number of items returned in the response. If you don't --- specify a value, the request would return up to 50 items. +-- | The maximum number of items returned in the response. If you don't specify a +-- value, the request would return up to 50 items. dlgLimit :: Lens' DescribeLogGroups (Maybe Natural) dlgLimit = lens _dlgLimit (\s a -> s { _dlgLimit = a }) . mapping _Nat @@ -85,9 +87,8 @@ dlgLogGroupNamePrefix = lens _dlgLogGroupNamePrefix (\s a -> s { _dlgLogGroupNamePrefix = a }) --- | A string token used for pagination that points to the next page of --- results. It must be a value obtained from the response of the previous --- DescribeLogGroups request. +-- | A string token used for pagination that points to the next page of results. +-- It must be a value obtained from the response of the previous 'DescribeLogGroups' request. dlgNextToken :: Lens' DescribeLogGroups (Maybe Text) dlgNextToken = lens _dlgNextToken (\s a -> s { _dlgNextToken = a }) diff --git a/gen/Network/AWS/CloudWatchLogs/DescribeLogStreams.hs b/gen/Network/AWS/CloudWatchLogs/DescribeLogStreams.hs --- a/gen/Network/AWS/CloudWatchLogs/DescribeLogStreams.hs +++ b/gen/Network/AWS/CloudWatchLogs/DescribeLogStreams.hs @@ -21,12 +21,13 @@ -- Portability : non-portable (GHC extensions) -- | Returns all the log streams that are associated with the specified log --- group. The list returned in the response is ASCII-sorted by log stream --- name. By default, this operation returns up to 50 log streams. If there are --- more log streams to list, the response would contain a nextToken value in --- the response body. You can also limit the number of log streams returned in --- the response by specifying the limit parameter in the request. +-- group. The list returned in the response is ASCII-sorted by log stream name. -- +-- By default, this operation returns up to 50 log streams. If there are more +-- log streams to list, the response would contain a 'nextToken' value in the +-- response body. You can also limit the number of log streams returned in the +-- response by specifying the 'limit' parameter in the request. +-- -- module Network.AWS.CloudWatchLogs.DescribeLogStreams ( @@ -82,8 +83,8 @@ , _dls1Limit = Nothing } --- | The maximum number of items returned in the response. If you don't --- specify a value, the request would return up to 50 items. +-- | The maximum number of items returned in the response. If you don't specify a +-- value, the request would return up to 50 items. dls1Limit :: Lens' DescribeLogStreams (Maybe Natural) dls1Limit = lens _dls1Limit (\s a -> s { _dls1Limit = a }) . mapping _Nat @@ -94,9 +95,8 @@ dls1LogStreamNamePrefix = lens _dls1LogStreamNamePrefix (\s a -> s { _dls1LogStreamNamePrefix = a }) --- | A string token used for pagination that points to the next page of --- results. It must be a value obtained from the response of the previous --- DescribeLogStreams request. +-- | A string token used for pagination that points to the next page of results. +-- It must be a value obtained from the response of the previous 'DescribeLogStreams' request. dls1NextToken :: Lens' DescribeLogStreams (Maybe Text) dls1NextToken = lens _dls1NextToken (\s a -> s { _dls1NextToken = a }) diff --git a/gen/Network/AWS/CloudWatchLogs/DescribeMetricFilters.hs b/gen/Network/AWS/CloudWatchLogs/DescribeMetricFilters.hs --- a/gen/Network/AWS/CloudWatchLogs/DescribeMetricFilters.hs +++ b/gen/Network/AWS/CloudWatchLogs/DescribeMetricFilters.hs @@ -20,13 +20,14 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Returns all the metrics filters associated with the specified log group. --- The list returned in the response is ASCII-sorted by filter name. By --- default, this operation returns up to 50 metric filters. If there are more --- metric filters to list, the response would contain a nextToken value in the --- response body. You can also limit the number of metric filters returned in --- the response by specifying the limit parameter in the request. +-- | Returns all the metrics filters associated with the specified log group. The +-- list returned in the response is ASCII-sorted by filter name. -- +-- By default, this operation returns up to 50 metric filters. If there are +-- more metric filters to list, the response would contain a 'nextToken' value in +-- the response body. You can also limit the number of metric filters returned +-- in the response by specifying the 'limit' parameter in the request. +-- -- module Network.AWS.CloudWatchLogs.DescribeMetricFilters ( @@ -86,17 +87,16 @@ dmfFilterNamePrefix = lens _dmfFilterNamePrefix (\s a -> s { _dmfFilterNamePrefix = a }) --- | The maximum number of items returned in the response. If you don't --- specify a value, the request would return up to 50 items. +-- | The maximum number of items returned in the response. If you don't specify a +-- value, the request would return up to 50 items. dmfLimit :: Lens' DescribeMetricFilters (Maybe Natural) dmfLimit = lens _dmfLimit (\s a -> s { _dmfLimit = a }) . mapping _Nat dmfLogGroupName :: Lens' DescribeMetricFilters Text dmfLogGroupName = lens _dmfLogGroupName (\s a -> s { _dmfLogGroupName = a }) --- | A string token used for pagination that points to the next page of --- results. It must be a value obtained from the response of the previous --- DescribeMetricFilters request. +-- | A string token used for pagination that points to the next page of results. +-- It must be a value obtained from the response of the previous 'DescribeMetricFilters' request. dmfNextToken :: Lens' DescribeMetricFilters (Maybe Text) dmfNextToken = lens _dmfNextToken (\s a -> s { _dmfNextToken = a }) diff --git a/gen/Network/AWS/CloudWatchLogs/GetLogEvents.hs b/gen/Network/AWS/CloudWatchLogs/GetLogEvents.hs --- a/gen/Network/AWS/CloudWatchLogs/GetLogEvents.hs +++ b/gen/Network/AWS/CloudWatchLogs/GetLogEvents.hs @@ -21,13 +21,14 @@ -- Portability : non-portable (GHC extensions) -- | Retrieves log events from the specified log stream. You can provide an --- optional time range to filter the results on the event timestamp. By --- default, this operation returns as much log events as can fit in a response --- size of 1MB, up to 10,000 log events. The response will always include a --- nextForwardToken and a nextBackwardToken in the response body. You can use --- any of these tokens in subsequent GetLogEvents requests to paginate through --- events in either forward or backward direction. You can also limit the --- number of log events returned in the response by specifying the limit +-- optional time range to filter the results on the event 'timestamp'. +-- +-- By default, this operation returns as much log events as can fit in a +-- response size of 1MB, up to 10,000 log events. The response will always +-- include a 'nextForwardToken' and a 'nextBackwardToken' in the response body. You +-- can use any of these tokens in subsequent 'GetLogEvents' requests to paginate +-- through events in either forward or backward direction. You can also limit +-- the number of log events returned in the response by specifying the 'limit' -- parameter in the request. -- -- @@ -106,8 +107,8 @@ gleEndTime = lens _gleEndTime (\s a -> s { _gleEndTime = a }) . mapping _Nat -- | The maximum number of log events returned in the response. If you don't --- specify a value, the request would return as much log events as can fit --- in a response size of 1MB, up to 10,000 log events. +-- specify a value, the request would return as much log events as can fit in a +-- response size of 1MB, up to 10,000 log events. gleLimit :: Lens' GetLogEvents (Maybe Natural) gleLimit = lens _gleLimit (\s a -> s { _gleLimit = a }) . mapping _Nat @@ -117,15 +118,14 @@ gleLogStreamName :: Lens' GetLogEvents Text gleLogStreamName = lens _gleLogStreamName (\s a -> s { _gleLogStreamName = a }) --- | A string token used for pagination that points to the next page of --- results. It must be a value obtained from the nextForwardToken or --- nextBackwardToken fields in the response of the previous GetLogEvents --- request. +-- | A string token used for pagination that points to the next page of results. +-- It must be a value obtained from the 'nextForwardToken' or 'nextBackwardToken' +-- fields in the response of the previous 'GetLogEvents' request. gleNextToken :: Lens' GetLogEvents (Maybe Text) gleNextToken = lens _gleNextToken (\s a -> s { _gleNextToken = a }) --- | If set to true, the earliest log events would be returned first. The --- default is false (the latest log events are returned first). +-- | If set to true, the earliest log events would be returned first. The default +-- is false (the latest log events are returned first). gleStartFromHead :: Lens' GetLogEvents (Maybe Bool) gleStartFromHead = lens _gleStartFromHead (\s a -> s { _gleStartFromHead = a }) diff --git a/gen/Network/AWS/CloudWatchLogs/PutLogEvents.hs b/gen/Network/AWS/CloudWatchLogs/PutLogEvents.hs --- a/gen/Network/AWS/CloudWatchLogs/PutLogEvents.hs +++ b/gen/Network/AWS/CloudWatchLogs/PutLogEvents.hs @@ -20,18 +20,20 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Uploads a batch of log events to the specified log stream. Every --- PutLogEvents request must include the sequenceToken obtained from the +-- | Uploads a batch of log events to the specified log stream. +-- +-- Every PutLogEvents request must include the 'sequenceToken' obtained from the -- response of the previous request. An upload in a newly created log stream --- does not require a sequenceToken. The batch of events must satisfy the --- following constraints: The maximum batch size is 32,768 bytes, and this --- size is calculated as the sum of all event messages in UTF-8, plus 26 bytes --- for each log event. None of the log events in the batch can be more than 2 --- hours in the future. None of the log events in the batch can be older than --- 14 days or the retention period of the log group. The log events in the --- batch must be in chronological ordered by their timestamp. The maximum --- number of log events in a batch is 1,000. +-- does not require a 'sequenceToken'. -- +-- The batch of events must satisfy the following constraints: The maximum +-- batch size is 32,768 bytes, and this size is calculated as the sum of all +-- event messages in UTF-8, plus 26 bytes for each log event. None of the log +-- events in the batch can be more than 2 hours in the future. None of the log +-- events in the batch can be older than 14 days or the retention period of the +-- log group. The log events in the batch must be in chronological ordered by +-- their 'timestamp'. The maximum number of log events in a batch is 1,000. +-- -- module Network.AWS.CloudWatchLogs.PutLogEvents ( @@ -97,8 +99,7 @@ pleLogStreamName :: Lens' PutLogEvents Text pleLogStreamName = lens _pleLogStreamName (\s a -> s { _pleLogStreamName = a }) --- | A string token that must be obtained from the response of the previous --- PutLogEvents request. +-- | A string token that must be obtained from the response of the previous 'PutLogEvents' request. pleSequenceToken :: Lens' PutLogEvents (Maybe Text) pleSequenceToken = lens _pleSequenceToken (\s a -> s { _pleSequenceToken = a }) diff --git a/gen/Network/AWS/CloudWatchLogs/PutMetricFilter.hs b/gen/Network/AWS/CloudWatchLogs/PutMetricFilter.hs --- a/gen/Network/AWS/CloudWatchLogs/PutMetricFilter.hs +++ b/gen/Network/AWS/CloudWatchLogs/PutMetricFilter.hs @@ -22,7 +22,7 @@ -- | Creates or updates a metric filter and associates it with the specified log -- group. Metric filters allow you to configure rules to extract metric data --- from log events ingested through PutLogEvents requests. +-- from log events ingested through 'PutLogEvents' requests. -- -- module Network.AWS.CloudWatchLogs.PutMetricFilter diff --git a/gen/Network/AWS/CloudWatchLogs/PutRetentionPolicy.hs b/gen/Network/AWS/CloudWatchLogs/PutRetentionPolicy.hs --- a/gen/Network/AWS/CloudWatchLogs/PutRetentionPolicy.hs +++ b/gen/Network/AWS/CloudWatchLogs/PutRetentionPolicy.hs @@ -20,8 +20,8 @@ -- Stability : experimental -- Portability : non-portable (GHC extensions) --- | Sets the retention of the specified log group. A retention policy allows --- you to configure the number of days you want to retain log events in the +-- | Sets the retention of the specified log group. A retention policy allows you +-- to configure the number of days you want to retain log events in the -- specified log group. -- -- diff --git a/gen/Network/AWS/CloudWatchLogs/TestMetricFilter.hs b/gen/Network/AWS/CloudWatchLogs/TestMetricFilter.hs --- a/gen/Network/AWS/CloudWatchLogs/TestMetricFilter.hs +++ b/gen/Network/AWS/CloudWatchLogs/TestMetricFilter.hs @@ -21,8 +21,8 @@ -- Portability : non-portable (GHC extensions) -- | Tests the filter pattern of a metric filter against a sample of log event --- messages. You can use this operation to validate the correctness of a --- metric filter pattern. +-- messages. You can use this operation to validate the correctness of a metric +-- filter pattern. -- -- module Network.AWS.CloudWatchLogs.TestMetricFilter