Documentation

Overview

    Package pi provides the API client, operations, and parameter types for AWS Performance Insights.

    AWS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running RDS instance. The guide provides detailed information about Performance Insights data types, parameters and errors. For more information about Performance Insights capabilities see Using Amazon RDS Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the Amazon RDS User Guide. The AWS Performance Insights API provides visibility into the performance of your RDS instance, when Performance Insights is enabled for supported engine types. While Amazon CloudWatch provides the authoritative source for AWS service vended monitoring metrics, AWS Performance Insights offers a domain-specific view of database load measured as Average Active Sessions and provided to API consumers as a 2-dimensional time-series dataset. The time dimension of the data provides DB load data for each time point in the queried time range, and each time point decomposes overall load in relation to the requested dimensions, such as SQL, Wait-event, User or Host, measured at that time point.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-02-27"
    View Source
    const ServiceID = "PI"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Performance Insights.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) DescribeDimensionKeys

                func (c *Client) DescribeDimensionKeys(ctx context.Context, params *DescribeDimensionKeysInput, optFns ...func(*Options)) (*DescribeDimensionKeysOutput, error)

                  For a specific time period, retrieve the top N dimension keys for a metric.

                  func (*Client) GetResourceMetrics

                  func (c *Client) GetResourceMetrics(ctx context.Context, params *GetResourceMetricsInput, optFns ...func(*Options)) (*GetResourceMetricsOutput, error)

                    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.

                    type DescribeDimensionKeysInput

                    type DescribeDimensionKeysInput struct {
                    
                    	// 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.
                    	//
                    	// This member is required.
                    	EndTime *time.Time
                    
                    	// A specification for how to aggregate the data points from a query result. You
                    	// must specify a valid dimension group. Performance Insights will return all of
                    	// the dimensions within that group, unless you provide the names of specific
                    	// dimensions within that group. You can also request that Performance Insights
                    	// return a limited number of values for a dimension.
                    	//
                    	// This member is required.
                    	GroupBy *types.DimensionGroup
                    
                    	// 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
                    	//
                    	// This member is required.
                    	Identifier *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.
                    	//
                    	// This member is required.
                    	Metric *string
                    
                    	// The AWS service for which Performance Insights will return metrics. The only
                    	// valid value for ServiceType is: RDS
                    	//
                    	// This member is required.
                    	ServiceType types.ServiceType
                    
                    	// 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.
                    	//
                    	// This member is required.
                    	StartTime *time.Time
                    
                    	// 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.
                    	Filter map[string]string
                    
                    	// 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.
                    	MaxResults *int32
                    
                    	// 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.
                    	NextToken *string
                    
                    	// For each dimension specified in GroupBy, specify a secondary dimension to
                    	// further subdivide the partition keys in the response.
                    	PartitionBy *types.DimensionGroup
                    
                    	// 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.
                    	PeriodInSeconds *int32
                    }

                    type DescribeDimensionKeysOutput

                    type DescribeDimensionKeysOutput struct {
                    
                    	// The end time for the returned dimension keys, after alignment to a granular
                    	// boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than
                    	// or equal to the value of the user-specified Endtime.
                    	AlignedEndTime *time.Time
                    
                    	// The start time for the returned dimension keys, after alignment to a granular
                    	// boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than
                    	// or equal to the value of the user-specified StartTime.
                    	AlignedStartTime *time.Time
                    
                    	// The dimension keys that were requested.
                    	Keys []types.DimensionKeyDescription
                    
                    	// 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.
                    	NextToken *string
                    
                    	// If PartitionBy was present in the request, PartitionKeys contains the breakdown
                    	// of dimension keys by the specified partitions.
                    	PartitionKeys []types.ResponsePartitionKey
                    
                    	// Metadata pertaining to the operation's result.
                    	ResultMetadata middleware.Metadata
                    }

                    type EndpointResolver

                    type EndpointResolver interface {
                    	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                    }

                      EndpointResolver interface for resolving service endpoints.

                      func EndpointResolverFromURL

                      func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                        EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                        type EndpointResolverFunc

                        type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                          EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                          func (EndpointResolverFunc) ResolveEndpoint

                          func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                          type EndpointResolverOptions

                          type EndpointResolverOptions = internalendpoints.Options

                            EndpointResolverOptions is the service endpoint resolver options

                            type GetResourceMetricsInput

                            type GetResourceMetricsInput struct {
                            
                            	// 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.
                            	//
                            	// This member is required.
                            	EndTime *time.Time
                            
                            	// 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
                            	//
                            	// This member is required.
                            	Identifier *string
                            
                            	// 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.
                            	//
                            	// This member is required.
                            	MetricQueries []types.MetricQuery
                            
                            	// The AWS service for which Performance Insights will return metrics. The only
                            	// valid value for ServiceType is: RDS
                            	//
                            	// This member is required.
                            	ServiceType types.ServiceType
                            
                            	// 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.
                            	//
                            	// This member is required.
                            	StartTime *time.Time
                            
                            	// 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.
                            	MaxResults *int32
                            
                            	// 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.
                            	NextToken *string
                            
                            	// 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.
                            	PeriodInSeconds *int32
                            }

                            type GetResourceMetricsOutput

                            type GetResourceMetricsOutput struct {
                            
                            	// The end time for the returned metrics, after alignment to a granular boundary
                            	// (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal
                            	// to the value of the user-specified Endtime.
                            	AlignedEndTime *time.Time
                            
                            	// The start time for the returned metrics, after alignment to a granular boundary
                            	// (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal
                            	// to the value of the user-specified StartTime.
                            	AlignedStartTime *time.Time
                            
                            	// 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 *string
                            
                            	// An array of metric results,, where each array element contains all of the data
                            	// points for a particular dimension.
                            	MetricList []types.MetricKeyDataPoints
                            
                            	// 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.
                            	NextToken *string
                            
                            	// Metadata pertaining to the operation's result.
                            	ResultMetadata middleware.Metadata
                            }

                            type HTTPClient

                            type HTTPClient interface {
                            	Do(*http.Request) (*http.Response, error)
                            }

                            type HTTPSignerV4

                            type HTTPSignerV4 interface {
                            	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                            }

                            type Options

                            type Options struct {
                            	// Set of options to modify how an operation is invoked. These apply to all
                            	// operations invoked for this client. Use functional options on operation call to
                            	// modify this list for per operation behavior.
                            	APIOptions []func(*middleware.Stack) error
                            
                            	// Configures the events that will be sent to the configured logger.
                            	ClientLogMode aws.ClientLogMode
                            
                            	// The credentials object to use when signing requests.
                            	Credentials aws.CredentialsProvider
                            
                            	// The endpoint options to be used when attempting to resolve an endpoint.
                            	EndpointOptions EndpointResolverOptions
                            
                            	// The service endpoint resolver.
                            	EndpointResolver EndpointResolver
                            
                            	// Signature Version 4 (SigV4) Signer
                            	HTTPSignerV4 HTTPSignerV4
                            
                            	// The logger writer interface to write logging messages to.
                            	Logger logging.Logger
                            
                            	// The region to send requests to. (Required)
                            	Region string
                            
                            	// Retryer guides how HTTP requests should be retried in case of recoverable
                            	// failures. When nil the API client will use a default retryer.
                            	Retryer aws.Retryer
                            
                            	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                            	// implementation if nil.
                            	HTTPClient HTTPClient
                            }

                            func (Options) Copy

                            func (o Options) Copy() Options

                              Copy creates a clone where the APIOptions list is deep copied.

                              type ResolveEndpoint

                              type ResolveEndpoint struct {
                              	Resolver EndpointResolver
                              	Options  EndpointResolverOptions
                              }

                              func (*ResolveEndpoint) HandleSerialize

                              func (*ResolveEndpoint) ID

                              func (*ResolveEndpoint) ID() string

                              Directories

                              Path Synopsis
                              internal