Amazonka.Pi.Types.DimensionKeyDetail

Documentation

data DimensionKeyDetail

An object that describes the details for a specified dimension.

See: newDimensionKeyDetail smart constructor.

Constructors

DimensionKeyDetail'

Fields

• dimension :: Maybe Text

  The full name of the dimension. The full name includes the group name and key name. The following values are valid:

  • db.query.statement (Amazon DocumentDB)
  • db.sql.statement (Amazon RDS and Aurora)
• 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 has the status PROCESSING, Performance Insights returns the truncated query.
  • UNAVAILABLE - The dimension detail data could not be collected successfully.
• value :: Maybe Text

  The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

  • db.query.statement (Amazon DocumentDB)
  • db.sql.statement (Amazon RDS and Aurora)

Instances

FromJSON DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

parseJSON :: Value -> Parser DimensionKeyDetail

parseJSONList :: Value -> Parser [DimensionKeyDetail]

Generic DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Associated Types

type Rep DimensionKeyDetail :: Type -> Type

Methods

from :: DimensionKeyDetail -> Rep DimensionKeyDetail x

to :: Rep DimensionKeyDetail x -> DimensionKeyDetail

Read DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

readsPrec :: Int -> ReadS DimensionKeyDetail

readList :: ReadS [DimensionKeyDetail]

readPrec :: ReadPrec DimensionKeyDetail

readListPrec :: ReadPrec [DimensionKeyDetail]

Show DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

showsPrec :: Int -> DimensionKeyDetail -> ShowS

show :: DimensionKeyDetail -> String

showList :: [DimensionKeyDetail] -> ShowS

NFData DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

rnf :: DimensionKeyDetail -> ()

Eq DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

(==) :: DimensionKeyDetail -> DimensionKeyDetail -> Bool

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

Hashable DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

Methods

hashWithSalt :: Int -> DimensionKeyDetail -> Int

hash :: DimensionKeyDetail -> Int

type Rep DimensionKeyDetail

Defined in Amazonka.Pi.Types.DimensionKeyDetail

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

newDimensionKeyDetail :: DimensionKeyDetail

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:dimension:DimensionKeyDetail', dimensionKeyDetail_dimension - The full name of the dimension. The full name includes the group name and key name. The following values are valid:

• db.query.statement (Amazon DocumentDB)
• db.sql.statement (Amazon RDS and Aurora)

$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 has the status PROCESSING, Performance Insights returns the truncated query.
• UNAVAILABLE - The dimension detail data could not be collected successfully.

$sel:value:DimensionKeyDetail', dimensionKeyDetail_value - The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

• db.query.statement (Amazon DocumentDB)
• db.sql.statement (Amazon RDS and Aurora)

dimensionKeyDetail_dimension :: Lens' DimensionKeyDetail (Maybe Text)

The full name of the dimension. The full name includes the group name and key name. The following values are valid:

• db.query.statement (Amazon DocumentDB)
• db.sql.statement (Amazon RDS and Aurora)

dimensionKeyDetail_status :: Lens' DimensionKeyDetail (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 has the status PROCESSING, Performance Insights returns the truncated query.
• UNAVAILABLE - The dimension detail data could not be collected successfully.

dimensionKeyDetail_value :: Lens' DimensionKeyDetail (Maybe Text)

The value of the dimension detail data. Depending on the return status, this value is either the full or truncated SQL query for the following dimensions:

• db.query.statement (Amazon DocumentDB)
• db.sql.statement (Amazon RDS and Aurora)