...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/pi"
Overview
Constants

Overview ▾

Package pi provides the client and types for making API requests to AWS Performance Insights.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

See https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27 for more information on this service.

See pi package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/pi/

Using the Client

To contact AWS Performance Insights with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Performance Insights client PI for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/pi/#New

The stub package, piiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type PI
func New(p client.ConfigProvider, cfgs ...*aws.Config) *PI
func (c *PI) DescribeDimensionKeys(input *DescribeDimensionKeysInput) (*DescribeDimensionKeysOutput, error)
func (c *PI) DescribeDimensionKeysPages(input *DescribeDimensionKeysInput, fn func(*DescribeDimensionKeysOutput, bool) bool) error
func (c *PI) DescribeDimensionKeysPagesWithContext(ctx aws.Context, input *DescribeDimensionKeysInput, fn func(*DescribeDimensionKeysOutput, bool) bool, opts ...request.Option) error
func (c *PI) DescribeDimensionKeysRequest(input *DescribeDimensionKeysInput) (req *request.Request, output *DescribeDimensionKeysOutput)
func (c *PI) DescribeDimensionKeysWithContext(ctx aws.Context, input *DescribeDimensionKeysInput, opts ...request.Option) (*DescribeDimensionKeysOutput, error)
func (c *PI) GetDimensionKeyDetails(input *GetDimensionKeyDetailsInput) (*GetDimensionKeyDetailsOutput, error)
func (c *PI) GetDimensionKeyDetailsRequest(input *GetDimensionKeyDetailsInput) (req *request.Request, output *GetDimensionKeyDetailsOutput)
func (c *PI) GetDimensionKeyDetailsWithContext(ctx aws.Context, input *GetDimensionKeyDetailsInput, opts ...request.Option) (*GetDimensionKeyDetailsOutput, error)
func (c *PI) GetResourceMetadata(input *GetResourceMetadataInput) (*GetResourceMetadataOutput, error)
func (c *PI) GetResourceMetadataRequest(input *GetResourceMetadataInput) (req *request.Request, output *GetResourceMetadataOutput)
func (c *PI) GetResourceMetadataWithContext(ctx aws.Context, input *GetResourceMetadataInput, opts ...request.Option) (*GetResourceMetadataOutput, error)
func (c *PI) GetResourceMetrics(input *GetResourceMetricsInput) (*GetResourceMetricsOutput, error)
func (c *PI) GetResourceMetricsPages(input *GetResourceMetricsInput, fn func(*GetResourceMetricsOutput, bool) bool) error
func (c *PI) GetResourceMetricsPagesWithContext(ctx aws.Context, input *GetResourceMetricsInput, fn func(*GetResourceMetricsOutput, bool) bool, opts ...request.Option) error
func (c *PI) GetResourceMetricsRequest(input *GetResourceMetricsInput) (req *request.Request, output *GetResourceMetricsOutput)
func (c *PI) GetResourceMetricsWithContext(ctx aws.Context, input *GetResourceMetricsInput, opts ...request.Option) (*GetResourceMetricsOutput, error)
func (c *PI) ListAvailableResourceDimensions(input *ListAvailableResourceDimensionsInput) (*ListAvailableResourceDimensionsOutput, error)
func (c *PI) ListAvailableResourceDimensionsPages(input *ListAvailableResourceDimensionsInput, fn func(*ListAvailableResourceDimensionsOutput, bool) bool) error
func (c *PI) ListAvailableResourceDimensionsPagesWithContext(ctx aws.Context, input *ListAvailableResourceDimensionsInput, fn func(*ListAvailableResourceDimensionsOutput, bool) bool, opts ...request.Option) error
func (c *PI) ListAvailableResourceDimensionsRequest(input *ListAvailableResourceDimensionsInput) (req *request.Request, output *ListAvailableResourceDimensionsOutput)
func (c *PI) ListAvailableResourceDimensionsWithContext(ctx aws.Context, input *ListAvailableResourceDimensionsInput, opts ...request.Option) (*ListAvailableResourceDimensionsOutput, error)
func (c *PI) ListAvailableResourceMetrics(input *ListAvailableResourceMetricsInput) (*ListAvailableResourceMetricsOutput, error)
func (c *PI) ListAvailableResourceMetricsPages(input *ListAvailableResourceMetricsInput, fn func(*ListAvailableResourceMetricsOutput, bool) bool) error
func (c *PI) ListAvailableResourceMetricsPagesWithContext(ctx aws.Context, input *ListAvailableResourceMetricsInput, fn func(*ListAvailableResourceMetricsOutput, bool) bool, opts ...request.Option) error
func (c *PI) ListAvailableResourceMetricsRequest(input *ListAvailableResourceMetricsInput) (req *request.Request, output *ListAvailableResourceMetricsOutput)
func (c *PI) ListAvailableResourceMetricsWithContext(ctx aws.Context, input *ListAvailableResourceMetricsInput, opts ...request.Option) (*ListAvailableResourceMetricsOutput, error)
func DetailStatus_Values() []string
func FeatureStatus_Values() []string
func ServiceType_Values() []string
type DataPoint
type DescribeDimensionKeysInput
type DescribeDimensionKeysOutput
type DimensionDetail
type DimensionGroup
type DimensionGroupDetail
type DimensionKeyDescription
type DimensionKeyDetail
type FeatureMetadata
type GetDimensionKeyDetailsInput
type GetDimensionKeyDetailsOutput
type GetResourceMetadataInput
type GetResourceMetadataOutput
type GetResourceMetricsInput
type GetResourceMetricsOutput
type InternalServiceError
type InvalidArgumentException
type ListAvailableResourceDimensionsInput
type ListAvailableResourceDimensionsOutput
type ListAvailableResourceMetricsInput
type ListAvailableResourceMetricsOutput
type MetricDimensionGroups
type MetricKeyDataPoints
type MetricQuery
type NotAuthorizedException
type ResponsePartitionKey
type ResponseResourceMetric
type ResponseResourceMetricKey

Constants ▾

const (
    // DetailStatusAvailable is a DetailStatus enum value
    DetailStatusAvailable = "AVAILABLE"

    // DetailStatusProcessing is a DetailStatus enum value
    DetailStatusProcessing = "PROCESSING"

    // DetailStatusUnavailable is a DetailStatus enum value
    DetailStatusUnavailable = "UNAVAILABLE"
)
const (
    // FeatureStatusEnabled is a FeatureStatus enum value
    FeatureStatusEnabled = "ENABLED"

    // FeatureStatusDisabled is a FeatureStatus enum value
    FeatureStatusDisabled = "DISABLED"

    // FeatureStatusUnsupported is a FeatureStatus enum value
    FeatureStatusUnsupported = "UNSUPPORTED"

    // FeatureStatusEnabledPendingReboot is a FeatureStatus enum value
    FeatureStatusEnabledPendingReboot = "ENABLED_PENDING_REBOOT"

    // FeatureStatusDisabledPendingReboot is a FeatureStatus enum value
    FeatureStatusDisabledPendingReboot = "DISABLED_PENDING_REBOOT"

    // FeatureStatusUnknown is a FeatureStatus enum value
    FeatureStatusUnknown = "UNKNOWN"
)
const (
    // ServiceTypeRds is a ServiceType enum value
    ServiceTypeRds = "RDS"

    // ServiceTypeDocdb is a ServiceType enum value
    ServiceTypeDocdb = "DOCDB"
)
const (

    // ErrCodeInternalServiceError for service response error code
    // "InternalServiceError".
    //
    // The request failed due to an unknown error.
    ErrCodeInternalServiceError = "InternalServiceError"

    // ErrCodeInvalidArgumentException for service response error code
    // "InvalidArgumentException".
    //
    // One of the arguments provided is invalid for this request.
    ErrCodeInvalidArgumentException = "InvalidArgumentException"

    // ErrCodeNotAuthorizedException for service response error code
    // "NotAuthorizedException".
    //
    // The user is not authorized to perform this request.
    ErrCodeNotAuthorizedException = "NotAuthorizedException"
)
const (
    ServiceName = "pi"        // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "PI"        // ServiceID is a unique identifier of a specific service.
)

Service information constants

func DetailStatus_Values

func DetailStatus_Values() []string

DetailStatus_Values returns all elements of the DetailStatus enum

func FeatureStatus_Values

func FeatureStatus_Values() []string

FeatureStatus_Values returns all elements of the FeatureStatus enum

func ServiceType_Values

func ServiceType_Values() []string

ServiceType_Values returns all elements of the ServiceType enum

type DataPoint

type DataPoint struct {

    // The time, in epoch format, associated with a particular Value.
    //
    // Timestamp is a required field
    Timestamp *time.Time `type:"timestamp" required:"true"`

    // The actual value associated with a particular Timestamp.
    //
    // Value is a required field
    Value *float64 `type:"double" required:"true"`
    // contains filtered or unexported fields
}

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

func (DataPoint) GoString

func (s DataPoint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataPoint) SetTimestamp

func (s *DataPoint) SetTimestamp(v time.Time) *DataPoint

SetTimestamp sets the Timestamp field's value.

func (*DataPoint) SetValue

func (s *DataPoint) SetValue(v float64) *DataPoint

SetValue sets the Value field's value.

func (DataPoint) String

func (s DataPoint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDimensionKeysInput

type DescribeDimensionKeysInput struct {

    // Additional metrics for the top N dimension keys. If the specified dimension
    // group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL
    // metrics to get the values for the top N SQL digests. The response syntax
    // is as follows: "AdditionalMetrics" : { "string" : "string" }.
    AdditionalMetrics []*string `min:"1" type:"list"`

    // The date and time specifying the end of the requested time series data. The
    // value specified is exclusive, which means that data points less than (but
    // not equal to) EndTime are returned.
    //
    // The value for EndTime must be later than the value for StartTime.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" required:"true"`

    // 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 `type:"map"`

    // A specification for how to aggregate the data points from a query result.
    // You must specify a valid dimension group. Performance Insights returns all
    // dimensions within this group, unless you provide the names of specific dimensions
    // within this group. You can also request that Performance Insights return
    // a limited number of values for a dimension.
    //
    // GroupBy is a required field
    GroupBy *DimensionGroup `type:"structure" required:"true"`

    // An immutable, Amazon Web Services 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, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
    //
    // Identifier is a required field
    Identifier *string `type:"string" required:"true"`

    // 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 *int64 `type:"integer"`

    // 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.
    //
    // Metric is a required field
    Metric *string `type:"string" required:"true"`

    // 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 `min:"1" type:"string"`

    // For each dimension specified in GroupBy, specify a secondary dimension to
    // further subdivide the partition keys in the response.
    PartitionBy *DimensionGroup `type:"structure"`

    // 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 chooses a
    // value for you, with a goal of returning roughly 100-200 data points in the
    // response.
    PeriodInSeconds *int64 `type:"integer"`

    // The Amazon Web Services service for which Performance Insights will return
    // metrics. Valid values are as follows:
    //
    //    * RDS
    //
    //    * DOCDB
    //
    // ServiceType is a required field
    ServiceType *string `type:"string" required:"true" enum:"ServiceType"`

    // The date and time specifying the beginning of the requested time series data.
    // You must specify a StartTime within the past 7 days. The value specified
    // is inclusive, which means that data points equal to or greater than StartTime
    // are returned.
    //
    // The value for StartTime must be earlier than the value for EndTime.
    //
    // StartTime is a required field
    StartTime *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeDimensionKeysInput) GoString

func (s DescribeDimensionKeysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDimensionKeysInput) SetAdditionalMetrics

func (s *DescribeDimensionKeysInput) SetAdditionalMetrics(v []*string) *DescribeDimensionKeysInput

SetAdditionalMetrics sets the AdditionalMetrics field's value.

func (*DescribeDimensionKeysInput) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*DescribeDimensionKeysInput) SetFilter

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

SetFilter sets the Filter field's value.

func (*DescribeDimensionKeysInput) SetGroupBy

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

SetGroupBy sets the GroupBy field's value.

func (*DescribeDimensionKeysInput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*DescribeDimensionKeysInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeDimensionKeysInput) SetMetric

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

SetMetric sets the Metric field's value.

func (*DescribeDimensionKeysInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*DescribeDimensionKeysInput) SetPartitionBy

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

SetPartitionBy sets the PartitionBy field's value.

func (*DescribeDimensionKeysInput) SetPeriodInSeconds

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

SetPeriodInSeconds sets the PeriodInSeconds field's value.

func (*DescribeDimensionKeysInput) SetServiceType

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

SetServiceType sets the ServiceType field's value.

func (*DescribeDimensionKeysInput) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (DescribeDimensionKeysInput) String

func (s DescribeDimensionKeysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDimensionKeysInput) Validate

func (s *DescribeDimensionKeysInput) Validate() error

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

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 `type:"timestamp"`

    // 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 `type:"timestamp"`

    // The dimension keys that were requested.
    Keys []*DimensionKeyDescription `type:"list"`

    // A pagination token that indicates the response didn’t return all available
    // records because MaxRecords was specified in the previous request. To get
    // the remaining records, specify NextToken in a separate request with this
    // value.
    NextToken *string `min:"1" type:"string"`

    // If PartitionBy was present in the request, PartitionKeys contains the breakdown
    // of dimension keys by the specified partitions.
    PartitionKeys []*ResponsePartitionKey `type:"list"`
    // contains filtered or unexported fields
}

func (DescribeDimensionKeysOutput) GoString

func (s DescribeDimensionKeysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDimensionKeysOutput) SetAlignedEndTime

func (s *DescribeDimensionKeysOutput) SetAlignedEndTime(v time.Time) *DescribeDimensionKeysOutput

SetAlignedEndTime sets the AlignedEndTime field's value.

func (*DescribeDimensionKeysOutput) SetAlignedStartTime

func (s *DescribeDimensionKeysOutput) SetAlignedStartTime(v time.Time) *DescribeDimensionKeysOutput

SetAlignedStartTime sets the AlignedStartTime field's value.

func (*DescribeDimensionKeysOutput) SetKeys

func (s *DescribeDimensionKeysOutput) SetKeys(v []*DimensionKeyDescription) *DescribeDimensionKeysOutput

SetKeys sets the Keys field's value.

func (*DescribeDimensionKeysOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*DescribeDimensionKeysOutput) SetPartitionKeys

func (s *DescribeDimensionKeysOutput) SetPartitionKeys(v []*ResponsePartitionKey) *DescribeDimensionKeysOutput

SetPartitionKeys sets the PartitionKeys field's value.

func (DescribeDimensionKeysOutput) String

func (s DescribeDimensionKeysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DimensionDetail

type DimensionDetail struct {

    // The identifier of a dimension.
    Identifier *string `type:"string"`
    // contains filtered or unexported fields
}

The information about a dimension.

func (DimensionDetail) GoString

func (s DimensionDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionDetail) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (DimensionDetail) String

func (s DimensionDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DimensionGroup

type DimensionGroup struct {

    // 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. Valid values are as follows: Aurora PostgreSQL Amazon
    //    RDS PostgreSQL Amazon DocumentDB
    //
    //    * 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.
    //    Valid values are as follows: Aurora PostgreSQL Amazon RDS PostgreSQL Aurora
    //    MySQL Amazon RDS MySQL Amazon RDS MariaDB Amazon DocumentDB
    //
    //    * db.query.id - The query ID generated by Performance Insights (only Amazon
    //    DocumentDB).
    //
    //    * db.query.db_id - The query ID generated by the database (only Amazon
    //    DocumentDB).
    //
    //    * db.query.statement - The text of the query that is being run (only Amazon
    //    DocumentDB).
    //
    //    * db.query.tokenized_id
    //
    //    * db.query.tokenized.id - The query digest ID generated by Performance
    //    Insights (only Amazon DocumentDB).
    //
    //    * db.query.tokenized.db_id - The query digest ID generated by Performance
    //    Insights (only Amazon DocumentDB).
    //
    //    * db.query.tokenized.statement - The text of the query digest (only Amazon
    //    DocumentDB).
    //
    //    * db.session_type.name - The type of the current session (only Amazon
    //    DocumentDB).
    //
    //    * db.sql.id - The hash of the full, non-tokenized SQL statement generated
    //    by Performance Insights (all engines except Amazon DocumentDB).
    //
    //    * db.sql.db_id - Either the SQL ID generated by the database engine, or
    //    a value generated by Performance Insights that begins with pi- (all engines
    //    except Amazon DocumentDB).
    //
    //    * db.sql.statement - The full text of the SQL statement that is running,
    //    as in SELECT * FROM employees (all engines except Amazon DocumentDB)
    //
    //    * db.sql.tokenized_id
    //
    //    * db.sql_tokenized.id - The hash of the SQL digest generated by Performance
    //    Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id
    //    is called the Support ID because Amazon Web Services Support can look
    //    at this data to help you troubleshoot database issues.
    //
    //    * db.sql_tokenized.db_id - Either the native database ID used to refer
    //    to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance
    //    Insights generates if the native database ID isn't available (all engines
    //    except Amazon DocumentDB).
    //
    //    * db.sql_tokenized.statement - The text of the SQL digest, as in SELECT
    //    * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)
    //
    //    * db.user.id - The ID of the user logged in to the database (all engines
    //    except Amazon DocumentDB).
    //
    //    * db.user.name - The name of the user logged in to the database (all engines
    //    except Amazon DocumentDB).
    //
    //    * db.wait_event.name - The event for which the backend is waiting (all
    //    engines except Amazon DocumentDB).
    //
    //    * db.wait_event.type - The type of event for which the backend is waiting
    //    (all engines except Amazon DocumentDB).
    //
    //    * db.wait_event_type.name - The name of the event type for which the backend
    //    is waiting (all engines except Amazon DocumentDB).
    //
    //    * db.wait_state.name - The event for which the backend is waiting (only
    //    Amazon DocumentDB).
    Dimensions []*string `min:"1" type:"list"`

    // The name of the dimension group. Valid values are as follows:
    //
    //    * db - The name of the database to which the client is connected. The
    //    following values are permitted: Aurora PostgreSQL Amazon RDS PostgreSQL
    //    Aurora MySQL Amazon RDS MySQL Amazon RDS MariaDB Amazon DocumentDB
    //
    //    * db.application - The name of the application that is connected to the
    //    database. The following values are permitted: Aurora PostgreSQL Amazon
    //    RDS PostgreSQL Amazon DocumentDB
    //
    //    * db.host - The host name of the connected client (all engines).
    //
    //    * db.query - The query that is currently running (only Amazon DocumentDB).
    //
    //    * db.query_tokenized - The digest query (only Amazon DocumentDB).
    //
    //    * db.session_type - The type of the current session (only Aurora PostgreSQL
    //    and RDS PostgreSQL).
    //
    //    * db.sql - The text of the SQL statement that is currently running (all
    //    engines except Amazon DocumentDB).
    //
    //    * db.sql_tokenized - The SQL digest (all engines except Amazon DocumentDB).
    //
    //    * db.user - The user logged in to the database (all engines except Amazon
    //    DocumentDB).
    //
    //    * db.wait_event - The event for which the database backend is waiting
    //    (all engines except Amazon DocumentDB).
    //
    //    * db.wait_event_type - The type of event for which the database backend
    //    is waiting (all engines except Amazon DocumentDB).
    //
    //    * db.wait_state - The event for which the database backend is waiting
    //    (only Amazon DocumentDB).
    //
    // Group is a required field
    Group *string `type:"string" required:"true"`

    // The maximum number of items to fetch for this dimension group.
    Limit *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

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 - The hash of a running SQL statement, generated by Performance Insights.

  • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.

  • db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.

  • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

func (DimensionGroup) GoString

func (s DimensionGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionGroup) SetDimensions

func (s *DimensionGroup) SetDimensions(v []*string) *DimensionGroup

SetDimensions sets the Dimensions field's value.

func (*DimensionGroup) SetGroup

func (s *DimensionGroup) SetGroup(v string) *DimensionGroup

SetGroup sets the Group field's value.

func (*DimensionGroup) SetLimit

func (s *DimensionGroup) SetLimit(v int64) *DimensionGroup

SetLimit sets the Limit field's value.

func (DimensionGroup) String

func (s DimensionGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionGroup) Validate

func (s *DimensionGroup) Validate() error

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

type DimensionGroupDetail

type DimensionGroupDetail struct {

    // The dimensions within a dimension group.
    Dimensions []*DimensionDetail `type:"list"`

    // The name of the dimension group.
    Group *string `type:"string"`
    // contains filtered or unexported fields
}

Information about dimensions within a dimension group.

func (DimensionGroupDetail) GoString

func (s DimensionGroupDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionGroupDetail) SetDimensions

func (s *DimensionGroupDetail) SetDimensions(v []*DimensionDetail) *DimensionGroupDetail

SetDimensions sets the Dimensions field's value.

func (*DimensionGroupDetail) SetGroup

func (s *DimensionGroupDetail) SetGroup(v string) *DimensionGroupDetail

SetGroup sets the Group field's value.

func (DimensionGroupDetail) String

func (s DimensionGroupDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DimensionKeyDescription

type DimensionKeyDescription struct {

    // A map that contains the value for each additional metric.
    AdditionalMetrics map[string]*float64 `type:"map"`

    // A map of name-value pairs for the dimensions in the group.
    Dimensions map[string]*string `type:"map"`

    // If PartitionBy was specified, PartitionKeys contains the dimensions that
    // were.
    Partitions []*float64 `type:"list"`

    // The aggregated metric value for the dimensions, over the requested time range.
    Total *float64 `type:"double"`
    // contains filtered or unexported fields
}

An object that includes the requested dimension key values and aggregated metric values within a dimension group.

func (DimensionKeyDescription) GoString

func (s DimensionKeyDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionKeyDescription) SetAdditionalMetrics

func (s *DimensionKeyDescription) SetAdditionalMetrics(v map[string]*float64) *DimensionKeyDescription

SetAdditionalMetrics sets the AdditionalMetrics field's value.

func (*DimensionKeyDescription) SetDimensions

func (s *DimensionKeyDescription) SetDimensions(v map[string]*string) *DimensionKeyDescription

SetDimensions sets the Dimensions field's value.

func (*DimensionKeyDescription) SetPartitions

func (s *DimensionKeyDescription) SetPartitions(v []*float64) *DimensionKeyDescription

SetPartitions sets the Partitions field's value.

func (*DimensionKeyDescription) SetTotal

func (s *DimensionKeyDescription) SetTotal(v float64) *DimensionKeyDescription

SetTotal sets the Total field's value.

func (DimensionKeyDescription) String

func (s DimensionKeyDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DimensionKeyDetail

type DimensionKeyDetail struct {

    // The full name of the dimension. The full name includes the group name and
    // key name. The following values are valid:
    //
    //    * db.query.statement (Amazon DocumentDB)
    //
    //    * db.sql.statement (Amazon RDS and Aurora)
    Dimension *string `type:"string"`

    // The status of the dimension detail data. Possible values include the following:
    //
    //    * AVAILABLE - The dimension detail data is ready to be retrieved.
    //
    //    * PROCESSING - The dimension detail data isn't ready to be retrieved because
    //    more processing time is required. If the requested detail data has the
    //    status PROCESSING, Performance Insights returns the truncated query.
    //
    //    * UNAVAILABLE - The dimension detail data could not be collected successfully.
    Status *string `type:"string" enum:"DetailStatus"`

    // The value of the dimension detail data. Depending on the return status, this
    // value is either the full or truncated SQL query for the following dimensions:
    //
    //    * db.query.statement (Amazon DocumentDB)
    //
    //    * db.sql.statement (Amazon RDS and Aurora)
    Value *string `type:"string"`
    // contains filtered or unexported fields
}

An object that describes the details for a specified dimension.

func (DimensionKeyDetail) GoString

func (s DimensionKeyDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DimensionKeyDetail) SetDimension

func (s *DimensionKeyDetail) SetDimension(v string) *DimensionKeyDetail

SetDimension sets the Dimension field's value.

func (*DimensionKeyDetail) SetStatus

func (s *DimensionKeyDetail) SetStatus(v string) *DimensionKeyDetail

SetStatus sets the Status field's value.

func (*DimensionKeyDetail) SetValue

func (s *DimensionKeyDetail) SetValue(v string) *DimensionKeyDetail

SetValue sets the Value field's value.

func (DimensionKeyDetail) String

func (s DimensionKeyDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FeatureMetadata

type FeatureMetadata struct {

    // The status of the feature on the DB instance. Possible values include the
    // following:
    //
    //    * ENABLED - The feature is enabled on the instance.
    //
    //    * DISABLED - The feature is disabled on the instance.
    //
    //    * UNSUPPORTED - The feature isn't supported on the instance.
    //
    //    * ENABLED_PENDING_REBOOT - The feature is enabled on the instance but
    //    requires a reboot to take effect.
    //
    //    * DISABLED_PENDING_REBOOT - The feature is disabled on the instance but
    //    requires a reboot to take effect.
    //
    //    * UNKNOWN - The feature status couldn't be determined.
    Status *string `type:"string" enum:"FeatureStatus"`
    // contains filtered or unexported fields
}

The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

func (FeatureMetadata) GoString

func (s FeatureMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FeatureMetadata) SetStatus

func (s *FeatureMetadata) SetStatus(v string) *FeatureMetadata

SetStatus sets the Status field's value.

func (FeatureMetadata) String

func (s FeatureMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDimensionKeyDetailsInput

type GetDimensionKeyDetailsInput struct {

    // The name of the dimension group. Performance Insights searches the specified
    // group for the dimension group ID. The following group name values are valid:
    //
    //    * db.query (Amazon DocumentDB only)
    //
    //    * db.sql (Amazon RDS and Aurora only)
    //
    // Group is a required field
    Group *string `type:"string" required:"true"`

    // The ID of the dimension group from which to retrieve dimension details. For
    // dimension group db.sql, the group ID is db.sql.id. The following group ID
    // values are valid:
    //
    //    * db.sql.id for dimension group db.sql (Aurora and RDS only)
    //
    //    * db.query.id for dimension group db.query (DocumentDB only)
    //
    // GroupIdentifier is a required field
    GroupIdentifier *string `type:"string" required:"true"`

    // The ID for a data source from which to gather dimension data. This ID must
    // be immutable and unique within an Amazon Web Services Region. When a DB instance
    // is the data source, specify its DbiResourceId value. For example, specify
    // db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
    //
    // Identifier is a required field
    Identifier *string `type:"string" required:"true"`

    // A list of dimensions to retrieve the detail data for within the given dimension
    // group. If you don't specify this parameter, Performance Insights returns
    // all dimension data within the specified dimension group. Specify dimension
    // names for the following dimension groups:
    //
    //    * db.sql - Specify either the full dimension name db.sql.statement or
    //    the short dimension name statement (Aurora and RDS only).
    //
    //    * db.query - Specify either the full dimension name db.query.statement
    //    or the short dimension name statement (DocumentDB only).
    RequestedDimensions []*string `min:"1" type:"list"`

    // The Amazon Web Services service for which Performance Insights returns data.
    // The only valid value is RDS.
    //
    // ServiceType is a required field
    ServiceType *string `type:"string" required:"true" enum:"ServiceType"`
    // contains filtered or unexported fields
}

func (GetDimensionKeyDetailsInput) GoString

func (s GetDimensionKeyDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDimensionKeyDetailsInput) SetGroup

func (s *GetDimensionKeyDetailsInput) SetGroup(v string) *GetDimensionKeyDetailsInput

SetGroup sets the Group field's value.

func (*GetDimensionKeyDetailsInput) SetGroupIdentifier

func (s *GetDimensionKeyDetailsInput) SetGroupIdentifier(v string) *GetDimensionKeyDetailsInput

SetGroupIdentifier sets the GroupIdentifier field's value.

func (*GetDimensionKeyDetailsInput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*GetDimensionKeyDetailsInput) SetRequestedDimensions

func (s *GetDimensionKeyDetailsInput) SetRequestedDimensions(v []*string) *GetDimensionKeyDetailsInput

SetRequestedDimensions sets the RequestedDimensions field's value.

func (*GetDimensionKeyDetailsInput) SetServiceType

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

SetServiceType sets the ServiceType field's value.

func (GetDimensionKeyDetailsInput) String

func (s GetDimensionKeyDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDimensionKeyDetailsInput) Validate

func (s *GetDimensionKeyDetailsInput) Validate() error

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

type GetDimensionKeyDetailsOutput

type GetDimensionKeyDetailsOutput struct {

    // The details for the requested dimensions.
    Dimensions []*DimensionKeyDetail `type:"list"`
    // contains filtered or unexported fields
}

func (GetDimensionKeyDetailsOutput) GoString

func (s GetDimensionKeyDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDimensionKeyDetailsOutput) SetDimensions

func (s *GetDimensionKeyDetailsOutput) SetDimensions(v []*DimensionKeyDetail) *GetDimensionKeyDetailsOutput

SetDimensions sets the Dimensions field's value.

func (GetDimensionKeyDetailsOutput) String

func (s GetDimensionKeyDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetResourceMetadataInput

type GetResourceMetadataInput struct {

    // An immutable identifier for a data source that is unique for an Amazon Web
    // Services Region. 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-ABCDEFGHIJKLMNOPQRSTU1VW2X.
    //
    // Identifier is a required field
    Identifier *string `type:"string" required:"true"`

    // The Amazon Web Services service for which Performance Insights returns metrics.
    //
    // ServiceType is a required field
    ServiceType *string `type:"string" required:"true" enum:"ServiceType"`
    // contains filtered or unexported fields
}

func (GetResourceMetadataInput) GoString

func (s GetResourceMetadataInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourceMetadataInput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*GetResourceMetadataInput) SetServiceType

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

SetServiceType sets the ServiceType field's value.

func (GetResourceMetadataInput) String

func (s GetResourceMetadataInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourceMetadataInput) Validate

func (s *GetResourceMetadataInput) Validate() error

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

type GetResourceMetadataOutput

type GetResourceMetadataOutput struct {

    // The metadata for different features. For example, the metadata might indicate
    // that a feature is turned on or off on a specific DB instance.
    Features map[string]*FeatureMetadata `type:"map"`

    // An immutable identifier for a data source that is unique for an Amazon Web
    // Services Region. 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-ABCDEFGHIJKLMNOPQRSTU1VW2X.
    Identifier *string `type:"string"`
    // contains filtered or unexported fields
}

func (GetResourceMetadataOutput) GoString

func (s GetResourceMetadataOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourceMetadataOutput) SetFeatures

func (s *GetResourceMetadataOutput) SetFeatures(v map[string]*FeatureMetadata) *GetResourceMetadataOutput

SetFeatures sets the Features field's value.

func (*GetResourceMetadataOutput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (GetResourceMetadataOutput) String

func (s GetResourceMetadataOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetResourceMetricsInput

type GetResourceMetricsInput struct {

    // The date and time specifying the end of the requested time series query range.
    // The value specified is exclusive. Thus, the command returns data points less
    // than (but not equal to) EndTime.
    //
    // The value for EndTime must be later than the value for StartTime.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" required:"true"`

    // An immutable identifier for a data source that is unique for an Amazon Web
    // Services Region. Performance Insights gathers metrics from this data source.
    // In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances,
    // the identifier is returned as DbiResourceId.
    //
    // To use a DB instance as a data source, specify its DbiResourceId value. For
    // example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
    //
    // Identifier is a required field
    Identifier *string `type:"string" required:"true"`

    // 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 *int64 `type:"integer"`

    // 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.
    //
    // MetricQueries is a required field
    MetricQueries []*MetricQuery `min:"1" type:"list" required:"true"`

    // 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 `min:"1" type:"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 *int64 `type:"integer"`

    // The Amazon Web Services service for which Performance Insights returns metrics.
    // Valid values are as follows:
    //
    //    * RDS
    //
    //    * DOCDB
    //
    // ServiceType is a required field
    ServiceType *string `type:"string" required:"true" enum:"ServiceType"`

    // The date and time specifying the beginning of the requested time series query
    // range. You can't specify a StartTime that is earlier than 7 days ago. By
    // default, Performance Insights has 7 days of retention, but you can extend
    // this range up to 2 years. The value specified is inclusive. Thus, the command
    // returns data points equal to or greater than StartTime.
    //
    // The value for StartTime must be earlier than the value for EndTime.
    //
    // StartTime is a required field
    StartTime *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

func (GetResourceMetricsInput) GoString

func (s GetResourceMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourceMetricsInput) SetEndTime

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

SetEndTime sets the EndTime field's value.

func (*GetResourceMetricsInput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*GetResourceMetricsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*GetResourceMetricsInput) SetMetricQueries

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

SetMetricQueries sets the MetricQueries field's value.

func (*GetResourceMetricsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*GetResourceMetricsInput) SetPeriodInSeconds

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

SetPeriodInSeconds sets the PeriodInSeconds field's value.

func (*GetResourceMetricsInput) SetServiceType

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

SetServiceType sets the ServiceType field's value.

func (*GetResourceMetricsInput) SetStartTime

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

SetStartTime sets the StartTime field's value.

func (GetResourceMetricsInput) String

func (s GetResourceMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourceMetricsInput) Validate

func (s *GetResourceMetricsInput) Validate() error

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

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 `type:"timestamp"`

    // 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 `type:"timestamp"`

    // An immutable identifier for a data source that is unique for an Amazon Web
    // Services Region. Performance Insights gathers metrics from this data source.
    // In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances,
    // the identifier is returned as DbiResourceId.
    Identifier *string `type:"string"`

    // An array of metric results, where each array element contains all of the
    // data points for a particular dimension.
    MetricList []*MetricKeyDataPoints `type:"list"`

    // 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 `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetResourceMetricsOutput) GoString

func (s GetResourceMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetResourceMetricsOutput) SetAlignedEndTime

func (s *GetResourceMetricsOutput) SetAlignedEndTime(v time.Time) *GetResourceMetricsOutput

SetAlignedEndTime sets the AlignedEndTime field's value.

func (*GetResourceMetricsOutput) SetAlignedStartTime

func (s *GetResourceMetricsOutput) SetAlignedStartTime(v time.Time) *GetResourceMetricsOutput

SetAlignedStartTime sets the AlignedStartTime field's value.

func (*GetResourceMetricsOutput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*GetResourceMetricsOutput) SetMetricList

func (s *GetResourceMetricsOutput) SetMetricList(v []*MetricKeyDataPoints) *GetResourceMetricsOutput

SetMetricList sets the MetricList field's value.

func (*GetResourceMetricsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (GetResourceMetricsOutput) String

func (s GetResourceMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServiceError

type InternalServiceError struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

The request failed due to an unknown error.

func (*InternalServiceError) Code

func (s *InternalServiceError) Code() string

Code returns the exception type name.

func (*InternalServiceError) Error

func (s *InternalServiceError) Error() string

func (InternalServiceError) GoString

func (s InternalServiceError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServiceError) Message

func (s *InternalServiceError) Message() string

Message returns the exception's message.

func (*InternalServiceError) OrigErr

func (s *InternalServiceError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceError) RequestID

func (s *InternalServiceError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceError) StatusCode

func (s *InternalServiceError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServiceError) String

func (s InternalServiceError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidArgumentException

type InvalidArgumentException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

One of the arguments provided is invalid for this request.

func (*InvalidArgumentException) Code

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString

func (s InvalidArgumentException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidArgumentException) Message

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode

func (s *InvalidArgumentException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidArgumentException) String

func (s InvalidArgumentException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAvailableResourceDimensionsInput

type ListAvailableResourceDimensionsInput struct {

    // An immutable identifier for a data source that is unique within an Amazon
    // Web Services Region. Performance Insights gathers metrics from this data
    // source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
    // value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
    //
    // Identifier is a required field
    Identifier *string `type:"string" required:"true"`

    // 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 *int64 `type:"integer"`

    // The types of metrics for which to retrieve dimensions. Valid values include
    // db.load.
    //
    // Metrics is a required field
    Metrics []*string `min:"1" type:"list" required:"true"`

    // 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 `min:"1" type:"string"`

    // The Amazon Web Services service for which Performance Insights returns metrics.
    //
    // ServiceType is a required field
    ServiceType *string `type:"string" required:"true" enum:"ServiceType"`
    // contains filtered or unexported fields
}

func (ListAvailableResourceDimensionsInput) GoString

func (s ListAvailableResourceDimensionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableResourceDimensionsInput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*ListAvailableResourceDimensionsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListAvailableResourceDimensionsInput) SetMetrics

func (s *ListAvailableResourceDimensionsInput) SetMetrics(v []*string) *ListAvailableResourceDimensionsInput

SetMetrics sets the Metrics field's value.

func (*ListAvailableResourceDimensionsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListAvailableResourceDimensionsInput) SetServiceType

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

SetServiceType sets the ServiceType field's value.

func (ListAvailableResourceDimensionsInput) String

func (s ListAvailableResourceDimensionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableResourceDimensionsInput) Validate

func (s *ListAvailableResourceDimensionsInput) Validate() error

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

type ListAvailableResourceDimensionsOutput

type ListAvailableResourceDimensionsOutput struct {

    // The dimension information returned for requested metric types.
    MetricDimensions []*MetricDimensionGroups `type:"list"`

    // 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 `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAvailableResourceDimensionsOutput) GoString

func (s ListAvailableResourceDimensionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableResourceDimensionsOutput) SetMetricDimensions

func (s *ListAvailableResourceDimensionsOutput) SetMetricDimensions(v []*MetricDimensionGroups) *ListAvailableResourceDimensionsOutput

SetMetricDimensions sets the MetricDimensions field's value.

func (*ListAvailableResourceDimensionsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListAvailableResourceDimensionsOutput) String

func (s ListAvailableResourceDimensionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAvailableResourceMetricsInput

type ListAvailableResourceMetricsInput struct {

    // An immutable identifier for a data source that is unique within an Amazon
    // Web Services Region. Performance Insights gathers metrics from this data
    // source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId
    // value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
    //
    // Identifier is a required field
    Identifier *string `type:"string" required:"true"`

    // The maximum number of items to return. If the MaxRecords value is less than
    // the number of existing items, the response includes a pagination token.
    MaxResults *int64 `type:"integer"`

    // The types of metrics to return in the response. Valid values in the array
    // include the following:
    //
    //    * os (OS counter metrics) - All engines
    //
    //    * db (DB load metrics) - All engines except for Amazon DocumentDB
    //
    //    * db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB
    //
    //    * db.sql_tokenized.stats (per-SQL digest metrics) - All engines except
    //    for Amazon DocumentDB
    //
    // MetricTypes is a required field
    MetricTypes []*string `type:"list" required:"true"`

    // 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 `min:"1" type:"string"`

    // The Amazon Web Services service for which Performance Insights returns metrics.
    //
    // ServiceType is a required field
    ServiceType *string `type:"string" required:"true" enum:"ServiceType"`
    // contains filtered or unexported fields
}

func (ListAvailableResourceMetricsInput) GoString

func (s ListAvailableResourceMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableResourceMetricsInput) SetIdentifier

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

SetIdentifier sets the Identifier field's value.

func (*ListAvailableResourceMetricsInput) SetMaxResults

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

SetMaxResults sets the MaxResults field's value.

func (*ListAvailableResourceMetricsInput) SetMetricTypes

func (s *ListAvailableResourceMetricsInput) SetMetricTypes(v []*string) *ListAvailableResourceMetricsInput

SetMetricTypes sets the MetricTypes field's value.

func (*ListAvailableResourceMetricsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListAvailableResourceMetricsInput) SetServiceType

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

SetServiceType sets the ServiceType field's value.

func (ListAvailableResourceMetricsInput) String

func (s ListAvailableResourceMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableResourceMetricsInput) Validate

func (s *ListAvailableResourceMetricsInput) Validate() error

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

type ListAvailableResourceMetricsOutput

type ListAvailableResourceMetricsOutput struct {

    // An array of metrics available to query. Each array element contains the full
    // name, description, and unit of the metric.
    Metrics []*ResponseResourceMetric `type:"list"`

    // A pagination token that indicates the response didn’t return all available
    // records because MaxRecords was specified in the previous request. To get
    // the remaining records, specify NextToken in a separate request with this
    // value.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAvailableResourceMetricsOutput) GoString

func (s ListAvailableResourceMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableResourceMetricsOutput) SetMetrics

func (s *ListAvailableResourceMetricsOutput) SetMetrics(v []*ResponseResourceMetric) *ListAvailableResourceMetricsOutput

SetMetrics sets the Metrics field's value.

func (*ListAvailableResourceMetricsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListAvailableResourceMetricsOutput) String

func (s ListAvailableResourceMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricDimensionGroups

type MetricDimensionGroups struct {

    // The available dimension groups for a metric type.
    Groups []*DimensionGroupDetail `type:"list"`

    // The metric type to which the dimension information belongs.
    Metric *string `type:"string"`
    // contains filtered or unexported fields
}

The available dimension information for a metric type.

func (MetricDimensionGroups) GoString

func (s MetricDimensionGroups) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricDimensionGroups) SetGroups

func (s *MetricDimensionGroups) SetGroups(v []*DimensionGroupDetail) *MetricDimensionGroups

SetGroups sets the Groups field's value.

func (*MetricDimensionGroups) SetMetric

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

SetMetric sets the Metric field's value.

func (MetricDimensionGroups) String

func (s MetricDimensionGroups) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricKeyDataPoints

type MetricKeyDataPoints struct {

    // An array of timestamp-value pairs, representing measurements over a period
    // of time.
    DataPoints []*DataPoint `type:"list"`

    // The dimensions to which the data points apply.
    Key *ResponseResourceMetricKey `type:"structure"`
    // contains filtered or unexported fields
}

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

func (MetricKeyDataPoints) GoString

func (s MetricKeyDataPoints) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricKeyDataPoints) SetDataPoints

func (s *MetricKeyDataPoints) SetDataPoints(v []*DataPoint) *MetricKeyDataPoints

SetDataPoints sets the DataPoints field's value.

func (*MetricKeyDataPoints) SetKey

func (s *MetricKeyDataPoints) SetKey(v *ResponseResourceMetricKey) *MetricKeyDataPoints

SetKey sets the Key field's value.

func (MetricKeyDataPoints) String

func (s MetricKeyDataPoints) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MetricQuery

type MetricQuery struct {

    // 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 `type:"map"`

    // 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 `type:"structure"`

    // 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.
    //
    //    * The counter metrics listed in Performance Insights operating system
    //    counters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS)
    //    in the Amazon Aurora User Guide.
    //
    // 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.
    //
    // Metric is a required field
    Metric *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).

func (MetricQuery) GoString

func (s MetricQuery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricQuery) SetFilter

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

SetFilter sets the Filter field's value.

func (*MetricQuery) SetGroupBy

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

SetGroupBy sets the GroupBy field's value.

func (*MetricQuery) SetMetric

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

SetMetric sets the Metric field's value.

func (MetricQuery) String

func (s MetricQuery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricQuery) Validate

func (s *MetricQuery) Validate() error

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

type NotAuthorizedException

type NotAuthorizedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"Message" type:"string"`
    // contains filtered or unexported fields
}

The user is not authorized to perform this request.

func (*NotAuthorizedException) Code

func (s *NotAuthorizedException) Code() string

Code returns the exception type name.

func (*NotAuthorizedException) Error

func (s *NotAuthorizedException) Error() string

func (NotAuthorizedException) GoString

func (s NotAuthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotAuthorizedException) Message

func (s *NotAuthorizedException) Message() string

Message returns the exception's message.

func (*NotAuthorizedException) OrigErr

func (s *NotAuthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotAuthorizedException) RequestID

func (s *NotAuthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotAuthorizedException) StatusCode

func (s *NotAuthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotAuthorizedException) String

func (s NotAuthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PI

type PI struct {
    *client.Client
}

PI provides the API operation methods for making requests to AWS Performance Insights. See this package's package overview docs for details on the service.

PI methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *PI

New creates a new instance of the PI client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a PI client from just a session.
svc := pi.New(mySession)

// Create a PI client with additional configuration
svc := pi.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*PI) DescribeDimensionKeys

func (c *PI) DescribeDimensionKeys(input *DescribeDimensionKeysInput) (*DescribeDimensionKeysOutput, error)

DescribeDimensionKeys API operation for AWS Performance Insights.

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

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Performance Insights's API operation DescribeDimensionKeys for usage and error information.

Returned Error Types:

  • InvalidArgumentException One of the arguments provided is invalid for this request.

  • InternalServiceError The request failed due to an unknown error.

  • NotAuthorizedException The user is not authorized to perform this request.

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DescribeDimensionKeys

func (*PI) DescribeDimensionKeysPages

func (c *PI) DescribeDimensionKeysPages(input *DescribeDimensionKeysInput, fn func(*DescribeDimensionKeysOutput, bool) bool) error

DescribeDimensionKeysPages iterates over the pages of a DescribeDimensionKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeDimensionKeys method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a DescribeDimensionKeys operation.
pageNum := 0
err := client.DescribeDimensionKeysPages(params,
    func(page *pi.DescribeDimensionKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PI) DescribeDimensionKeysPagesWithContext

func (c *PI) DescribeDimensionKeysPagesWithContext(ctx aws.Context, input *DescribeDimensionKeysInput, fn func(*DescribeDimensionKeysOutput, bool) bool, opts ...request.Option) error

DescribeDimensionKeysPagesWithContext same as DescribeDimensionKeysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) DescribeDimensionKeysRequest

func (c *PI) DescribeDimensionKeysRequest(input *DescribeDimensionKeysInput) (req *request.Request, output *DescribeDimensionKeysOutput)

DescribeDimensionKeysRequest generates a "aws/request.Request" representing the client's request for the DescribeDimensionKeys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDimensionKeys for more information on using the DescribeDimensionKeys API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeDimensionKeysRequest method.
req, resp := client.DescribeDimensionKeysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DescribeDimensionKeys

func (*PI) DescribeDimensionKeysWithContext

func (c *PI) DescribeDimensionKeysWithContext(ctx aws.Context, input *DescribeDimensionKeysInput, opts ...request.Option) (*DescribeDimensionKeysOutput, error)

DescribeDimensionKeysWithContext is the same as DescribeDimensionKeys with the addition of the ability to pass a context and additional request options.

See DescribeDimensionKeys for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) GetDimensionKeyDetails

func (c *PI) GetDimensionKeyDetails(input *GetDimensionKeyDetailsInput) (*GetDimensionKeyDetailsOutput, error)

GetDimensionKeyDetails API operation for AWS Performance Insights.

Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Performance Insights's API operation GetDimensionKeyDetails for usage and error information.

Returned Error Types:

  • InvalidArgumentException One of the arguments provided is invalid for this request.

  • InternalServiceError The request failed due to an unknown error.

  • NotAuthorizedException The user is not authorized to perform this request.

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetails

func (*PI) GetDimensionKeyDetailsRequest

func (c *PI) GetDimensionKeyDetailsRequest(input *GetDimensionKeyDetailsInput) (req *request.Request, output *GetDimensionKeyDetailsOutput)

GetDimensionKeyDetailsRequest generates a "aws/request.Request" representing the client's request for the GetDimensionKeyDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDimensionKeyDetails for more information on using the GetDimensionKeyDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDimensionKeyDetailsRequest method.
req, resp := client.GetDimensionKeyDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetails

func (*PI) GetDimensionKeyDetailsWithContext

func (c *PI) GetDimensionKeyDetailsWithContext(ctx aws.Context, input *GetDimensionKeyDetailsInput, opts ...request.Option) (*GetDimensionKeyDetailsOutput, error)

GetDimensionKeyDetailsWithContext is the same as GetDimensionKeyDetails with the addition of the ability to pass a context and additional request options.

See GetDimensionKeyDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) GetResourceMetadata

func (c *PI) GetResourceMetadata(input *GetResourceMetadataInput) (*GetResourceMetadataOutput, error)

GetResourceMetadata API operation for AWS Performance Insights.

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Performance Insights's API operation GetResourceMetadata for usage and error information.

Returned Error Types:

  • InvalidArgumentException One of the arguments provided is invalid for this request.

  • InternalServiceError The request failed due to an unknown error.

  • NotAuthorizedException The user is not authorized to perform this request.

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetadata

func (*PI) GetResourceMetadataRequest

func (c *PI) GetResourceMetadataRequest(input *GetResourceMetadataInput) (req *request.Request, output *GetResourceMetadataOutput)

GetResourceMetadataRequest generates a "aws/request.Request" representing the client's request for the GetResourceMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetResourceMetadata for more information on using the GetResourceMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetResourceMetadataRequest method.
req, resp := client.GetResourceMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetadata

func (*PI) GetResourceMetadataWithContext

func (c *PI) GetResourceMetadataWithContext(ctx aws.Context, input *GetResourceMetadataInput, opts ...request.Option) (*GetResourceMetadataOutput, error)

GetResourceMetadataWithContext is the same as GetResourceMetadata with the addition of the ability to pass a context and additional request options.

See GetResourceMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) GetResourceMetrics

func (c *PI) GetResourceMetrics(input *GetResourceMetricsInput) (*GetResourceMetricsOutput, error)

GetResourceMetrics API operation for AWS Performance Insights.

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.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Performance Insights's API operation GetResourceMetrics for usage and error information.

Returned Error Types:

  • InvalidArgumentException One of the arguments provided is invalid for this request.

  • InternalServiceError The request failed due to an unknown error.

  • NotAuthorizedException The user is not authorized to perform this request.

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetrics

func (*PI) GetResourceMetricsPages

func (c *PI) GetResourceMetricsPages(input *GetResourceMetricsInput, fn func(*GetResourceMetricsOutput, bool) bool) error

GetResourceMetricsPages iterates over the pages of a GetResourceMetrics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetResourceMetrics method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetResourceMetrics operation.
pageNum := 0
err := client.GetResourceMetricsPages(params,
    func(page *pi.GetResourceMetricsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PI) GetResourceMetricsPagesWithContext

func (c *PI) GetResourceMetricsPagesWithContext(ctx aws.Context, input *GetResourceMetricsInput, fn func(*GetResourceMetricsOutput, bool) bool, opts ...request.Option) error

GetResourceMetricsPagesWithContext same as GetResourceMetricsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) GetResourceMetricsRequest

func (c *PI) GetResourceMetricsRequest(input *GetResourceMetricsInput) (req *request.Request, output *GetResourceMetricsOutput)

GetResourceMetricsRequest generates a "aws/request.Request" representing the client's request for the GetResourceMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetResourceMetrics for more information on using the GetResourceMetrics API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetResourceMetricsRequest method.
req, resp := client.GetResourceMetricsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetrics

func (*PI) GetResourceMetricsWithContext

func (c *PI) GetResourceMetricsWithContext(ctx aws.Context, input *GetResourceMetricsInput, opts ...request.Option) (*GetResourceMetricsOutput, error)

GetResourceMetricsWithContext is the same as GetResourceMetrics with the addition of the ability to pass a context and additional request options.

See GetResourceMetrics for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) ListAvailableResourceDimensions

func (c *PI) ListAvailableResourceDimensions(input *ListAvailableResourceDimensionsInput) (*ListAvailableResourceDimensionsOutput, error)

ListAvailableResourceDimensions API operation for AWS Performance Insights.

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Performance Insights's API operation ListAvailableResourceDimensions for usage and error information.

Returned Error Types:

  • InvalidArgumentException One of the arguments provided is invalid for this request.

  • InternalServiceError The request failed due to an unknown error.

  • NotAuthorizedException The user is not authorized to perform this request.

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceDimensions

func (*PI) ListAvailableResourceDimensionsPages

func (c *PI) ListAvailableResourceDimensionsPages(input *ListAvailableResourceDimensionsInput, fn func(*ListAvailableResourceDimensionsOutput, bool) bool) error

ListAvailableResourceDimensionsPages iterates over the pages of a ListAvailableResourceDimensions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAvailableResourceDimensions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAvailableResourceDimensions operation.
pageNum := 0
err := client.ListAvailableResourceDimensionsPages(params,
    func(page *pi.ListAvailableResourceDimensionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PI) ListAvailableResourceDimensionsPagesWithContext

func (c *PI) ListAvailableResourceDimensionsPagesWithContext(ctx aws.Context, input *ListAvailableResourceDimensionsInput, fn func(*ListAvailableResourceDimensionsOutput, bool) bool, opts ...request.Option) error

ListAvailableResourceDimensionsPagesWithContext same as ListAvailableResourceDimensionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) ListAvailableResourceDimensionsRequest

func (c *PI) ListAvailableResourceDimensionsRequest(input *ListAvailableResourceDimensionsInput) (req *request.Request, output *ListAvailableResourceDimensionsOutput)

ListAvailableResourceDimensionsRequest generates a "aws/request.Request" representing the client's request for the ListAvailableResourceDimensions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAvailableResourceDimensions for more information on using the ListAvailableResourceDimensions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAvailableResourceDimensionsRequest method.
req, resp := client.ListAvailableResourceDimensionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceDimensions

func (*PI) ListAvailableResourceDimensionsWithContext

func (c *PI) ListAvailableResourceDimensionsWithContext(ctx aws.Context, input *ListAvailableResourceDimensionsInput, opts ...request.Option) (*ListAvailableResourceDimensionsOutput, error)

ListAvailableResourceDimensionsWithContext is the same as ListAvailableResourceDimensions with the addition of the ability to pass a context and additional request options.

See ListAvailableResourceDimensions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) ListAvailableResourceMetrics

func (c *PI) ListAvailableResourceMetrics(input *ListAvailableResourceMetricsInput) (*ListAvailableResourceMetricsOutput, error)

ListAvailableResourceMetrics API operation for AWS Performance Insights.

Retrieve metrics of the specified types that can be queried for a specified DB instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Performance Insights's API operation ListAvailableResourceMetrics for usage and error information.

Returned Error Types:

  • InvalidArgumentException One of the arguments provided is invalid for this request.

  • InternalServiceError The request failed due to an unknown error.

  • NotAuthorizedException The user is not authorized to perform this request.

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceMetrics

func (*PI) ListAvailableResourceMetricsPages

func (c *PI) ListAvailableResourceMetricsPages(input *ListAvailableResourceMetricsInput, fn func(*ListAvailableResourceMetricsOutput, bool) bool) error

ListAvailableResourceMetricsPages iterates over the pages of a ListAvailableResourceMetrics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAvailableResourceMetrics method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAvailableResourceMetrics operation.
pageNum := 0
err := client.ListAvailableResourceMetricsPages(params,
    func(page *pi.ListAvailableResourceMetricsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PI) ListAvailableResourceMetricsPagesWithContext

func (c *PI) ListAvailableResourceMetricsPagesWithContext(ctx aws.Context, input *ListAvailableResourceMetricsInput, fn func(*ListAvailableResourceMetricsOutput, bool) bool, opts ...request.Option) error

ListAvailableResourceMetricsPagesWithContext same as ListAvailableResourceMetricsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PI) ListAvailableResourceMetricsRequest

func (c *PI) ListAvailableResourceMetricsRequest(input *ListAvailableResourceMetricsInput) (req *request.Request, output *ListAvailableResourceMetricsOutput)

ListAvailableResourceMetricsRequest generates a "aws/request.Request" representing the client's request for the ListAvailableResourceMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAvailableResourceMetrics for more information on using the ListAvailableResourceMetrics API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAvailableResourceMetricsRequest method.
req, resp := client.ListAvailableResourceMetricsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceMetrics

func (*PI) ListAvailableResourceMetricsWithContext

func (c *PI) ListAvailableResourceMetricsWithContext(ctx aws.Context, input *ListAvailableResourceMetricsInput, opts ...request.Option) (*ListAvailableResourceMetricsOutput, error)

ListAvailableResourceMetricsWithContext is the same as ListAvailableResourceMetrics with the addition of the ability to pass a context and additional request options.

See ListAvailableResourceMetrics for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ResponsePartitionKey

type ResponsePartitionKey struct {

    // A dimension map that contains the dimensions for this partition.
    //
    // Dimensions is a required field
    Dimensions map[string]*string `type:"map" required:"true"`
    // contains filtered or unexported fields
}

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

func (ResponsePartitionKey) GoString

func (s ResponsePartitionKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResponsePartitionKey) SetDimensions

func (s *ResponsePartitionKey) SetDimensions(v map[string]*string) *ResponsePartitionKey

SetDimensions sets the Dimensions field's value.

func (ResponsePartitionKey) String

func (s ResponsePartitionKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResponseResourceMetric

type ResponseResourceMetric struct {

    // The description of the metric.
    Description *string `min:"1" type:"string"`

    // The full name of the metric.
    Metric *string `type:"string"`

    // The unit of the metric.
    Unit *string `type:"string"`
    // contains filtered or unexported fields
}

An object that contains the full name, description, and unit of a metric.

func (ResponseResourceMetric) GoString

func (s ResponseResourceMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResponseResourceMetric) SetDescription

func (s *ResponseResourceMetric) SetDescription(v string) *ResponseResourceMetric

SetDescription sets the Description field's value.

func (*ResponseResourceMetric) SetMetric

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

SetMetric sets the Metric field's value.

func (*ResponseResourceMetric) SetUnit

func (s *ResponseResourceMetric) SetUnit(v string) *ResponseResourceMetric

SetUnit sets the Unit field's value.

func (ResponseResourceMetric) String

func (s ResponseResourceMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResponseResourceMetricKey

type ResponseResourceMetricKey struct {

    // The valid dimensions for the metric.
    Dimensions map[string]*string `type:"map"`

    // 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.
    //
    //    * The counter metrics listed in Performance Insights operating system
    //    counters (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS)
    //    in the Amazon Aurora User Guide.
    //
    // 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.
    //
    // Metric is a required field
    Metric *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

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

func (ResponseResourceMetricKey) GoString

func (s ResponseResourceMetricKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResponseResourceMetricKey) SetDimensions

func (s *ResponseResourceMetricKey) SetDimensions(v map[string]*string) *ResponseResourceMetricKey

SetDimensions sets the Dimensions field's value.

func (*ResponseResourceMetricKey) SetMetric

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

SetMetric sets the Metric field's value.

func (ResponseResourceMetricKey) String

func (s ResponseResourceMetricKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".