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 |
Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.
This operation has a limit of five transactions per second, after which transactions are throttled.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.
This operation returns paginated results.
Synopsis
- data DescribeLogStreams = DescribeLogStreams' {}
- newDescribeLogStreams :: Text -> DescribeLogStreams
- 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
- data DescribeLogStreamsResponse = DescribeLogStreamsResponse' {
- logStreams :: Maybe [LogStream]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeLogStreamsResponse :: Int -> DescribeLogStreamsResponse
- describeLogStreamsResponse_logStreams :: Lens' DescribeLogStreamsResponse (Maybe [LogStream])
- describeLogStreamsResponse_nextToken :: Lens' DescribeLogStreamsResponse (Maybe Text)
- describeLogStreamsResponse_httpStatus :: Lens' DescribeLogStreamsResponse Int
Creating a Request
data DescribeLogStreams Source #
See: newDescribeLogStreams
smart constructor.
DescribeLogStreams' | |
|
Instances
newDescribeLogStreams Source #
Create a value of DescribeLogStreams
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:descending:DescribeLogStreams'
, describeLogStreams_descending
- If the value is true, results are returned in descending order. If the
value is to false, results are returned in ascending order. The default
value is false.
$sel:limit:DescribeLogStreams'
, describeLogStreams_limit
- The maximum number of items returned. If you don't specify a value, the
default is up to 50 items.
$sel:logGroupIdentifier:DescribeLogStreams'
, describeLogStreams_logGroupIdentifier
- Specify either the name or ARN of the log group to view. If the log
group is in a source account and you are using a monitoring account, you
must use the log group ARN.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
$sel:logStreamNamePrefix:DescribeLogStreams'
, describeLogStreams_logStreamNamePrefix
- The prefix to match.
If orderBy
is LastEventTime
, you cannot specify this parameter.
DescribeLogStreams
, describeLogStreams_nextToken
- The token for the next set of items to return. (You received this token
from a previous call.)
$sel:orderBy:DescribeLogStreams'
, describeLogStreams_orderBy
- If the value is LogStreamName
, the results are ordered by log stream
name. If the value is LastEventTime
, the results are ordered by the
event time. The default value is LogStreamName
.
If you order the results by event time, you cannot specify the
logStreamNamePrefix
parameter.
lastEventTimestamp
represents the time of the most recent log event in
the log stream in CloudWatch Logs. This number is expressed as the
number of milliseconds after Jan 1, 1970 00:00:00 UTC
.
lastEventTimestamp
updates on an eventual consistency basis. It
typically updates in less than an hour from ingestion, but in rare
situations might take longer.
DescribeLogStreams
, describeLogStreams_logGroupName
- The name of the log group.
If you specify values for both logGroupName
and logGroupIdentifier
,
the action returns an InvalidParameterException
error.
Request Lenses
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.
Destructuring the Response
data DescribeLogStreamsResponse Source #
See: newDescribeLogStreamsResponse
smart constructor.
DescribeLogStreamsResponse' | |
|
Instances
newDescribeLogStreamsResponse Source #
Create a value of DescribeLogStreamsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logStreams:DescribeLogStreamsResponse'
, describeLogStreamsResponse_logStreams
- The log streams.
DescribeLogStreams
, describeLogStreamsResponse_nextToken
- Undocumented member.
$sel:httpStatus:DescribeLogStreamsResponse'
, describeLogStreamsResponse_httpStatus
- The response's http status code.
Response Lenses
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.