Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS Performance Insights can respond with.

Structs

AnalysisReport

Retrieves the summary of the performance analysis report created for a time period.

AnalysisReportSummary

Retrieves the details of the performance analysis report.

Data

List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.

DataPoint

A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

DimensionDetail

The information about a dimension.

DimensionGroup

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 - The hash of a running SQL statement, generated by Performance Insights.

• db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.

• db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.

• db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

DimensionGroupDetail

Information about dimensions within a dimension group.

DimensionKeyDescription

An object that includes the requested dimension key values and aggregated metric values within a dimension group.

DimensionKeyDetail

An object that describes the details for a specified dimension.

FeatureMetadata

The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Insight

Retrieves the list of performance issues which are identified.

MetricDimensionGroups

The available dimension information for a metric type.

MetricKeyDataPoints

A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

MetricQuery

A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).

PerformanceInsightsMetric

This data type helps to determine Performance Insights metric to render for the insight.

Recommendation

The list of recommendations for the insight.

ResponsePartitionKey

If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

ResponseResourceMetric

An object that contains the full name, description, and unit of a metric.

ResponseResourceMetricKey

An object describing a Performance Insights metric and one or more dimensions for that metric.

Tag

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

Enums

AcceptLanguage

When writing a match expression against AcceptLanguage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AnalysisStatus

When writing a match expression against AnalysisStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ContextType

When writing a match expression against ContextType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DetailStatus

When writing a match expression against DetailStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FeatureStatus

When writing a match expression against FeatureStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FineGrainedAction

When writing a match expression against FineGrainedAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PeriodAlignment

When writing a match expression against PeriodAlignment, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceType

When writing a match expression against ServiceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Severity

When writing a match expression against Severity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TextFormat

When writing a match expression against TextFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.