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.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
- metricName :: Maybe Text
- logGroupName :: Maybe Text
- nextToken :: Maybe Text
- metricNamespace :: Maybe Text
- limit :: Maybe Natural
}
newDescribeMetricFilters :: DescribeMetricFilters
describeMetricFilters_filterNamePrefix :: Lens' DescribeMetricFilters (Maybe Text)
describeMetricFilters_metricName :: Lens' DescribeMetricFilters (Maybe Text)
describeMetricFilters_logGroupName :: Lens' DescribeMetricFilters (Maybe Text)
describeMetricFilters_nextToken :: Lens' DescribeMetricFilters (Maybe Text)
describeMetricFilters_metricNamespace :: Lens' DescribeMetricFilters (Maybe Text)
describeMetricFilters_limit :: Lens' DescribeMetricFilters (Maybe Natural)
data DescribeMetricFiltersResponse = DescribeMetricFiltersResponse' {
- nextToken :: Maybe Text
- metricFilters :: Maybe [MetricFilter]
- httpStatus :: Int
}
newDescribeMetricFiltersResponse :: Int -> DescribeMetricFiltersResponse
describeMetricFiltersResponse_nextToken :: Lens' DescribeMetricFiltersResponse (Maybe Text)
describeMetricFiltersResponse_metricFilters :: Lens' DescribeMetricFiltersResponse (Maybe [MetricFilter])
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 you set here only if you also include the logGroupName parameter in your request.
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.
logGroupName :: Maybe Text
The name of the log group.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
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.
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 DescribeMetricFilters Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters Methods (==) :: DescribeMetricFilters -> DescribeMetricFilters -> Bool # (/=) :: DescribeMetricFilters -> DescribeMetricFilters -> Bool #
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 #
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 #
NFData DescribeMetricFilters Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters Methods rnf :: DescribeMetricFilters -> () #
Hashable DescribeMetricFilters Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters Methods hashWithSalt :: Int -> DescribeMetricFilters -> Int # hash :: DescribeMetricFilters -> Int #
ToJSON DescribeMetricFilters Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters Methods toJSON :: DescribeMetricFilters -> Value # toEncoding :: DescribeMetricFilters -> Encoding # toJSONList :: [DescribeMetricFilters] -> Value # toEncodingList :: [DescribeMetricFilters] -> Encoding #
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 :: DescribeMetricFilters -> Request DescribeMetricFilters # response :: MonadResource m => Logger -> Service -> Proxy DescribeMetricFilters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMetricFilters))) #
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 #
type Rep DescribeMetricFilters Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters type Rep DescribeMetricFilters = D1 ('MetaData "DescribeMetricFilters" "Amazonka.CloudWatchLogs.DescribeMetricFilters" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeMetricFilters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterNamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metricNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse DescribeMetricFilters Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters type AWSResponse DescribeMetricFilters = DescribeMetricFiltersResponse

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 you set here only if you also include the logGroupName parameter in your request.

$sel:metricName: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.

$sel:logGroupName:DescribeMetricFilters', describeMetricFilters_logGroupName - The name of the log group.

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

$sel:metricNamespace: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.

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

Request Lenses

describeMetricFilters_filterNamePrefix :: Lens' DescribeMetricFilters (Maybe Text) Source #

The prefix to match. CloudWatch Logs uses the value you set here only if you also include the logGroupName parameter in your request.

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_logGroupName :: Lens' DescribeMetricFilters (Maybe Text) Source #

The name of the log group.

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

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

Destructuring the Response

data DescribeMetricFiltersResponse Source #

See: newDescribeMetricFiltersResponse smart constructor.

Constructors

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

Instances

Instances details

Eq DescribeMetricFiltersResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters Methods (==) :: DescribeMetricFiltersResponse -> DescribeMetricFiltersResponse -> Bool # (/=) :: DescribeMetricFiltersResponse -> DescribeMetricFiltersResponse -> Bool #
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 #
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 #
NFData DescribeMetricFiltersResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters Methods rnf :: DescribeMetricFiltersResponse -> () #
type Rep DescribeMetricFiltersResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeMetricFilters type Rep DescribeMetricFiltersResponse = D1 ('MetaData "DescribeMetricFiltersResponse" "Amazonka.CloudWatchLogs.DescribeMetricFilters" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeMetricFiltersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metricFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricFilter])) :: 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:nextToken:DescribeMetricFilters', describeMetricFiltersResponse_nextToken - Undocumented member.

$sel:metricFilters:DescribeMetricFiltersResponse', describeMetricFiltersResponse_metricFilters - The metric filters.

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

Response Lenses

describeMetricFiltersResponse_nextToken :: Lens' DescribeMetricFiltersResponse (Maybe Text) Source #

Undocumented member.

describeMetricFiltersResponse_metricFilters :: Lens' DescribeMetricFiltersResponse (Maybe [MetricFilter]) Source #

The metric filters.

describeMetricFiltersResponse_httpStatus :: Lens' DescribeMetricFiltersResponse Int Source #

The response's http status code.