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.DescribeLogGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn’t support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

This operation returns paginated results.

Creating a Request

data DescribeLogGroups Source #

See: newDescribeLogGroups smart constructor.

Constructors

DescribeLogGroups'
Fields logGroupNamePrefix :: Maybe Text The prefix to match. nextToken :: Maybe Text The token for the next set of items to return. (You received this token from a previous call.) limit :: Maybe Natural The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Instances

Instances details

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

newDescribeLogGroups :: DescribeLogGroups Source #

Create a value of DescribeLogGroups with all optional fields omitted.

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

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

$sel:logGroupNamePrefix:DescribeLogGroups', describeLogGroups_logGroupNamePrefix - The prefix to match.

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

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

Request Lenses

describeLogGroups_logGroupNamePrefix :: Lens' DescribeLogGroups (Maybe Text) Source #

The prefix to match.

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.)

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.

Destructuring the Response

data DescribeLogGroupsResponse Source #

See: newDescribeLogGroupsResponse smart constructor.

Constructors

DescribeLogGroupsResponse'
Fields logGroups :: Maybe [LogGroup] The log groups. If the `retentionInDays` value if not included for a log group, then that log group is set to have its events never expire. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeLogGroupsResponse Source #

Arguments

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

Create a value of DescribeLogGroupsResponse with all optional fields omitted.

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

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

$sel:logGroups:DescribeLogGroupsResponse', describeLogGroupsResponse_logGroups - The log groups.

If the retentionInDays value if not included for a log group, then that log group is set to have its events never expire.

$sel:nextToken:DescribeLogGroups', describeLogGroupsResponse_nextToken - Undocumented member.

$sel:httpStatus:DescribeLogGroupsResponse', describeLogGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeLogGroupsResponse_logGroups :: Lens' DescribeLogGroupsResponse (Maybe [LogGroup]) Source #

The log groups.

If the retentionInDays value if not included for a log group, then that log group is set to have its events never expire.

describeLogGroupsResponse_nextToken :: Lens' DescribeLogGroupsResponse (Maybe Text) Source #

Undocumented member.

describeLogGroupsResponse_httpStatus :: Lens' DescribeLogGroupsResponse Int Source #

The response's http status code.