codegen-resources.docs-2.json Maven / Gradle / Ivy

Go to download
{
  "version": "2.0",
  "service": "AWS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running RDS instance. The guide provides detailed information about Performance Insights data types, parameters and errors. For more information about Performance Insights capabilities see Using Amazon RDS Performance Insights  in the Amazon RDS User Guide.
  The AWS Performance Insights API provides visibility into the performance of your RDS instance, when Performance Insights is enabled for supported engine types. While Amazon CloudWatch provides the authoritative source for AWS service vended monitoring metrics, AWS Performance Insights offers a domain-specific view of database load measured as Average Active Sessions and provided to API consumers as a 2-dimensional time-series dataset. The time dimension of the data provides DB load data for each time point in the queried time range, and each time point decomposes overall load in relation to the requested dimensions, such as SQL, Wait-event, User or Host, measured at that time point.",
  "operations": {
    "DescribeDimensionKeys": "For a specific time period, retrieve the top N dimension keys for a metric.",
    "GetResourceMetrics": "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."
  },
  "shapes": {
    "DataPoint": {
      "base": "A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.",
      "refs": {
        "DataPointsList$member": null
      }
    },
    "DataPointsList": {
      "base": null,
      "refs": {
        "MetricKeyDataPoints$DataPoints": "An array of timestamp-value pairs, representing measurements over a period of time."
      }
    },
    "DescribeDimensionKeysRequest": {
      "base": null,
      "refs": {
      }
    },
    "DescribeDimensionKeysResponse": {
      "base": null,
      "refs": {
      }
    },
    "DimensionGroup": {
      "base": "A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.",
      "refs": {
        "DescribeDimensionKeysRequest$GroupBy": "A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.",
        "DescribeDimensionKeysRequest$PartitionBy": "For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.",
        "MetricQuery$GroupBy": "A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension."
      }
    },
    "DimensionKeyDescription": {
      "base": "An array of descriptions and aggregated values for each dimension within a dimension group.",
      "refs": {
        "DimensionKeyDescriptionList$member": null
      }
    },
    "DimensionKeyDescriptionList": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysResponse$Keys": "The dimension keys that were requested."
      }
    },
    "DimensionMap": {
      "base": null,
      "refs": {
        "DimensionKeyDescription$Dimensions": "A map of name-value pairs for the dimensions in the group.",
        "ResponsePartitionKey$Dimensions": "A dimension map that contains the dimension(s) for this partition.",
        "ResponseResourceMetricKey$Dimensions": "The valid dimensions for the metric."
      }
    },
    "Double": {
      "base": null,
      "refs": {
        "DataPoint$Value": "The actual value associated with a particular Timestamp.",
        "DimensionKeyDescription$Total": "The aggregated metric value for the dimension(s), over the requested time range.",
        "MetricValuesList$member": null
      }
    },
    "GetResourceMetricsRequest": {
      "base": null,
      "refs": {
      }
    },
    "GetResourceMetricsResponse": {
      "base": null,
      "refs": {
      }
    },
    "ISOTimestamp": {
      "base": null,
      "refs": {
        "DataPoint$Timestamp": "The time, in epoch format, associated with a particular Value.",
        "DescribeDimensionKeysRequest$StartTime": "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.",
        "DescribeDimensionKeysRequest$EndTime": "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.",
        "DescribeDimensionKeysResponse$AlignedStartTime": "The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.",
        "DescribeDimensionKeysResponse$AlignedEndTime": "The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.",
        "GetResourceMetricsRequest$StartTime": "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.",
        "GetResourceMetricsRequest$EndTime": "The date and time specifiying 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.",
        "GetResourceMetricsResponse$AlignedStartTime": "The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.",
        "GetResourceMetricsResponse$AlignedEndTime": "The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime."
      }
    },
    "Integer": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysRequest$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.",
        "GetResourceMetricsRequest$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."
      }
    },
    "InternalServiceError": {
      "base": "The request failed due to an unknown error.",
      "refs": {
      }
    },
    "InvalidArgumentException": {
      "base": "One of the arguments provided is invalid for this request.",
      "refs": {
      }
    },
    "Limit": {
      "base": null,
      "refs": {
        "DimensionGroup$Limit": "The maximum number of items to fetch for this dimension group."
      }
    },
    "MaxResults": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysRequest$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. ",
        "GetResourceMetricsRequest$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. "
      }
    },
    "MetricKeyDataPoints": {
      "base": "A time-ordered series of data points, correpsonding to a dimension of a Performance Insights metric.",
      "refs": {
        "MetricKeyDataPointsList$member": null
      }
    },
    "MetricKeyDataPointsList": {
      "base": null,
      "refs": {
        "GetResourceMetricsResponse$MetricList": "An array of metric results,, where each array element contains all of the data points for a particular dimension."
      }
    },
    "MetricQuery": {
      "base": "A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy), and return only those data points that match your criteria (Filter).",
      "refs": {
        "MetricQueryList$member": null
      }
    },
    "MetricQueryFilterMap": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysRequest$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.
 
 ",
        "MetricQuery$Filter": "One or more filters to apply in the request. Restrictions:
   Any number of filters by the same dimension, as specified in the GroupBy parameter.
 
  A single filter for any other dimension in this dimension group.
 
 "
      }
    },
    "MetricQueryList": {
      "base": null,
      "refs": {
        "GetResourceMetricsRequest$MetricQueries": "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."
      }
    },
    "MetricValuesList": {
      "base": null,
      "refs": {
        "DimensionKeyDescription$Partitions": "If PartitionBy was specified, PartitionKeys contains the dimensions that were."
      }
    },
    "NotAuthorizedException": {
      "base": "The user is not authorized to perform this request.",
      "refs": {
      }
    },
    "ResponsePartitionKey": {
      "base": "If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension. ",
      "refs": {
        "ResponsePartitionKeyList$member": null
      }
    },
    "ResponsePartitionKeyList": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysResponse$PartitionKeys": "If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions."
      }
    },
    "ResponseResourceMetricKey": {
      "base": "An object describing a Performance Insights metric and one or more dimensions for that metric.",
      "refs": {
        "MetricKeyDataPoints$Key": "The dimension(s) to which the data points apply."
      }
    },
    "ServiceType": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysRequest$ServiceType": "The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS ",
        "GetResourceMetricsRequest$ServiceType": "The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS "
      }
    },
    "String": {
      "base": null,
      "refs": {
        "DescribeDimensionKeysRequest$Identifier": "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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A ",
        "DescribeDimensionKeysRequest$Metric": "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.
 
 ",
        "DescribeDimensionKeysRequest$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.",
        "DescribeDimensionKeysResponse$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.",
        "DimensionGroup$Group": "The name of the dimension group. Valid values are:
    db.user 
 
   db.host 
 
   db.sql 
 
   db.sql_tokenized 
 
   db.wait_event 
 
   db.wait_event_type 
 
 ",
        "DimensionMap$key": null,
        "DimensionMap$value": null,
        "GetResourceMetricsRequest$Identifier": "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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A ",
        "GetResourceMetricsRequest$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.",
        "GetResourceMetricsResponse$Identifier": "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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A ",
        "GetResourceMetricsResponse$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.",
        "InternalServiceError$Message": null,
        "InvalidArgumentException$Message": null,
        "MetricQuery$Metric": "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.
 
 ",
        "MetricQueryFilterMap$key": null,
        "MetricQueryFilterMap$value": null,
        "NotAuthorizedException$Message": null,
        "ResponseResourceMetricKey$Metric": "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.
 
 ",
        "StringList$member": null
      }
    },
    "StringList": {
      "base": null,
      "refs": {
        "DimensionGroup$Dimensions": "A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.
 Valid values for elements in the Dimensions array are:
   db.user.id
 
  db.user.name
 
  db.host.id
 
  db.host.name
 
  db.sql.id
 
  db.sql.db_id
 
  db.sql.statement
 
  db.sql.tokenized_id
 
  db.sql_tokenized.id
 
  db.sql_tokenized.db_id
 
  db.sql_tokenized.statement
 
  db.wait_event.name
 
  db.wait_event.type
 
  db.wait_event_type.name
 
 "
      }
    }
  }
}