NAME

Paws::PerformanceInsights - Perl Interface to AWS AWS Performance Insights

SYNOPSIS

  use Paws;
  my $obj = Paws->service('PerformanceInsights');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon RDS Performance Insights

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for AWS service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as Average Active Sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html).
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html).

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27>

METHODS

DescribeDimensionKeys

EndTime => Str
GroupBy => Paws::PerformanceInsights::DimensionGroup
Identifier => Str
Metric => Str
ServiceType => Str
StartTime => Str
[Filter => Paws::PerformanceInsights::MetricQueryFilterMap]
[MaxResults => Int]
[NextToken => Str]
[PartitionBy => Paws::PerformanceInsights::DimensionGroup]
[PeriodInSeconds => Int]

Each argument is described in detail in: Paws::PerformanceInsights::DescribeDimensionKeys

Returns: a Paws::PerformanceInsights::DescribeDimensionKeysResponse instance

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.

GetDimensionKeyDetails

Group => Str
GroupIdentifier => Str
Identifier => Str
ServiceType => Str
[RequestedDimensions => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::PerformanceInsights::GetDimensionKeyDetails

Returns: a Paws::PerformanceInsights::GetDimensionKeyDetailsResponse instance

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, "GetDimensionKeyDetails" retrieves the full text of the dimension "db.sql.statement" associated with this ID. This operation is useful because "GetResourceMetrics" and "DescribeDimensionKeys" don't support retrieval of large SQL statement text.

GetResourceMetrics

EndTime => Str
Identifier => Str
MetricQueries => ArrayRef[Paws::PerformanceInsights::MetricQuery]
ServiceType => Str
StartTime => Str
[MaxResults => Int]
[NextToken => Str]
[PeriodInSeconds => Int]

Each argument is described in detail in: Paws::PerformanceInsights::GetResourceMetrics

Returns: a Paws::PerformanceInsights::GetResourceMetricsResponse instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>