Amazonka.Pi.Types.DimensionKeyDescription

Documentation

data DimensionKeyDescription

An object that includes the requested dimension key values and aggregated metric values within a dimension group.

See: newDimensionKeyDescription smart constructor.

Constructors

DimensionKeyDescription'

Fields

• additionalMetrics :: Maybe (HashMap Text Double)

  A map that contains the value for each additional metric.

• dimensions :: Maybe (HashMap Text Text)

  A map of name-value pairs for the dimensions in the group.

• partitions :: Maybe [Double]

  If PartitionBy was specified, PartitionKeys contains the dimensions that were.

• total :: Maybe Double

  The aggregated metric value for the dimensions, over the requested time range.

Instances

FromJSON DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

parseJSON :: Value -> Parser DimensionKeyDescription

parseJSONList :: Value -> Parser [DimensionKeyDescription]

Generic DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Associated Types

type Rep DimensionKeyDescription :: Type -> Type

Methods

from :: DimensionKeyDescription -> Rep DimensionKeyDescription x

to :: Rep DimensionKeyDescription x -> DimensionKeyDescription

Read DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

readsPrec :: Int -> ReadS DimensionKeyDescription

readList :: ReadS [DimensionKeyDescription]

readPrec :: ReadPrec DimensionKeyDescription

readListPrec :: ReadPrec [DimensionKeyDescription]

Show DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

showsPrec :: Int -> DimensionKeyDescription -> ShowS

show :: DimensionKeyDescription -> String

showList :: [DimensionKeyDescription] -> ShowS

NFData DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

rnf :: DimensionKeyDescription -> ()

Eq DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

(==) :: DimensionKeyDescription -> DimensionKeyDescription -> Bool

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

Hashable DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

Methods

hashWithSalt :: Int -> DimensionKeyDescription -> Int

hash :: DimensionKeyDescription -> Int

type Rep DimensionKeyDescription

Defined in Amazonka.Pi.Types.DimensionKeyDescription

type Rep DimensionKeyDescription = D1 ('MetaData "DimensionKeyDescription" "Amazonka.Pi.Types.DimensionKeyDescription" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "DimensionKeyDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double))) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "partitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Double])) :*: S1 ('MetaSel ('Just "total") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newDimensionKeyDescription :: DimensionKeyDescription

Create a value of DimensionKeyDescription 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:additionalMetrics:DimensionKeyDescription', dimensionKeyDescription_additionalMetrics - A map that contains the value for each additional metric.

$sel:dimensions:DimensionKeyDescription', dimensionKeyDescription_dimensions - A map of name-value pairs for the dimensions in the group.

$sel:partitions:DimensionKeyDescription', dimensionKeyDescription_partitions - If PartitionBy was specified, PartitionKeys contains the dimensions that were.

$sel:total:DimensionKeyDescription', dimensionKeyDescription_total - The aggregated metric value for the dimensions, over the requested time range.

dimensionKeyDescription_additionalMetrics :: Lens' DimensionKeyDescription (Maybe (HashMap Text Double))

A map that contains the value for each additional metric.

dimensionKeyDescription_dimensions :: Lens' DimensionKeyDescription (Maybe (HashMap Text Text))

A map of name-value pairs for the dimensions in the group.

dimensionKeyDescription_partitions :: Lens' DimensionKeyDescription (Maybe [Double])

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

dimensionKeyDescription_total :: Lens' DimensionKeyDescription (Maybe Double)

The aggregated metric value for the dimensions, over the requested time range.