NAME

Paws::PerformanceInsights::DescribeDimensionKeys - Arguments for method DescribeDimensionKeys on Paws::PerformanceInsights

DESCRIPTION

This class represents the parameters used for calling the method DescribeDimensionKeys on the AWS Performance Insights service. Use the attributes of this class as arguments to method DescribeDimensionKeys.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDimensionKeys.

SYNOPSIS

    my $pi = Paws->service('PerformanceInsights');
    my $DescribeDimensionKeysResponse = $pi->DescribeDimensionKeys(
      EndTime => '1970-01-01T01:00:00',
      GroupBy => {
        Group      => 'MyRequestString',    # max: 256
        Dimensions => [
          'MyRequestString', ...            # max: 256
        ],    # min: 1, max: 10; OPTIONAL
        Limit => 1,    # min: 1, max: 10; OPTIONAL
      },
      Identifier  => 'MyRequestString',
      Metric      => 'MyRequestString',
      ServiceType => 'RDS',
      StartTime   => '1970-01-01T01:00:00',
      Filter      => {
        'MyRequestString' => 'MyRequestString', # key: max: 256, value: max: 256
      },    # OPTIONAL
      MaxResults  => 1,                # OPTIONAL
      NextToken   => 'MyNextToken',    # OPTIONAL
      PartitionBy => {
        Group      => 'MyRequestString',    # max: 256
        Dimensions => [
          'MyRequestString', ...            # max: 256
        ],    # min: 1, max: 10; OPTIONAL
        Limit => 1,    # min: 1, max: 10; OPTIONAL
      },    # OPTIONAL
      PeriodInSeconds => 1,    # OPTIONAL
    );
    # Results:
    my $AlignedEndTime   = $DescribeDimensionKeysResponse->AlignedEndTime;
    my $AlignedStartTime = $DescribeDimensionKeysResponse->AlignedStartTime;
    my $Keys             = $DescribeDimensionKeysResponse->Keys;
    my $NextToken        = $DescribeDimensionKeysResponse->NextToken;
    my $PartitionKeys    = $DescribeDimensionKeysResponse->PartitionKeys;
 # Returns a L<Paws::PerformanceInsights::DescribeDimensionKeysResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/pi/DescribeDimensionKeys>

ATTRIBUTES

REQUIRED EndTime => Str

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".

Filter => Paws::PerformanceInsights::MetricQueryFilterMap

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.

REQUIRED GroupBy => Paws::PerformanceInsights::DimensionGroup

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.

REQUIRED Identifier => Str

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"

MaxResults => Int

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.

REQUIRED Metric => Str

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.

NextToken => Str

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".

PartitionBy => Paws::PerformanceInsights::DimensionGroup

For each dimension specified in "GroupBy", specify a secondary dimension to further subdivide the partition keys in the response.

PeriodInSeconds => Int

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.

REQUIRED ServiceType => Str

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is "RDS".

Valid values are: "RDS"

REQUIRED StartTime => Str

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".

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>