AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetResourceMetricsInput

import "github.com/aws/aws-sdk-go/service/pi"

type GetResourceMetricsInput struct { EndTime *time.Time `type:"timestamp" required:"true"` Identifier *string `type:"string" required:"true"` MaxResults *int64 `type:"integer"` MetricQueries []*MetricQuery `min:"1" type:"list" required:"true"` NextToken *string `type:"string"` PeriodInSeconds *int64 `type:"integer"` ServiceType *string `type:"string" required:"true" enum:"ServiceType"` StartTime *time.Time `type:"timestamp" required:"true"` }

EndTime

Type: *time.Time

The date and time specifiying 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.

EndTime is a required field

Identifier

Type: *string

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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

Identifier is a required field

MaxResults

Type: *int64

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.

MetricQueries

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

NextToken

Type: *string

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

Type: *int64

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.

ServiceType

Type: *string

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

ServiceType is a required field

StartTime

Type: *time.Time

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.

StartTime is a required field

Method

GoString

func (s GetResourceMetricsInput) GoString() string

GoString returns the string representation

SetEndTime

func (s *GetResourceMetricsInput) SetEndTime(v time.Time) *GetResourceMetricsInput

SetEndTime sets the EndTime field's value.

SetIdentifier

func (s *GetResourceMetricsInput) SetIdentifier(v string) *GetResourceMetricsInput

SetIdentifier sets the Identifier field's value.

SetMaxResults

func (s *GetResourceMetricsInput) SetMaxResults(v int64) *GetResourceMetricsInput

SetMaxResults sets the MaxResults field's value.

SetMetricQueries

func (s *GetResourceMetricsInput) SetMetricQueries(v []*MetricQuery) *GetResourceMetricsInput

SetMetricQueries sets the MetricQueries field's value.

SetNextToken

func (s *GetResourceMetricsInput) SetNextToken(v string) *GetResourceMetricsInput

SetNextToken sets the NextToken field's value.

SetPeriodInSeconds

func (s *GetResourceMetricsInput) SetPeriodInSeconds(v int64) *GetResourceMetricsInput

SetPeriodInSeconds sets the PeriodInSeconds field's value.

SetServiceType

func (s *GetResourceMetricsInput) SetServiceType(v string) *GetResourceMetricsInput

SetServiceType sets the ServiceType field's value.

SetStartTime

func (s *GetResourceMetricsInput) SetStartTime(v time.Time) *GetResourceMetricsInput

SetStartTime sets the StartTime field's value.

String

func (s GetResourceMetricsInput) String() string

String returns the string representation

Validate

func (s *GetResourceMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: