Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DataPoint

type DataPoint struct {

	// The time, in epoch format, associated with a particular Value.
	//
	// This member is required.
	Timestamp *time.Time

	// The actual value associated with a particular Timestamp.
	//
	// This member is required.
	Value *float64
}

    A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

    type DimensionGroup

    type DimensionGroup struct {
    
    	// The name of the dimension group. Valid values are:
    	//
    	// * db - The name of the
    	// database to which the client is connected (only Aurora PostgreSQL, RDS
    	// PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)
    	//
    	// * db.application - The name
    	// of the application that is connected to the database (only Aurora PostgreSQL and
    	// RDS PostgreSQL)
    	//
    	// * db.host - The host name of the connected client (all
    	// engines)
    	//
    	// * db.session_type - The type of the current session (only Aurora
    	// PostgreSQL and RDS PostgreSQL)
    	//
    	// * db.sql - The SQL that is currently executing
    	// (all engines)
    	//
    	// * db.sql_tokenized - The SQL digest (all engines)
    	//
    	// *
    	// db.wait_event - The event for which the database backend is waiting (all
    	// engines)
    	//
    	// * db.wait_event_type - The type of event for which the database
    	// backend is waiting (all engines)
    	//
    	// * db.user - The user logged in to the database
    	// (all engines)
    	//
    	// This member is required.
    	Group *string
    
    	// A list of specific dimensions from a dimension group. If this parameter is not
    	// present, then it signifies that all of the dimensions in the group were
    	// requested, or are present in the response. Valid values for elements in the
    	// Dimensions array are:
    	//
    	// * db.application.name - The name of the application that
    	// is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
    	//
    	// *
    	// db.host.id - The host ID of the connected client (all engines)
    	//
    	// * db.host.name -
    	// The host name of the connected client (all engines)
    	//
    	// * db.name - The name of the
    	// database to which the client is connected (only Aurora PostgreSQL, RDS
    	// PostgreSQL, Aurora MySQL, RDS MySQL, and MariaDB)
    	//
    	// * db.session_type.name - The
    	// type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
    	//
    	// *
    	// db.sql.id - The SQL ID generated by Performance Insights (all engines)
    	//
    	// *
    	// db.sql.db_id - The SQL ID generated by the database (all engines)
    	//
    	// *
    	// db.sql.statement - The SQL text that is being executed (all engines)
    	//
    	// *
    	// db.sql.tokenized_id
    	//
    	// * db.sql_tokenized.id - The SQL digest ID generated by
    	// Performance Insights (all engines)
    	//
    	// * db.sql_tokenized.db_id - SQL digest ID
    	// generated by the database (all engines)
    	//
    	// * db.sql_tokenized.statement - The SQL
    	// digest text (all engines)
    	//
    	// * db.user.id - The ID of the user logged in to the
    	// database (all engines)
    	//
    	// * db.user.name - The name of the user logged in to the
    	// database (all engines)
    	//
    	// * db.wait_event.name - The event for which the backend
    	// is waiting (all engines)
    	//
    	// * db.wait_event.type - The type of event for which the
    	// backend is waiting (all engines)
    	//
    	// * db.wait_event_type.name - The name of the
    	// event type for which the backend is waiting (all engines)
    	Dimensions []string
    
    	// The maximum number of items to fetch for this dimension group.
    	Limit *int32
    }

      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. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

      type DimensionKeyDescription

      type DimensionKeyDescription struct {
      
      	// A map of name-value pairs for the dimensions in the group.
      	Dimensions map[string]string
      
      	// If PartitionBy was specified, PartitionKeys contains the dimensions that were.
      	Partitions []float64
      
      	// The aggregated metric value for the dimension(s), over the requested time range.
      	Total *float64
      }

        An array of descriptions and aggregated values for each dimension within a dimension group.

        type InternalServiceError

        type InternalServiceError struct {
        	Message *string
        }

          The request failed due to an unknown error.

          func (*InternalServiceError) Error

          func (e *InternalServiceError) Error() string

          func (*InternalServiceError) ErrorCode

          func (e *InternalServiceError) ErrorCode() string

          func (*InternalServiceError) ErrorFault

          func (e *InternalServiceError) ErrorFault() smithy.ErrorFault

          func (*InternalServiceError) ErrorMessage

          func (e *InternalServiceError) ErrorMessage() string

          type InvalidArgumentException

          type InvalidArgumentException struct {
          	Message *string
          }

            One of the arguments provided is invalid for this request.

            func (*InvalidArgumentException) Error

            func (e *InvalidArgumentException) Error() string

            func (*InvalidArgumentException) ErrorCode

            func (e *InvalidArgumentException) ErrorCode() string

            func (*InvalidArgumentException) ErrorFault

            func (e *InvalidArgumentException) ErrorFault() smithy.ErrorFault

            func (*InvalidArgumentException) ErrorMessage

            func (e *InvalidArgumentException) ErrorMessage() string

            type MetricKeyDataPoints

            type MetricKeyDataPoints struct {
            
            	// An array of timestamp-value pairs, representing measurements over a period of
            	// time.
            	DataPoints []DataPoint
            
            	// The dimension(s) to which the data points apply.
            	Key *ResponseResourceMetricKey
            }

              A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

              type MetricQuery

              type MetricQuery struct {
              
              	// 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.
              	//
              	// This member is required.
              	Metric *string
              
              	// One or more filters to apply in the request. Restrictions:
              	//
              	// * Any number of
              	// filters by the same dimension, as specified in the GroupBy parameter.
              	//
              	// * A
              	// single filter for any other dimension in this dimension group.
              	Filter map[string]string
              
              	// 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.
              	GroupBy *DimensionGroup
              }

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

                type NotAuthorizedException

                type NotAuthorizedException struct {
                	Message *string
                }

                  The user is not authorized to perform this request.

                  func (*NotAuthorizedException) Error

                  func (e *NotAuthorizedException) Error() string

                  func (*NotAuthorizedException) ErrorCode

                  func (e *NotAuthorizedException) ErrorCode() string

                  func (*NotAuthorizedException) ErrorFault

                  func (e *NotAuthorizedException) ErrorFault() smithy.ErrorFault

                  func (*NotAuthorizedException) ErrorMessage

                  func (e *NotAuthorizedException) ErrorMessage() string

                  type ResponsePartitionKey

                  type ResponsePartitionKey struct {
                  
                  	// A dimension map that contains the dimension(s) for this partition.
                  	//
                  	// This member is required.
                  	Dimensions map[string]string
                  }

                    If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

                    type ResponseResourceMetricKey

                    type ResponseResourceMetricKey struct {
                    
                    	// 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.
                    	//
                    	// This member is required.
                    	Metric *string
                    
                    	// The valid dimensions for the metric.
                    	Dimensions map[string]string
                    }

                      An object describing a Performance Insights metric and one or more dimensions for that metric.

                      type ServiceType

                      type ServiceType string
                      const (
                      	ServiceTypeRds ServiceType = "RDS"
                      )

                        Enum values for ServiceType

                        func (ServiceType) Values

                        func (ServiceType) Values() []ServiceType

                          Values returns all known values for ServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.