Amazonka.Pi.ListAvailableResourceDimensions

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

Creating a Request

data ListAvailableResourceDimensions

See: newListAvailableResourceDimensions smart constructor.

Constructors

ListAvailableResourceDimensions'

Fields

• maxResults :: Maybe Natural

  The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

• nextToken :: Maybe Text

  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

• serviceType :: ServiceType

  The Amazon Web Services service for which Performance Insights returns metrics.

• identifier :: Text

  An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

• metrics :: NonEmpty Text

  The types of metrics for which to retrieve dimensions. Valid values include db.load.

Instances

ToJSON ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

toJSON :: ListAvailableResourceDimensions -> Value

toEncoding :: ListAvailableResourceDimensions -> Encoding

toJSONList :: [ListAvailableResourceDimensions] -> Value

toEncodingList :: [ListAvailableResourceDimensions] -> Encoding

ToHeaders ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

toHeaders :: ListAvailableResourceDimensions -> [Header]

ToPath ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

toPath :: ListAvailableResourceDimensions -> ByteString

ToQuery ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

toQuery :: ListAvailableResourceDimensions -> QueryString

AWSRequest ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Associated Types

type AWSResponse ListAvailableResourceDimensions

Methods

request :: (Service -> Service) -> ListAvailableResourceDimensions -> Request ListAvailableResourceDimensions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListAvailableResourceDimensions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListAvailableResourceDimensions)))

Generic ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Associated Types

type Rep ListAvailableResourceDimensions :: Type -> Type

Methods

from :: ListAvailableResourceDimensions -> Rep ListAvailableResourceDimensions x

to :: Rep ListAvailableResourceDimensions x -> ListAvailableResourceDimensions

Read ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

readsPrec :: Int -> ReadS ListAvailableResourceDimensions

readList :: ReadS [ListAvailableResourceDimensions]

readPrec :: ReadPrec ListAvailableResourceDimensions

readListPrec :: ReadPrec [ListAvailableResourceDimensions]

Show ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

showsPrec :: Int -> ListAvailableResourceDimensions -> ShowS

show :: ListAvailableResourceDimensions -> String

showList :: [ListAvailableResourceDimensions] -> ShowS

NFData ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

rnf :: ListAvailableResourceDimensions -> ()

Eq ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

(==) :: ListAvailableResourceDimensions -> ListAvailableResourceDimensions -> Bool

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

Hashable ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

hashWithSalt :: Int -> ListAvailableResourceDimensions -> Int

hash :: ListAvailableResourceDimensions -> Int

type AWSResponse ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

type AWSResponse ListAvailableResourceDimensions = ListAvailableResourceDimensionsResponse

type Rep ListAvailableResourceDimensions

Defined in Amazonka.Pi.ListAvailableResourceDimensions

type Rep ListAvailableResourceDimensions = D1 ('MetaData "ListAvailableResourceDimensions" "Amazonka.Pi.ListAvailableResourceDimensions" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ListAvailableResourceDimensions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceType) :*: (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))

newListAvailableResourceDimensions

Arguments

:: ServiceType

$sel:serviceType:ListAvailableResourceDimensions'

-> Text

ListAvailableResourceDimensions

-> NonEmpty Text

$sel:metrics:ListAvailableResourceDimensions'

-> ListAvailableResourceDimensions

Create a value of ListAvailableResourceDimensions 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:maxResults:ListAvailableResourceDimensions', listAvailableResourceDimensions_maxResults - The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

ListAvailableResourceDimensions, listAvailableResourceDimensions_nextToken - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

$sel:serviceType:ListAvailableResourceDimensions', listAvailableResourceDimensions_serviceType - The Amazon Web Services service for which Performance Insights returns metrics.

ListAvailableResourceDimensions, listAvailableResourceDimensions_identifier - An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

$sel:metrics:ListAvailableResourceDimensions', listAvailableResourceDimensions_metrics - The types of metrics for which to retrieve dimensions. Valid values include db.load.

Request Lenses

listAvailableResourceDimensions_maxResults :: Lens' ListAvailableResourceDimensions (Maybe Natural)

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

listAvailableResourceDimensions_nextToken :: Lens' ListAvailableResourceDimensions (Maybe Text)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

listAvailableResourceDimensions_serviceType :: Lens' ListAvailableResourceDimensions ServiceType

The Amazon Web Services service for which Performance Insights returns metrics.

listAvailableResourceDimensions_identifier :: Lens' ListAvailableResourceDimensions Text

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

listAvailableResourceDimensions_metrics :: Lens' ListAvailableResourceDimensions (NonEmpty Text)

The types of metrics for which to retrieve dimensions. Valid values include db.load.

Destructuring the Response

data ListAvailableResourceDimensionsResponse

See: newListAvailableResourceDimensionsResponse smart constructor.

Constructors

ListAvailableResourceDimensionsResponse'

Fields

• metricDimensions :: Maybe [MetricDimensionGroups]

  The dimension information returned for requested metric types.

• nextToken :: Maybe Text

  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListAvailableResourceDimensionsResponse

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Associated Types

type Rep ListAvailableResourceDimensionsResponse :: Type -> Type

Methods

from :: ListAvailableResourceDimensionsResponse -> Rep ListAvailableResourceDimensionsResponse x

to :: Rep ListAvailableResourceDimensionsResponse x -> ListAvailableResourceDimensionsResponse

Read ListAvailableResourceDimensionsResponse

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

readsPrec :: Int -> ReadS ListAvailableResourceDimensionsResponse

readList :: ReadS [ListAvailableResourceDimensionsResponse]

readPrec :: ReadPrec ListAvailableResourceDimensionsResponse

readListPrec :: ReadPrec [ListAvailableResourceDimensionsResponse]

Show ListAvailableResourceDimensionsResponse

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

showsPrec :: Int -> ListAvailableResourceDimensionsResponse -> ShowS

show :: ListAvailableResourceDimensionsResponse -> String

showList :: [ListAvailableResourceDimensionsResponse] -> ShowS

NFData ListAvailableResourceDimensionsResponse

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

rnf :: ListAvailableResourceDimensionsResponse -> ()

Eq ListAvailableResourceDimensionsResponse

Defined in Amazonka.Pi.ListAvailableResourceDimensions

Methods

(==) :: ListAvailableResourceDimensionsResponse -> ListAvailableResourceDimensionsResponse -> Bool

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

type Rep ListAvailableResourceDimensionsResponse

Defined in Amazonka.Pi.ListAvailableResourceDimensions

type Rep ListAvailableResourceDimensionsResponse = D1 ('MetaData "ListAvailableResourceDimensionsResponse" "Amazonka.Pi.ListAvailableResourceDimensions" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" 'False) (C1 ('MetaCons "ListAvailableResourceDimensionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDimensionGroups])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAvailableResourceDimensionsResponse

Arguments

:: Int

$sel:httpStatus:ListAvailableResourceDimensionsResponse'

-> ListAvailableResourceDimensionsResponse

Create a value of ListAvailableResourceDimensionsResponse 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:metricDimensions:ListAvailableResourceDimensionsResponse', listAvailableResourceDimensionsResponse_metricDimensions - The dimension information returned for requested metric types.

ListAvailableResourceDimensions, listAvailableResourceDimensionsResponse_nextToken - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

$sel:httpStatus:ListAvailableResourceDimensionsResponse', listAvailableResourceDimensionsResponse_httpStatus - The response's http status code.

Response Lenses

listAvailableResourceDimensionsResponse_metricDimensions :: Lens' ListAvailableResourceDimensionsResponse (Maybe [MetricDimensionGroups])

The dimension information returned for requested metric types.

listAvailableResourceDimensionsResponse_nextToken :: Lens' ListAvailableResourceDimensionsResponse (Maybe Text)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

listAvailableResourceDimensionsResponse_httpStatus :: Lens' ListAvailableResourceDimensionsResponse Int

The response's http status code.