amazonka-connect-2.0: Amazon Connect Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Connect.Types.Filters

Description

 
Synopsis

Documentation

data Filters Source #

Contains the filter to apply when retrieving metrics.

See: newFilters smart constructor.

Constructors

Filters' 

Fields

  • channels :: Maybe [Channel]

    The channel to use to filter the metrics.

  • queues :: Maybe (NonEmpty Text)

    The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.

  • routingProfiles :: Maybe (NonEmpty Text)

    A list of up to 100 routing profile IDs or ARNs.

Instances

Instances details
ToJSON Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

Generic Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

Associated Types

type Rep Filters :: Type -> Type #

Methods

from :: Filters -> Rep Filters x #

to :: Rep Filters x -> Filters #

Read Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

Show Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

NFData Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

Methods

rnf :: Filters -> () #

Eq Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

Methods

(==) :: Filters -> Filters -> Bool #

(/=) :: Filters -> Filters -> Bool #

Hashable Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

Methods

hashWithSalt :: Int -> Filters -> Int #

hash :: Filters -> Int #

type Rep Filters Source # 
Instance details

Defined in Amazonka.Connect.Types.Filters

type Rep Filters = D1 ('MetaData "Filters" "Amazonka.Connect.Types.Filters" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "Filters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Channel])) :*: (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "routingProfiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))

newFilters :: Filters Source #

Create a value of Filters 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:channels:Filters', filters_channels - The channel to use to filter the metrics.

$sel:queues:Filters', filters_queues - The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.

$sel:routingProfiles:Filters', filters_routingProfiles - A list of up to 100 routing profile IDs or ARNs.

filters_channels :: Lens' Filters (Maybe [Channel]) Source #

The channel to use to filter the metrics.

filters_queues :: Lens' Filters (Maybe (NonEmpty Text)) Source #

The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.

filters_routingProfiles :: Lens' Filters (Maybe (NonEmpty Text)) Source #

A list of up to 100 routing profile IDs or ARNs.