Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchLogs.DescribeLogStreams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

This operation returns paginated results.

Synopsis

data DescribeLogStreams = DescribeLogStreams' {
- orderBy :: Maybe OrderBy
- descending :: Maybe Bool
- nextToken :: Maybe Text
- logStreamNamePrefix :: Maybe Text
- limit :: Maybe Natural
- logGroupName :: Text
}
newDescribeLogStreams :: Text -> DescribeLogStreams
describeLogStreams_orderBy :: Lens' DescribeLogStreams (Maybe OrderBy)
describeLogStreams_descending :: Lens' DescribeLogStreams (Maybe Bool)
describeLogStreams_nextToken :: Lens' DescribeLogStreams (Maybe Text)
describeLogStreams_logStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text)
describeLogStreams_limit :: Lens' DescribeLogStreams (Maybe Natural)
describeLogStreams_logGroupName :: Lens' DescribeLogStreams Text
data DescribeLogStreamsResponse = DescribeLogStreamsResponse' {
- nextToken :: Maybe Text
- logStreams :: Maybe [LogStream]
- httpStatus :: Int
}
newDescribeLogStreamsResponse :: Int -> DescribeLogStreamsResponse
describeLogStreamsResponse_nextToken :: Lens' DescribeLogStreamsResponse (Maybe Text)
describeLogStreamsResponse_logStreams :: Lens' DescribeLogStreamsResponse (Maybe [LogStream])
describeLogStreamsResponse_httpStatus :: Lens' DescribeLogStreamsResponse Int

Creating a Request

data DescribeLogStreams Source #

See: newDescribeLogStreams smart constructor.

Constructors

DescribeLogStreams'

Fields

orderBy :: Maybe 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.
descending :: Maybe Bool
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.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
logStreamNamePrefix :: Maybe Text
The prefix to match.
If orderBy is LastEventTime, you cannot specify this parameter.
limit :: Maybe Natural
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
logGroupName :: Text
The name of the log group.

Instances

Instances details

Eq DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods (==) :: DescribeLogStreams -> DescribeLogStreams -> Bool # (/=) :: DescribeLogStreams -> DescribeLogStreams -> Bool #
Read DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods readsPrec :: Int -> ReadS DescribeLogStreams # readList :: ReadS [DescribeLogStreams] # readPrec :: ReadPrec DescribeLogStreams # readListPrec :: ReadPrec [DescribeLogStreams] #
Show DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods showsPrec :: Int -> DescribeLogStreams -> ShowS # show :: DescribeLogStreams -> String # showList :: [DescribeLogStreams] -> ShowS #
Generic DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Associated Types type Rep DescribeLogStreams :: Type -> Type # Methods from :: DescribeLogStreams -> Rep DescribeLogStreams x # to :: Rep DescribeLogStreams x -> DescribeLogStreams #
NFData DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods rnf :: DescribeLogStreams -> () #
Hashable DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods hashWithSalt :: Int -> DescribeLogStreams -> Int # hash :: DescribeLogStreams -> Int #
ToJSON DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods toJSON :: DescribeLogStreams -> Value # toEncoding :: DescribeLogStreams -> Encoding # toJSONList :: [DescribeLogStreams] -> Value # toEncodingList :: [DescribeLogStreams] -> Encoding #
AWSPager DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods page :: DescribeLogStreams -> AWSResponse DescribeLogStreams -> Maybe DescribeLogStreams #
AWSRequest DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Associated Types type AWSResponse DescribeLogStreams # Methods request :: DescribeLogStreams -> Request DescribeLogStreams # response :: MonadResource m => Logger -> Service -> Proxy DescribeLogStreams -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeLogStreams))) #
ToHeaders DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods toHeaders :: DescribeLogStreams -> [Header] #
ToPath DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods toPath :: DescribeLogStreams -> ByteString #
ToQuery DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods toQuery :: DescribeLogStreams -> QueryString #
type Rep DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams type Rep DescribeLogStreams = D1 ('MetaData "DescribeLogStreams" "Amazonka.CloudWatchLogs.DescribeLogStreams" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeLogStreams'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "orderBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrderBy)) :: (S1 ('MetaSel ('Just "descending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "logStreamNamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeLogStreams Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams type AWSResponse DescribeLogStreams = DescribeLogStreamsResponse

newDescribeLogStreams Source #

Arguments

:: Text	`$sel:logGroupName:DescribeLogStreams'`
-> DescribeLogStreams

Create a value of DescribeLogStreams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:orderBy:DescribeLogStreams', describeLogStreams_orderBy - If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.

$sel:descending:DescribeLogStreams', describeLogStreams_descending - If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

$sel:nextToken:DescribeLogStreams', describeLogStreams_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:logStreamNamePrefix:DescribeLogStreams', describeLogStreams_logStreamNamePrefix - The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

$sel:limit:DescribeLogStreams', describeLogStreams_limit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

$sel:logGroupName:DescribeLogStreams', describeLogStreams_logGroupName - The name of the log group.

Request Lenses

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_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_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_logStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text) Source #

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

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_logGroupName :: Lens' DescribeLogStreams Text Source #

The name of the log group.

Destructuring the Response

data DescribeLogStreamsResponse Source #

See: newDescribeLogStreamsResponse smart constructor.

Constructors

DescribeLogStreamsResponse'
Fields nextToken :: Maybe Text logStreams :: Maybe [LogStream] The log streams. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeLogStreamsResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods (==) :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool # (/=) :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool #
Read DescribeLogStreamsResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods readsPrec :: Int -> ReadS DescribeLogStreamsResponse # readList :: ReadS [DescribeLogStreamsResponse] # readPrec :: ReadPrec DescribeLogStreamsResponse # readListPrec :: ReadPrec [DescribeLogStreamsResponse] #
Show DescribeLogStreamsResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods showsPrec :: Int -> DescribeLogStreamsResponse -> ShowS # show :: DescribeLogStreamsResponse -> String # showList :: [DescribeLogStreamsResponse] -> ShowS #
Generic DescribeLogStreamsResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Associated Types type Rep DescribeLogStreamsResponse :: Type -> Type # Methods from :: DescribeLogStreamsResponse -> Rep DescribeLogStreamsResponse x # to :: Rep DescribeLogStreamsResponse x -> DescribeLogStreamsResponse #
NFData DescribeLogStreamsResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams Methods rnf :: DescribeLogStreamsResponse -> () #
type Rep DescribeLogStreamsResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeLogStreams type Rep DescribeLogStreamsResponse = D1 ('MetaData "DescribeLogStreamsResponse" "Amazonka.CloudWatchLogs.DescribeLogStreams" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeLogStreamsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "logStreams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LogStream])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeLogStreamsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeLogStreamsResponse'`
-> DescribeLogStreamsResponse

Create a value of DescribeLogStreamsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeLogStreams', describeLogStreamsResponse_nextToken - Undocumented member.

$sel:logStreams:DescribeLogStreamsResponse', describeLogStreamsResponse_logStreams - The log streams.

$sel:httpStatus:DescribeLogStreamsResponse', describeLogStreamsResponse_httpStatus - The response's http status code.

Response Lenses

describeLogStreamsResponse_nextToken :: Lens' DescribeLogStreamsResponse (Maybe Text) Source #

Undocumented member.

describeLogStreamsResponse_logStreams :: Lens' DescribeLogStreamsResponse (Maybe [LogStream]) Source #

The log streams.

describeLogStreamsResponse_httpStatus :: Lens' DescribeLogStreamsResponse Int Source #

The response's http status code.