@datafire/amazonaws_pi v5.0.0

@datafire/amazonaws_pi

Client library for AWS Performance Insights

Installation and Usage

npm install --save @datafire/amazonaws_pi

let amazonaws_pi = require('@datafire/amazonaws_pi').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_pi.DescribeDimensionKeys({
  "ServiceType": "",
  "Identifier": "",
  "StartTime": "",
  "EndTime": "",
  "Metric": "",
  "GroupBy": {
    "Group": ""
  }
}).then(data => {
  console.log(data);
});

Description

Actions

DescribeDimensionKeys

amazonaws_pi.DescribeDimensionKeys({
  "ServiceType": "",
  "Identifier": "",
  "StartTime": "",
  "EndTime": "",
  "Metric": "",
  "GroupBy": {
    "Group": ""
  }
}, context)

Input

• input object
  • EndTime required ISOTimestamp
  • Filter MetricQueryFilterMap
  • GroupBy required DimensionGroup
  • Identifier required String
  • MaxResults MaxResults
  • Metric required String
  • NextToken String
  • PartitionBy DimensionGroup
  • PeriodInSeconds Integer
  • ServiceType required ServiceType
  • StartTime required ISOTimestamp

Output

• output DescribeDimensionKeysResponse

GetResourceMetrics

amazonaws_pi.GetResourceMetrics({
  "ServiceType": "",
  "Identifier": "",
  "MetricQueries": [],
  "StartTime": "",
  "EndTime": ""
}, context)

Input

• input object
  • EndTime required ISOTimestamp
  • Identifier required String
  • MaxResults MaxResults
  • MetricQueries required MetricQueryList
  • NextToken String
  • PeriodInSeconds Integer
  • ServiceType required ServiceType
  • StartTime required ISOTimestamp

Output

• output GetResourceMetricsResponse

Definitions

DataPoint

• DataPoint object: A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
  • Timestamp required ISOTimestamp
  • Value required Double

DataPointsList

• DataPointsList array
  • items DataPoint

DescribeDimensionKeysRequest

• DescribeDimensionKeysRequest object
  • EndTime required ISOTimestamp
  • Filter MetricQueryFilterMap
  • GroupBy required DimensionGroup
  • Identifier required String
  • MaxResults MaxResults
  • Metric required String
  • NextToken String
  • PartitionBy DimensionGroup
  • PeriodInSeconds Integer
  • ServiceType required ServiceType
  • StartTime required ISOTimestamp

DescribeDimensionKeysResponse

• DescribeDimensionKeysResponse object
  • AlignedEndTime ISOTimestamp
  • AlignedStartTime ISOTimestamp
  • Keys DimensionKeyDescriptionList
  • NextToken String
  • PartitionKeys ResponsePartitionKeyList

DimensionGroup

• DimensionGroup object: 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.
  • Dimensions StringList
  • Group required String
  • Limit Limit

DimensionKeyDescription

• DimensionKeyDescription object: An array of descriptions and aggregated values for each dimension within a dimension group.
  • Dimensions DimensionMap
  • Partitions MetricValuesList
  • Total Double

DimensionKeyDescriptionList

• DimensionKeyDescriptionList array
  • items DimensionKeyDescription

DimensionMap

• DimensionMap array
  • items object
    • key String
    • value String

Double

• Double number

GetResourceMetricsRequest

• GetResourceMetricsRequest object
  • EndTime required ISOTimestamp
  • Identifier required String
  • MaxResults MaxResults
  • MetricQueries required MetricQueryList
  • NextToken String
  • PeriodInSeconds Integer
  • ServiceType required ServiceType
  • StartTime required ISOTimestamp

GetResourceMetricsResponse

• GetResourceMetricsResponse object
  • AlignedEndTime ISOTimestamp
  • AlignedStartTime ISOTimestamp
  • Identifier String
  • MetricList MetricKeyDataPointsList
  • NextToken String

ISOTimestamp

• ISOTimestamp string

Integer

• Integer integer

InternalServiceError

• InternalServiceError object: The request failed due to an unknown error.
  • Message String

InvalidArgumentException

• InvalidArgumentException object: One of the arguments provided is invalid for this request.
  • Message String

Limit

• Limit integer

MaxResults

• MaxResults integer

MetricKeyDataPoints

• MetricKeyDataPoints object: A time-ordered series of data points, correpsonding to a dimension of a Performance Insights metric.
  • DataPoints DataPointsList
  • Key ResponseResourceMetricKey

MetricKeyDataPointsList

• MetricKeyDataPointsList array
  • items MetricKeyDataPoints

MetricQuery

• MetricQuery object: 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).
  • Filter MetricQueryFilterMap
  • GroupBy DimensionGroup
  • Metric required String

MetricQueryFilterMap

• MetricQueryFilterMap array
  • items object
    • key String
    • value String

MetricQueryList

• MetricQueryList array
  • items MetricQuery

MetricValuesList

• MetricValuesList array
  • items Double

NotAuthorizedException

• NotAuthorizedException object: The user is not authorized to perform this request.
  • Message String

ResponsePartitionKey

• ResponsePartitionKey object: If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.
  • Dimensions required DimensionMap

ResponsePartitionKeyList

• ResponsePartitionKeyList array
  • items ResponsePartitionKey

ResponseResourceMetricKey

• ResponseResourceMetricKey object: An object describing a Performance Insights metric and one or more dimensions for that metric.
  • Dimensions DimensionMap
  • Metric required String

ServiceType

• ServiceType string (values: RDS)

String

• String string

StringList

• StringList array
  • items String