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.

DescribeDimensionKeysInput

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

type DescribeDimensionKeysInput struct { EndTime *time.Time `type:"timestamp" required:"true"` Filter map[string]*string `type:"map"` GroupBy *DimensionGroup `type:"structure" required:"true"` Identifier *string `type:"string" required:"true"` MaxResults *int64 `type:"integer"` Metric *string `type:"string" required:"true"` NextToken *string `type:"string"` PartitionBy *DimensionGroup `type:"structure"` 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 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.

EndTime is a required field

Filter

Type: map[string]*string

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.

GroupBy

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, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.

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.

Metric

Type: *string

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.

Metric is a required field

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.

PartitionBy

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, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.

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 DescribeDimensionKeysInput) GoString() string

GoString returns the string representation

SetEndTime

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

SetEndTime sets the EndTime field's value.

SetFilter

func (s *DescribeDimensionKeysInput) SetFilter(v map[string]*string) *DescribeDimensionKeysInput

SetFilter sets the Filter field's value.

SetGroupBy

func (s *DescribeDimensionKeysInput) SetGroupBy(v *DimensionGroup) *DescribeDimensionKeysInput

SetGroupBy sets the GroupBy field's value.

SetIdentifier

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

SetIdentifier sets the Identifier field's value.

SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

SetMetric

func (s *DescribeDimensionKeysInput) SetMetric(v string) *DescribeDimensionKeysInput

SetMetric sets the Metric field's value.

SetNextToken

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

SetNextToken sets the NextToken field's value.

SetPartitionBy

func (s *DescribeDimensionKeysInput) SetPartitionBy(v *DimensionGroup) *DescribeDimensionKeysInput

SetPartitionBy sets the PartitionBy field's value.

SetPeriodInSeconds

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

SetPeriodInSeconds sets the PeriodInSeconds field's value.

SetServiceType

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

SetServiceType sets the ServiceType field's value.

SetStartTime

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

SetStartTime sets the StartTime field's value.

String

func (s DescribeDimensionKeysInput) String() string

String returns the string representation

Validate

func (s *DescribeDimensionKeysInput) Validate() error

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

On this page: