NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $pi = Paws->service('PerformanceInsights');
    my $GetResourceMetricsResponse = $pi->GetResourceMetrics(
      EndTime       => '1970-01-01T01:00:00',
      Identifier    => 'MyRequestString',
      MetricQueries => [
        {
          Metric => 'MyRequestString',    # max: 256
          Filter => {
            'MyRequestString' =>
              'MyRequestString',          # key: max: 256, value: max: 256
          },    # OPTIONAL
          GroupBy => {
            Group      => 'MyRequestString',    # max: 256
            Dimensions => [
              'MyRequestString', ...            # max: 256
            ],    # min: 1, max: 10; OPTIONAL
            Limit => 1,    # min: 1, max: 10; OPTIONAL
          },    # OPTIONAL
        },
        ...
      ],
      ServiceType     => 'RDS',
      StartTime       => '1970-01-01T01:00:00',
      MaxResults      => 1,                       # OPTIONAL
      NextToken       => 'MyNextToken',           # OPTIONAL
      PeriodInSeconds => 1,                       # OPTIONAL
    );

    # Results:
    my $AlignedEndTime   = $GetResourceMetricsResponse->AlignedEndTime;
    my $AlignedStartTime = $GetResourceMetricsResponse->AlignedStartTime;
    my $Identifier       = $GetResourceMetricsResponse->Identifier;
    my $MetricList       = $GetResourceMetricsResponse->MetricList;
    my $NextToken        = $GetResourceMetricsResponse->NextToken;

    # Returns a L<Paws::PerformanceInsights::GetResourceMetricsResponse> 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/GetResourceMetrics

ATTRIBUTES

REQUIRED EndTime => Str

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.

REQUIRED Identifier => Str

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use a DB instance as a data source, 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 MetricQueries => ArrayRef[Paws::PerformanceInsights::MetricQuery]

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.

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.

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 will choose 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 returns 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 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetResourceMetrics in Paws::PerformanceInsights

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

cpanm Paws

perl -MCPAN -e shell
install Paws