Amazonka.Personalize.Types.MetricAttribute

Documentation

data MetricAttribute

Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.

See: newMetricAttribute smart constructor.

Constructors

MetricAttribute'

Fields

• eventType :: Text

  The metric's event type.

• metricName :: Text

  The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

• expression :: Text

  The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

Instances

FromJSON MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

parseJSON :: Value -> Parser MetricAttribute

parseJSONList :: Value -> Parser [MetricAttribute]

ToJSON MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

toJSON :: MetricAttribute -> Value

toEncoding :: MetricAttribute -> Encoding

toJSONList :: [MetricAttribute] -> Value

toEncodingList :: [MetricAttribute] -> Encoding

Generic MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Associated Types

type Rep MetricAttribute :: Type -> Type

Methods

from :: MetricAttribute -> Rep MetricAttribute x

to :: Rep MetricAttribute x -> MetricAttribute

Read MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

readsPrec :: Int -> ReadS MetricAttribute

readList :: ReadS [MetricAttribute]

readPrec :: ReadPrec MetricAttribute

readListPrec :: ReadPrec [MetricAttribute]

Show MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

showsPrec :: Int -> MetricAttribute -> ShowS

show :: MetricAttribute -> String

showList :: [MetricAttribute] -> ShowS

NFData MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

rnf :: MetricAttribute -> ()

Eq MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

(==) :: MetricAttribute -> MetricAttribute -> Bool

(/=) :: MetricAttribute -> MetricAttribute -> Bool

Hashable MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

Methods

hashWithSalt :: Int -> MetricAttribute -> Int

hash :: MetricAttribute -> Int

type Rep MetricAttribute

Defined in Amazonka.Personalize.Types.MetricAttribute

type Rep MetricAttribute = D1 ('MetaData "MetricAttribute" "Amazonka.Personalize.Types.MetricAttribute" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "MetricAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMetricAttribute

Arguments

:: Text

$sel:eventType:MetricAttribute'

-> Text

$sel:metricName:MetricAttribute'

-> Text

$sel:expression:MetricAttribute'

-> MetricAttribute

Create a value of MetricAttribute 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:eventType:MetricAttribute', metricAttribute_eventType - The metric's event type.

$sel:metricName:MetricAttribute', metricAttribute_metricName - The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

$sel:expression:MetricAttribute', metricAttribute_expression - The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

metricAttribute_eventType :: Lens' MetricAttribute Text

The metric's event type.

metricAttribute_metricName :: Lens' MetricAttribute Text

The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

metricAttribute_expression :: Lens' MetricAttribute Text

The attribute's expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).