libZSservicesZSamazonka-piZSamazonka-pi
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pi.Types.DimensionKeyDetail

Description

 
Synopsis

Documentation

data DimensionKeyDetail Source #

An object that describes the details for a specified dimension.

See: newDimensionKeyDetail smart constructor.

Constructors

DimensionKeyDetail' 

Fields

  • status :: Maybe DetailStatus

    The status of the dimension detail data. Possible values include the following:

    • AVAILABLE - The dimension detail data is ready to be retrieved.
    • PROCESSING - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data for db.sql.statement has the status PROCESSING, Performance Insights returns the truncated query.
    • UNAVAILABLE - The dimension detail data could not be collected successfully.
  • dimension :: Maybe Text

    The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement.

  • value :: Maybe Text

    The value of the dimension detail data. For the db.sql.statement dimension, this value is either the full or truncated SQL query, depending on the return status.

Instances

Instances details
Eq DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Read DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Show DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Generic DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Associated Types

type Rep DimensionKeyDetail :: Type -> Type #

NFData DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

rnf :: DimensionKeyDetail -> () #

Hashable DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

FromJSON DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

type Rep DimensionKeyDetail Source # 
Instance details

Defined in Amazonka.Pi.Types.DimensionKeyDetail

type Rep DimensionKeyDetail = D1 ('MetaData "DimensionKeyDetail" "Amazonka.Pi.Types.DimensionKeyDetail" "libZSservicesZSamazonka-piZSamazonka-pi" 'False) (C1 ('MetaCons "DimensionKeyDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetailStatus)) :*: (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDimensionKeyDetail :: DimensionKeyDetail Source #

Create a value of DimensionKeyDetail 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:status:DimensionKeyDetail', dimensionKeyDetail_status - The status of the dimension detail data. Possible values include the following:

  • AVAILABLE - The dimension detail data is ready to be retrieved.
  • PROCESSING - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data for db.sql.statement has the status PROCESSING, Performance Insights returns the truncated query.
  • UNAVAILABLE - The dimension detail data could not be collected successfully.

$sel:dimension:DimensionKeyDetail', dimensionKeyDetail_dimension - The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement.

$sel:value:DimensionKeyDetail', dimensionKeyDetail_value - The value of the dimension detail data. For the db.sql.statement dimension, this value is either the full or truncated SQL query, depending on the return status.

dimensionKeyDetail_status :: Lens' DimensionKeyDetail (Maybe DetailStatus) Source #

The status of the dimension detail data. Possible values include the following:

  • AVAILABLE - The dimension detail data is ready to be retrieved.
  • PROCESSING - The dimension detail data isn't ready to be retrieved because more processing time is required. If the requested detail data for db.sql.statement has the status PROCESSING, Performance Insights returns the truncated query.
  • UNAVAILABLE - The dimension detail data could not be collected successfully.

dimensionKeyDetail_dimension :: Lens' DimensionKeyDetail (Maybe Text) Source #

The full name of the dimension. The full name includes the group name and key name. The only valid value is db.sql.statement.

dimensionKeyDetail_value :: Lens' DimensionKeyDetail (Maybe Text) Source #

The value of the dimension detail data. For the db.sql.statement dimension, this value is either the full or truncated SQL query, depending on the return status.