Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pi.GetDimensionKeyDetails

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

Synopsis

Creating a Request

data GetDimensionKeyDetails Source #

See: newGetDimensionKeyDetails smart constructor.

Constructors

GetDimensionKeyDetails'

Fields

requestedDimensions :: Maybe (NonEmpty Text)
A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:
- db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).
- db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).
serviceType :: ServiceType
The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
identifier :: Text
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
group' :: Text
The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:
- db.query (Amazon DocumentDB only)
- db.sql (Amazon RDS and Aurora only)
groupIdentifier :: Text
The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:
- db.sql.id for dimension group db.sql (Aurora and RDS only)
- db.query.id for dimension group db.query (DocumentDB only)

Instances

Instances details

ToJSON GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods toJSON :: GetDimensionKeyDetails -> Value # toEncoding :: GetDimensionKeyDetails -> Encoding # toJSONList :: [GetDimensionKeyDetails] -> Value # toEncodingList :: [GetDimensionKeyDetails] -> Encoding #
ToHeaders GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods toHeaders :: GetDimensionKeyDetails -> [Header] #
ToPath GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods toPath :: GetDimensionKeyDetails -> ByteString #
ToQuery GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods toQuery :: GetDimensionKeyDetails -> QueryString #
AWSRequest GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Associated Types type AWSResponse GetDimensionKeyDetails # Methods request :: (Service -> Service) -> GetDimensionKeyDetails -> Request GetDimensionKeyDetails # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDimensionKeyDetails -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDimensionKeyDetails))) #
Generic GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Associated Types type Rep GetDimensionKeyDetails :: Type -> Type # Methods from :: GetDimensionKeyDetails -> Rep GetDimensionKeyDetails x # to :: Rep GetDimensionKeyDetails x -> GetDimensionKeyDetails #
Read GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods readsPrec :: Int -> ReadS GetDimensionKeyDetails # readList :: ReadS [GetDimensionKeyDetails] # readPrec :: ReadPrec GetDimensionKeyDetails # readListPrec :: ReadPrec [GetDimensionKeyDetails] #
Show GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods showsPrec :: Int -> GetDimensionKeyDetails -> ShowS # show :: GetDimensionKeyDetails -> String # showList :: [GetDimensionKeyDetails] -> ShowS #
NFData GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods rnf :: GetDimensionKeyDetails -> () #
Eq GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods (==) :: GetDimensionKeyDetails -> GetDimensionKeyDetails -> Bool # (/=) :: GetDimensionKeyDetails -> GetDimensionKeyDetails -> Bool #
Hashable GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods hashWithSalt :: Int -> GetDimensionKeyDetails -> Int # hash :: GetDimensionKeyDetails -> Int #
type AWSResponse GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails type AWSResponse GetDimensionKeyDetails = GetDimensionKeyDetailsResponse
type Rep GetDimensionKeyDetails Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails type Rep GetDimensionKeyDetails = D1 ('MetaData "GetDimensionKeyDetails" "Amazonka.Pi.GetDimensionKeyDetails" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "GetDimensionKeyDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestedDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceType)) :: (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "groupIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetDimensionKeyDetails Source #

Arguments

:: ServiceType	`$sel:serviceType:GetDimensionKeyDetails'`
-> Text	`GetDimensionKeyDetails`
-> Text	`GetDimensionKeyDetails`
-> Text	`$sel:groupIdentifier:GetDimensionKeyDetails'`
-> GetDimensionKeyDetails

Create a value of GetDimensionKeyDetails 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:requestedDimensions:GetDimensionKeyDetails', getDimensionKeyDetails_requestedDimensions - A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).
db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

$sel:serviceType:GetDimensionKeyDetails', getDimensionKeyDetails_serviceType - The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

GetDimensionKeyDetails, getDimensionKeyDetails_identifier - The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

GetDimensionKeyDetails, getDimensionKeyDetails_group - The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

db.query (Amazon DocumentDB only)
db.sql (Amazon RDS and Aurora only)

$sel:groupIdentifier:GetDimensionKeyDetails', getDimensionKeyDetails_groupIdentifier - The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

db.sql.id for dimension group db.sql (Aurora and RDS only)
db.query.id for dimension group db.query (DocumentDB only)

Request Lenses

getDimensionKeyDetails_requestedDimensions :: Lens' GetDimensionKeyDetails (Maybe (NonEmpty Text)) Source #

A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).
db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

getDimensionKeyDetails_serviceType :: Lens' GetDimensionKeyDetails ServiceType Source #

The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

getDimensionKeyDetails_identifier :: Lens' GetDimensionKeyDetails Text Source #

The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

getDimensionKeyDetails_group :: Lens' GetDimensionKeyDetails Text Source #

The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

db.query (Amazon DocumentDB only)
db.sql (Amazon RDS and Aurora only)

getDimensionKeyDetails_groupIdentifier :: Lens' GetDimensionKeyDetails Text Source #

The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

db.sql.id for dimension group db.sql (Aurora and RDS only)
db.query.id for dimension group db.query (DocumentDB only)

Destructuring the Response

data GetDimensionKeyDetailsResponse Source #

See: newGetDimensionKeyDetailsResponse smart constructor.

Constructors

GetDimensionKeyDetailsResponse'
Fields dimensions :: Maybe [DimensionKeyDetail] The details for the requested dimensions. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetDimensionKeyDetailsResponse Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Associated Types type Rep GetDimensionKeyDetailsResponse :: Type -> Type # Methods from :: GetDimensionKeyDetailsResponse -> Rep GetDimensionKeyDetailsResponse x # to :: Rep GetDimensionKeyDetailsResponse x -> GetDimensionKeyDetailsResponse #
Read GetDimensionKeyDetailsResponse Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods readsPrec :: Int -> ReadS GetDimensionKeyDetailsResponse # readList :: ReadS [GetDimensionKeyDetailsResponse] # readPrec :: ReadPrec GetDimensionKeyDetailsResponse # readListPrec :: ReadPrec [GetDimensionKeyDetailsResponse] #
Show GetDimensionKeyDetailsResponse Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods showsPrec :: Int -> GetDimensionKeyDetailsResponse -> ShowS # show :: GetDimensionKeyDetailsResponse -> String # showList :: [GetDimensionKeyDetailsResponse] -> ShowS #
NFData GetDimensionKeyDetailsResponse Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods rnf :: GetDimensionKeyDetailsResponse -> () #
Eq GetDimensionKeyDetailsResponse Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails Methods (==) :: GetDimensionKeyDetailsResponse -> GetDimensionKeyDetailsResponse -> Bool # (/=) :: GetDimensionKeyDetailsResponse -> GetDimensionKeyDetailsResponse -> Bool #
type Rep GetDimensionKeyDetailsResponse Source #
Instance details Defined in Amazonka.Pi.GetDimensionKeyDetails type Rep GetDimensionKeyDetailsResponse = D1 ('MetaData "GetDimensionKeyDetailsResponse" "Amazonka.Pi.GetDimensionKeyDetails" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "GetDimensionKeyDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DimensionKeyDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetDimensionKeyDetailsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDimensionKeyDetailsResponse'`
-> GetDimensionKeyDetailsResponse

Create a value of GetDimensionKeyDetailsResponse 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:

GetDimensionKeyDetailsResponse, getDimensionKeyDetailsResponse_dimensions - The details for the requested dimensions.

$sel:httpStatus:GetDimensionKeyDetailsResponse', getDimensionKeyDetailsResponse_httpStatus - The response's http status code.

Response Lenses

getDimensionKeyDetailsResponse_dimensions :: Lens' GetDimensionKeyDetailsResponse (Maybe [DimensionKeyDetail]) Source #

The details for the requested dimensions.

getDimensionKeyDetailsResponse_httpStatus :: Lens' GetDimensionKeyDetailsResponse Int Source #

The response's http status code.