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

Amazonka.CloudWatchLogs.DescribeMetricFilters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the specified metric filters. You can list all of the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

This operation returns paginated results.

Synopsis

data DescribeMetricFilters = DescribeMetricFilters' {
- filterNamePrefix :: Maybe Text
- limit :: Maybe Natural
- logGroupName :: Maybe Text
- metricName :: Maybe Text
- metricNamespace :: Maybe Text
- nextToken :: Maybe Text
}
newDescribeMetricFilters :: DescribeMetricFilters
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)
data DescribeMetricFiltersResponse = DescribeMetricFiltersResponse' {
- metricFilters :: Maybe [MetricFilter]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeMetricFiltersResponse :: Int -> DescribeMetricFiltersResponse
describeMetricFiltersResponse_metricFilters :: Lens' DescribeMetricFiltersResponse (Maybe [MetricFilter])
describeMetricFiltersResponse_nextToken :: Lens' DescribeMetricFiltersResponse (Maybe Text)
describeMetricFiltersResponse_httpStatus :: Lens' DescribeMetricFiltersResponse Int

Creating a Request

data DescribeMetricFilters Source #

See: newDescribeMetricFilters smart constructor.

Constructors

DescribeMetricFilters'

Fields

filterNamePrefix :: Maybe Text
The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.
limit :: Maybe Natural
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
logGroupName :: Maybe Text
The name of the log group.
metricName :: Maybe Text
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.
metricNamespace :: Maybe Text
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.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)

Instances

Instances details

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

newDescribeMetricFilters :: DescribeMetricFilters Source #

Create a value of DescribeMetricFilters 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:filterNamePrefix:DescribeMetricFilters', describeMetricFilters_filterNamePrefix - The prefix to match. CloudWatch Logs uses the value that you set here only if you also include the logGroupName parameter in your request.

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

DescribeMetricFilters, describeMetricFilters_logGroupName - The name of the log group.

DescribeMetricFilters, describeMetricFilters_metricName - 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, describeMetricFilters_metricNamespace - 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, describeMetricFilters_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

Request Lenses

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

Destructuring the Response

data DescribeMetricFiltersResponse Source #

See: newDescribeMetricFiltersResponse smart constructor.

Constructors

DescribeMetricFiltersResponse'
Fields metricFilters :: Maybe [MetricFilter] The metric filters. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeMetricFiltersResponse Source #

Arguments

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

Create a value of DescribeMetricFiltersResponse 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:metricFilters:DescribeMetricFiltersResponse', describeMetricFiltersResponse_metricFilters - The metric filters.

DescribeMetricFilters, describeMetricFiltersResponse_nextToken - Undocumented member.

$sel:httpStatus:DescribeMetricFiltersResponse', describeMetricFiltersResponse_httpStatus - The response's http status code.

Response Lenses

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.