R/pi_operations.R

Defines functions pi_get_resource_metrics pi_describe_dimension_keys

Documented in pi_describe_dimension_keys pi_get_resource_metrics

# This file is generated by make.paws. Please do not edit here.
#' @importFrom paws.common get_config new_operation new_request send_request
#' @include pi_service.R
NULL

#' For a specific time period, retrieve the top N dimension keys for a
#' metric
#'
#' @description
#' For a specific time period, retrieve the top `N` dimension keys for a
#' metric.
#' 
#' Each response element returns a maximum of 500 bytes. For larger
#' elements, such as SQL statements, only the first 500 bytes are returned.
#'
#' @usage
#' pi_describe_dimension_keys(ServiceType, Identifier, StartTime, EndTime,
#'   Metric, PeriodInSeconds, GroupBy, PartitionBy, Filter, MaxResults,
#'   NextToken)
#'
#' @param ServiceType [required] The AWS service for which Performance Insights will return metrics. The
#' only valid value for *ServiceType* is `RDS`.
#' @param Identifier [required] An immutable, AWS Region-unique identifier for a data source.
#' Performance Insights gathers metrics from this data source.
#' 
#' To use an Amazon RDS instance as a data source, you specify its
#' `DbiResourceId` value. For example, specify
#' `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
#' @param StartTime [required] The date and time specifying the beginning of the requested time series
#' data. You must specify a `StartTime` within the past 7 days. The value
#' specified is *inclusive*, which means that data points equal to or
#' greater than `StartTime` are returned.
#' 
#' The value for `StartTime` must be earlier than the value for `EndTime`.
#' @param EndTime [required] The date and time specifying the end of the requested time series data.
#' The value specified is *exclusive*, which means that data points less
#' than (but not equal to) `EndTime` are returned.
#' 
#' The value for `EndTime` must be later than the value for `StartTime`.
#' @param Metric [required] The name of a Performance Insights metric to be measured.
#' 
#' Valid values for `Metric` are:
#' 
#' -   `db.load.avg` - a scaled representation of the number of active
#'     sessions for the database engine.
#' 
#' -   `db.sampledload.avg` - the raw number of active sessions for the
#'     database engine.
#' 
#' If the number of active sessions is less than an internal Performance
#' Insights threshold, `db.load.avg` and `db.sampledload.avg` are the same
#' value. If the number of active sessions is greater than the internal
#' threshold, Performance Insights samples the active sessions, with
#' `db.load.avg` showing the scaled values, `db.sampledload.avg` showing
#' the raw values, and `db.sampledload.avg` less than `db.load.avg`. For
#' most use cases, you can query `db.load.avg` only.
#' @param PeriodInSeconds The granularity, in seconds, of the data points returned from
#' Performance Insights. A period can be as short as one second, or as long
#' as one day (86400 seconds). Valid values are:
#' 
#' -   `1` (one second)
#' 
#' -   `60` (one minute)
#' 
#' -   `300` (five minutes)
#' 
#' -   `3600` (one hour)
#' 
#' -   `86400` (twenty-four hours)
#' 
#' If you don't specify `PeriodInSeconds`, then Performance Insights
#' chooses a value for you, with a goal of returning roughly 100-200 data
#' points in the response.
#' @param GroupBy [required] A specification for how to aggregate the data points from a query
#' result. You must specify a valid dimension group. Performance Insights
#' returns all dimensions within this group, unless you provide the names
#' of specific dimensions within this group. You can also request that
#' Performance Insights return a limited number of values for a dimension.
#' @param PartitionBy For each dimension specified in `GroupBy`, specify a secondary dimension
#' to further subdivide the partition keys in the response.
#' @param Filter One or more filters to apply in the request. Restrictions:
#' 
#' -   Any number of filters by the same dimension, as specified in the
#'     `GroupBy` or `Partition` parameters.
#' 
#' -   A single filter for any other dimension in this dimension group.
#' @param 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.
#' @param 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`.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   AlignedStartTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   AlignedEndTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   PartitionKeys = list(
#'     list(
#'       Dimensions = list(
#'         "string"
#'       )
#'     )
#'   ),
#'   Keys = list(
#'     list(
#'       Dimensions = list(
#'         "string"
#'       ),
#'       Total = 123.0,
#'       Partitions = list(
#'         123.0
#'       )
#'     )
#'   ),
#'   NextToken = "string"
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$describe_dimension_keys(
#'   ServiceType = "RDS",
#'   Identifier = "string",
#'   StartTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   EndTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   Metric = "string",
#'   PeriodInSeconds = 123,
#'   GroupBy = list(
#'     Group = "string",
#'     Dimensions = list(
#'       "string"
#'     ),
#'     Limit = 123
#'   ),
#'   PartitionBy = list(
#'     Group = "string",
#'     Dimensions = list(
#'       "string"
#'     ),
#'     Limit = 123
#'   ),
#'   Filter = list(
#'     "string"
#'   ),
#'   MaxResults = 123,
#'   NextToken = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname pi_describe_dimension_keys
pi_describe_dimension_keys <- function(ServiceType, Identifier, StartTime, EndTime, Metric, PeriodInSeconds = NULL, GroupBy, PartitionBy = NULL, Filter = NULL, MaxResults = NULL, NextToken = NULL) {
  op <- new_operation(
    name = "DescribeDimensionKeys",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .pi$describe_dimension_keys_input(ServiceType = ServiceType, Identifier = Identifier, StartTime = StartTime, EndTime = EndTime, Metric = Metric, PeriodInSeconds = PeriodInSeconds, GroupBy = GroupBy, PartitionBy = PartitionBy, Filter = Filter, MaxResults = MaxResults, NextToken = NextToken)
  output <- .pi$describe_dimension_keys_output()
  config <- get_config()
  svc <- .pi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.pi$operations$describe_dimension_keys <- pi_describe_dimension_keys

#' Retrieve Performance Insights metrics for a set of data sources, over a
#' time period
#'
#' @description
#' Retrieve Performance Insights metrics for a set of data sources, over a
#' time period. You can provide specific dimension groups and dimensions,
#' and provide aggregation and filtering criteria for each group.
#' 
#' Each response element returns a maximum of 500 bytes. For larger
#' elements, such as SQL statements, only the first 500 bytes are returned.
#'
#' @usage
#' pi_get_resource_metrics(ServiceType, Identifier, MetricQueries,
#'   StartTime, EndTime, PeriodInSeconds, MaxResults, NextToken)
#'
#' @param ServiceType &#91;required&#93; The AWS service for which Performance Insights returns metrics. The only
#' valid value for *ServiceType* is `RDS`.
#' @param Identifier &#91;required&#93; An immutable, AWS Region-unique identifier for a data source.
#' Performance Insights gathers metrics from this data source.
#' 
#' To use a DB instance as a data source, specify its `DbiResourceId`
#' value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
#' @param MetricQueries &#91;required&#93; An array of one or more queries to perform. Each query must specify a
#' Performance Insights metric, and can optionally specify aggregation and
#' filtering criteria.
#' @param StartTime &#91;required&#93; The date and time specifying the beginning of the requested time series
#' data. You can't specify a `StartTime` that's earlier than 7 days ago.
#' The value specified is *inclusive* - data points equal to or greater
#' than `StartTime` will be returned.
#' 
#' The value for `StartTime` must be earlier than the value for `EndTime`.
#' @param EndTime &#91;required&#93; The date and time specifying the end of the requested time series data.
#' The value specified is *exclusive* - data points less than (but not
#' equal to) `EndTime` will be returned.
#' 
#' The value for `EndTime` must be later than the value for `StartTime`.
#' @param PeriodInSeconds The granularity, in seconds, of the data points returned from
#' Performance Insights. A period can be as short as one second, or as long
#' as one day (86400 seconds). Valid values are:
#' 
#' -   `1` (one second)
#' 
#' -   `60` (one minute)
#' 
#' -   `300` (five minutes)
#' 
#' -   `3600` (one hour)
#' 
#' -   `86400` (twenty-four hours)
#' 
#' If you don't specify `PeriodInSeconds`, then Performance Insights will
#' choose a value for you, with a goal of returning roughly 100-200 data
#' points in the response.
#' @param 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.
#' @param 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`.
#'
#' @return
#' A list with the following syntax:
#' ```
#' list(
#'   AlignedStartTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   AlignedEndTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   Identifier = "string",
#'   MetricList = list(
#'     list(
#'       Key = list(
#'         Metric = "string",
#'         Dimensions = list(
#'           "string"
#'         )
#'       ),
#'       DataPoints = list(
#'         list(
#'           Timestamp = as.POSIXct(
#'             "2015-01-01"
#'           ),
#'           Value = 123.0
#'         )
#'       )
#'     )
#'   ),
#'   NextToken = "string"
#' )
#' ```
#'
#' @section Request syntax:
#' ```
#' svc$get_resource_metrics(
#'   ServiceType = "RDS",
#'   Identifier = "string",
#'   MetricQueries = list(
#'     list(
#'       Metric = "string",
#'       GroupBy = list(
#'         Group = "string",
#'         Dimensions = list(
#'           "string"
#'         ),
#'         Limit = 123
#'       ),
#'       Filter = list(
#'         "string"
#'       )
#'     )
#'   ),
#'   StartTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   EndTime = as.POSIXct(
#'     "2015-01-01"
#'   ),
#'   PeriodInSeconds = 123,
#'   MaxResults = 123,
#'   NextToken = "string"
#' )
#' ```
#'
#' @keywords internal
#'
#' @rdname pi_get_resource_metrics
pi_get_resource_metrics <- function(ServiceType, Identifier, MetricQueries, StartTime, EndTime, PeriodInSeconds = NULL, MaxResults = NULL, NextToken = NULL) {
  op <- new_operation(
    name = "GetResourceMetrics",
    http_method = "POST",
    http_path = "/",
    paginator = list()
  )
  input <- .pi$get_resource_metrics_input(ServiceType = ServiceType, Identifier = Identifier, MetricQueries = MetricQueries, StartTime = StartTime, EndTime = EndTime, PeriodInSeconds = PeriodInSeconds, MaxResults = MaxResults, NextToken = NextToken)
  output <- .pi$get_resource_metrics_output()
  config <- get_config()
  svc <- .pi$service(config)
  request <- new_request(svc, op, input, output)
  response <- send_request(request)
  return(response)
}
.pi$operations$get_resource_metrics <- pi_get_resource_metrics

Try the paws.management package in your browser

Any scripts or data that you put into this service are public.

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.