pi

package
v1.53.17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 5, 2024 License: Apache-2.0 Imports: 10 Imported by: 23

Documentation

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

Index

Constants

View Source 
const (
	// AnalysisStatusRunning is a AnalysisStatus enum value
	AnalysisStatusRunning = "RUNNING"

	// AnalysisStatusSucceeded is a AnalysisStatus enum value
	AnalysisStatusSucceeded = "SUCCEEDED"

	// AnalysisStatusFailed is a AnalysisStatus enum value
	AnalysisStatusFailed = "FAILED"
)
View Source 
const (
	// ContextTypeCausal is a ContextType enum value
	ContextTypeCausal = "CAUSAL"

	// ContextTypeContextual is a ContextType enum value
	ContextTypeContextual = "CONTEXTUAL"
)
View Source 
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"
)
View Source 
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"
)
View Source 
const (
	// FineGrainedActionDescribeDimensionKeys is a FineGrainedAction enum value
	FineGrainedActionDescribeDimensionKeys = "DescribeDimensionKeys"

	// FineGrainedActionGetDimensionKeyDetails is a FineGrainedAction enum value
	FineGrainedActionGetDimensionKeyDetails = "GetDimensionKeyDetails"

	// FineGrainedActionGetResourceMetrics is a FineGrainedAction enum value
	FineGrainedActionGetResourceMetrics = "GetResourceMetrics"
)
View Source 
const (
	// PeriodAlignmentEndTime is a PeriodAlignment enum value
	PeriodAlignmentEndTime = "END_TIME"

	// PeriodAlignmentStartTime is a PeriodAlignment enum value
	PeriodAlignmentStartTime = "START_TIME"
)
View Source 
const (
	// ServiceTypeRds is a ServiceType enum value
	ServiceTypeRds = "RDS"

	// ServiceTypeDocdb is a ServiceType enum value
	ServiceTypeDocdb = "DOCDB"
)
View Source 
const (
	// SeverityLow is a Severity enum value
	SeverityLow = "LOW"

	// SeverityMedium is a Severity enum value
	SeverityMedium = "MEDIUM"

	// SeverityHigh is a Severity enum value
	SeverityHigh = "HIGH"
)
View Source 
const (
	// TextFormatPlainText is a TextFormat enum value
	TextFormatPlainText = "PLAIN_TEXT"

	// TextFormatMarkdown is a TextFormat enum value
	TextFormatMarkdown = "MARKDOWN"
)
View Source 
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"
)
View Source 
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

View Source 
const (
	// AcceptLanguageEnUs is a AcceptLanguage enum value
	AcceptLanguageEnUs = "EN_US"
)

Variables

This section is empty.

Functions

func AcceptLanguage_Values added in v1.44.324 

func AcceptLanguage_Values() []string

AcceptLanguage_Values returns all elements of the AcceptLanguage enum

func AnalysisStatus_Values added in v1.44.324 

func AnalysisStatus_Values() []string

AnalysisStatus_Values returns all elements of the AnalysisStatus enum

func ContextType_Values added in v1.44.324 

func ContextType_Values() []string

ContextType_Values returns all elements of the ContextType enum

func DetailStatus_Values added in v1.38.55 

func DetailStatus_Values() []string

DetailStatus_Values returns all elements of the DetailStatus enum

func FeatureStatus_Values added in v1.42.33 

func FeatureStatus_Values() []string

FeatureStatus_Values returns all elements of the FeatureStatus enum

func FineGrainedAction_Values added in v1.53.7 

func FineGrainedAction_Values() []string

FineGrainedAction_Values returns all elements of the FineGrainedAction enum

func PeriodAlignment_Values added in v1.44.213 

func PeriodAlignment_Values() []string

PeriodAlignment_Values returns all elements of the PeriodAlignment enum

func ServiceType_Values added in v1.34.3 

func ServiceType_Values() []string

ServiceType_Values returns all elements of the ServiceType enum

func Severity_Values added in v1.44.324 

func Severity_Values() []string

Severity_Values returns all elements of the Severity enum

func TextFormat_Values added in v1.44.324 

func TextFormat_Values() []string

TextFormat_Values returns all elements of the TextFormat enum

Types

type AnalysisReport added in v1.44.324 

type AnalysisReport struct {

	// The name of the analysis report.
	//
	// AnalysisReportId is a required field
	AnalysisReportId *string `min:"1" type:"string" required:"true"`

	// The time you created the analysis report.
	CreateTime *time.Time `type:"timestamp"`

	// The analysis end time in the report.
	EndTime *time.Time `type:"timestamp"`

	// The unique identifier of the analysis report.
	Identifier *string `type:"string"`

	// The list of identified insights in the analysis report.
	Insights []*Insight `type:"list"`

	// List the tags for the Amazon Web Services service for which Performance Insights
	// returns metrics. Valid values are as follows:
	//
	//    * RDS
	//
	//    * DOCDB
	ServiceType *string `type:"string" enum:"ServiceType"`

	// The analysis start time in the report.
	StartTime *time.Time `type:"timestamp"`

	// The status of the created analysis report.
	Status *string `type:"string" enum:"AnalysisStatus"`
	// contains filtered or unexported fields
}

Retrieves the summary of the performance analysis report created for a time period.

func (AnalysisReport) GoString added in v1.44.324 

func (s AnalysisReport) 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 (*AnalysisReport) SetAnalysisReportId added in v1.44.324 

func (s *AnalysisReport) SetAnalysisReportId(v string) *AnalysisReport

SetAnalysisReportId sets the AnalysisReportId field's value.

func (*AnalysisReport) SetCreateTime added in v1.44.324 

func (s *AnalysisReport) SetCreateTime(v time.Time) *AnalysisReport

SetCreateTime sets the CreateTime field's value.

func (*AnalysisReport) SetEndTime added in v1.44.324 

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

SetEndTime sets the EndTime field's value.

func (*AnalysisReport) SetIdentifier added in v1.44.324 

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

SetIdentifier sets the Identifier field's value.

func (*AnalysisReport) SetInsights added in v1.44.324 

func (s *AnalysisReport) SetInsights(v []*Insight) *AnalysisReport

SetInsights sets the Insights field's value.

func (*AnalysisReport) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (*AnalysisReport) SetStartTime added in v1.44.324 

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

SetStartTime sets the StartTime field's value.

func (*AnalysisReport) SetStatus added in v1.44.324 

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

SetStatus sets the Status field's value.

func (AnalysisReport) String added in v1.44.324 

func (s AnalysisReport) 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 AnalysisReportSummary added in v1.44.324 

type AnalysisReportSummary struct {

	// The name of the analysis report.
	AnalysisReportId *string `type:"string"`

	// The time you created the analysis report.
	CreateTime *time.Time `type:"timestamp"`

	// The end time of the analysis in the report.
	EndTime *time.Time `type:"timestamp"`

	// The start time of the analysis in the report.
	StartTime *time.Time `type:"timestamp"`

	// The status of the analysis report.
	Status *string `type:"string" enum:"AnalysisStatus"`

	// List of all the tags added to the analysis report.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Retrieves the details of the performance analysis report.

func (AnalysisReportSummary) GoString added in v1.44.324 

func (s AnalysisReportSummary) 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 (*AnalysisReportSummary) SetAnalysisReportId added in v1.44.324 

func (s *AnalysisReportSummary) SetAnalysisReportId(v string) *AnalysisReportSummary

SetAnalysisReportId sets the AnalysisReportId field's value.

func (*AnalysisReportSummary) SetCreateTime added in v1.44.324 

func (s *AnalysisReportSummary) SetCreateTime(v time.Time) *AnalysisReportSummary

SetCreateTime sets the CreateTime field's value.

func (*AnalysisReportSummary) SetEndTime added in v1.44.324 

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

SetEndTime sets the EndTime field's value.

func (*AnalysisReportSummary) SetStartTime added in v1.44.324 

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

SetStartTime sets the StartTime field's value.

func (*AnalysisReportSummary) SetStatus added in v1.44.324 

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

SetStatus sets the Status field's value.

func (*AnalysisReportSummary) SetTags added in v1.44.324 

func (s *AnalysisReportSummary) SetTags(v []*Tag) *AnalysisReportSummary

SetTags sets the Tags field's value.

func (AnalysisReportSummary) String added in v1.44.324 

func (s AnalysisReportSummary) 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 CreatePerformanceAnalysisReportInput added in v1.44.324 

type CreatePerformanceAnalysisReportInput struct {

	// The end time defined for the analysis report.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" 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-ADECBTYHKTSAUMUZQYPDS2GW4A.
	//
	// Identifier is a required field
	Identifier *string `type:"string" required:"true"`

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

	// The start time defined for the analysis report.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`

	// The metadata assigned to the analysis report consisting of a key-value pair.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreatePerformanceAnalysisReportInput) GoString added in v1.44.324 

func (s CreatePerformanceAnalysisReportInput) 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 (*CreatePerformanceAnalysisReportInput) SetEndTime added in v1.44.324 

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

SetEndTime sets the EndTime field's value.

func (*CreatePerformanceAnalysisReportInput) SetIdentifier added in v1.44.324 

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

SetIdentifier sets the Identifier field's value.

func (*CreatePerformanceAnalysisReportInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (*CreatePerformanceAnalysisReportInput) SetStartTime added in v1.44.324 

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

SetStartTime sets the StartTime field's value.

func (*CreatePerformanceAnalysisReportInput) SetTags added in v1.44.324 

func (s *CreatePerformanceAnalysisReportInput) SetTags(v []*Tag) *CreatePerformanceAnalysisReportInput

SetTags sets the Tags field's value.

func (CreatePerformanceAnalysisReportInput) String added in v1.44.324 

func (s CreatePerformanceAnalysisReportInput) 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 (*CreatePerformanceAnalysisReportInput) Validate added in v1.44.324 

func (s *CreatePerformanceAnalysisReportInput) Validate() error

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

type CreatePerformanceAnalysisReportOutput added in v1.44.324 

type CreatePerformanceAnalysisReportOutput struct {

	// A unique identifier for the created analysis report.
	AnalysisReportId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreatePerformanceAnalysisReportOutput) GoString added in v1.44.324 

func (s CreatePerformanceAnalysisReportOutput) 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 (*CreatePerformanceAnalysisReportOutput) SetAnalysisReportId added in v1.44.324 

func (s *CreatePerformanceAnalysisReportOutput) SetAnalysisReportId(v string) *CreatePerformanceAnalysisReportOutput

SetAnalysisReportId sets the AnalysisReportId field's value.

func (CreatePerformanceAnalysisReportOutput) String added in v1.44.324 

func (s CreatePerformanceAnalysisReportOutput) 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 Data added in v1.44.324 

type Data struct {

	// This field determines the Performance Insights metric to render for the insight.
	// The name field refers to a Performance Insights metric.
	PerformanceInsightsMetric *PerformanceInsightsMetric `type:"structure"`
	// contains filtered or unexported fields
}

List of data objects which provide details about source metrics. This field can be used to determine the PI metric to render for the insight. This data type also includes static values for the metrics for the Insight that were calculated and included in text and annotations on the DB load chart.

func (Data) GoString added in v1.44.324 

func (s Data) 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 (*Data) SetPerformanceInsightsMetric added in v1.44.324 

func (s *Data) SetPerformanceInsightsMetric(v *PerformanceInsightsMetric) *Data

SetPerformanceInsightsMetric sets the PerformanceInsightsMetric field's value.

func (Data) String added in v1.44.324 

func (s Data) 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 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 DeletePerformanceAnalysisReportInput added in v1.44.324 

type DeletePerformanceAnalysisReportInput struct {

	// The unique identifier of the analysis report for deletion.
	//
	// AnalysisReportId is a required field
	AnalysisReportId *string `min:"1" type:"string" 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 Amazon Web Services service for which Performance Insights will return
	// metrics. Valid value is RDS.
	//
	// ServiceType is a required field
	ServiceType *string `type:"string" required:"true" enum:"ServiceType"`
	// contains filtered or unexported fields
}

func (DeletePerformanceAnalysisReportInput) GoString added in v1.44.324 

func (s DeletePerformanceAnalysisReportInput) 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 (*DeletePerformanceAnalysisReportInput) SetAnalysisReportId added in v1.44.324 

func (s *DeletePerformanceAnalysisReportInput) SetAnalysisReportId(v string) *DeletePerformanceAnalysisReportInput

SetAnalysisReportId sets the AnalysisReportId field's value.

func (*DeletePerformanceAnalysisReportInput) SetIdentifier added in v1.44.324 

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

SetIdentifier sets the Identifier field's value.

func (*DeletePerformanceAnalysisReportInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (DeletePerformanceAnalysisReportInput) String added in v1.44.324 

func (s DeletePerformanceAnalysisReportInput) 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 (*DeletePerformanceAnalysisReportInput) Validate added in v1.44.324 

func (s *DeletePerformanceAnalysisReportInput) Validate() error

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

type DeletePerformanceAnalysisReportOutput added in v1.44.324 

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

func (DeletePerformanceAnalysisReportOutput) GoString added in v1.44.324 

func (s DeletePerformanceAnalysisReportOutput) 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 (DeletePerformanceAnalysisReportOutput) String added in v1.44.324 

func (s DeletePerformanceAnalysisReportOutput) 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetIdentifier sets the Identifier field's value.

func (DimensionDetail) String added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetDimensions sets the Dimensions field's value.

func (*DimensionGroupDetail) SetGroup added in v1.42.33 

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

SetGroup sets the Group field's value.

func (DimensionGroupDetail) String added in v1.42.33 

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 added in v1.42.33 

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 added in v1.38.55 

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 added in v1.38.55 

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 added in v1.38.55 

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

SetDimension sets the Dimension field's value.

func (*DimensionKeyDetail) SetStatus added in v1.38.55 

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

SetStatus sets the Status field's value.

func (*DimensionKeyDetail) SetValue added in v1.38.55 

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

SetValue sets the Value field's value.

func (DimensionKeyDetail) String added in v1.38.55 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetStatus sets the Status field's value.

func (FeatureMetadata) String added in v1.42.33 

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 added in v1.38.55 

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 added in v1.38.55 

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 added in v1.38.55 

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

SetGroup sets the Group field's value.

func (*GetDimensionKeyDetailsInput) SetGroupIdentifier added in v1.38.55 

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

SetGroupIdentifier sets the GroupIdentifier field's value.

func (*GetDimensionKeyDetailsInput) SetIdentifier added in v1.38.55 

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

SetIdentifier sets the Identifier field's value.

func (*GetDimensionKeyDetailsInput) SetRequestedDimensions added in v1.38.55 

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

SetRequestedDimensions sets the RequestedDimensions field's value.

func (*GetDimensionKeyDetailsInput) SetServiceType added in v1.38.55 

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

SetServiceType sets the ServiceType field's value.

func (GetDimensionKeyDetailsInput) String added in v1.38.55 

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 added in v1.38.55 

func (s *GetDimensionKeyDetailsInput) Validate() error

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

type GetDimensionKeyDetailsOutput added in v1.38.55 

type GetDimensionKeyDetailsOutput struct {

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

func (GetDimensionKeyDetailsOutput) GoString added in v1.38.55 

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 added in v1.38.55 

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

SetDimensions sets the Dimensions field's value.

func (GetDimensionKeyDetailsOutput) String added in v1.38.55 

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 GetPerformanceAnalysisReportInput added in v1.44.324 

type GetPerformanceAnalysisReportInput struct {

	// The text language in the report. The default language is EN_US (English).
	AcceptLanguage *string `type:"string" enum:"AcceptLanguage"`

	// A unique identifier of the created analysis report. For example, report-12345678901234567
	//
	// AnalysisReportId is a required field
	AnalysisReportId *string `min:"1" type:"string" 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 Amazon Web Services service for which Performance Insights will return
	// metrics. Valid value is RDS.
	//
	// ServiceType is a required field
	ServiceType *string `type:"string" required:"true" enum:"ServiceType"`

	// Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN.
	// The default value is plain text.
	TextFormat *string `type:"string" enum:"TextFormat"`
	// contains filtered or unexported fields
}

func (GetPerformanceAnalysisReportInput) GoString added in v1.44.324 

func (s GetPerformanceAnalysisReportInput) 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 (*GetPerformanceAnalysisReportInput) SetAcceptLanguage added in v1.44.324 

func (s *GetPerformanceAnalysisReportInput) SetAcceptLanguage(v string) *GetPerformanceAnalysisReportInput

SetAcceptLanguage sets the AcceptLanguage field's value.

func (*GetPerformanceAnalysisReportInput) SetAnalysisReportId added in v1.44.324 

func (s *GetPerformanceAnalysisReportInput) SetAnalysisReportId(v string) *GetPerformanceAnalysisReportInput

SetAnalysisReportId sets the AnalysisReportId field's value.

func (*GetPerformanceAnalysisReportInput) SetIdentifier added in v1.44.324 

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

SetIdentifier sets the Identifier field's value.

func (*GetPerformanceAnalysisReportInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (*GetPerformanceAnalysisReportInput) SetTextFormat added in v1.44.324 

func (s *GetPerformanceAnalysisReportInput) SetTextFormat(v string) *GetPerformanceAnalysisReportInput

SetTextFormat sets the TextFormat field's value.

func (GetPerformanceAnalysisReportInput) String added in v1.44.324 

func (s GetPerformanceAnalysisReportInput) 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 (*GetPerformanceAnalysisReportInput) Validate added in v1.44.324 

func (s *GetPerformanceAnalysisReportInput) Validate() error

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

type GetPerformanceAnalysisReportOutput added in v1.44.324 

type GetPerformanceAnalysisReportOutput struct {

	// The summary of the performance analysis report created for a time period.
	AnalysisReport *AnalysisReport `type:"structure"`
	// contains filtered or unexported fields
}

func (GetPerformanceAnalysisReportOutput) GoString added in v1.44.324 

func (s GetPerformanceAnalysisReportOutput) 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 (*GetPerformanceAnalysisReportOutput) SetAnalysisReport added in v1.44.324 

func (s *GetPerformanceAnalysisReportOutput) SetAnalysisReport(v *AnalysisReport) *GetPerformanceAnalysisReportOutput

SetAnalysisReport sets the AnalysisReport field's value.

func (GetPerformanceAnalysisReportOutput) String added in v1.44.324 

func (s GetPerformanceAnalysisReportOutput) 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetIdentifier sets the Identifier field's value.

func (*GetResourceMetadataInput) SetServiceType added in v1.42.33 

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

SetServiceType sets the ServiceType field's value.

func (GetResourceMetadataInput) String added in v1.42.33 

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 added in v1.42.33 

func (s *GetResourceMetadataInput) Validate() error

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

type GetResourceMetadataOutput added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetFeatures sets the Features field's value.

func (*GetResourceMetadataOutput) SetIdentifier added in v1.42.33 

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

SetIdentifier sets the Identifier field's value.

func (GetResourceMetadataOutput) String added in v1.42.33 

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 specify an aggregate function, and you can provide filtering
	// criteria. You must append the aggregate function to the metric. For example,
	// to find the average for the metric db.load you must use db.load.avg. Valid
	// values for aggregate functions include .avg, .min, .max, and .sum.
	//
	// 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 returned timestamp which is the start or end time of the time periods.
	// The default value is END_TIME.
	PeriodAlignment *string `type:"string" enum:"PeriodAlignment"`

	// 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) SetPeriodAlignment added in v1.44.213 

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

SetPeriodAlignment sets the PeriodAlignment 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 Insight added in v1.44.324 

type Insight struct {

	// Metric names and values from the timeframe used as baseline to generate the
	// insight.
	BaselineData []*Data `type:"list"`

	// Indicates if the insight is causal or correlated insight.
	Context *string `type:"string" enum:"ContextType"`

	// Description of the insight. For example: A high severity Insight found between
	// 02:00 to 02:30, where there was an unusually high DB load 600x above baseline.
	// Likely performance impact.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Insight's
	// String and GoString methods.
	Description *string `type:"string" sensitive:"true"`

	// The end time of the insight. For example, 2018-10-30T00:00:00Z.
	EndTime *time.Time `type:"timestamp"`

	// List of data objects containing metrics and references from the time range
	// while generating the insight.
	InsightData []*Data `type:"list"`

	// The unique identifier for the insight. For example, insight-12345678901234567.
	//
	// InsightId is a required field
	InsightId *string `type:"string" required:"true"`

	// The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.
	InsightType *string `type:"string"`

	// List of recommendations for the insight. For example, Investigate the following
	// SQLs that contributed to 100% of the total DBLoad during that time period:
	// sql-id.
	Recommendations []*Recommendation `type:"list"`

	// The severity of the insight. The values are: Low, Medium, or High.
	Severity *string `type:"string" enum:"Severity"`

	// The start time of the insight. For example, 2018-10-30T00:00:00Z.
	StartTime *time.Time `type:"timestamp"`

	// List of supporting insights that provide additional factors for the insight.
	SupportingInsights []*Insight `type:"list"`
	// contains filtered or unexported fields
}

Retrieves the list of performance issues which are identified.

func (Insight) GoString added in v1.44.324 

func (s Insight) 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 (*Insight) SetBaselineData added in v1.44.324 

func (s *Insight) SetBaselineData(v []*Data) *Insight

SetBaselineData sets the BaselineData field's value.

func (*Insight) SetContext added in v1.44.324 

func (s *Insight) SetContext(v string) *Insight

SetContext sets the Context field's value.

func (*Insight) SetDescription added in v1.44.324 

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

SetDescription sets the Description field's value.

func (*Insight) SetEndTime added in v1.44.324 

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

SetEndTime sets the EndTime field's value.

func (*Insight) SetInsightData added in v1.44.324 

func (s *Insight) SetInsightData(v []*Data) *Insight

SetInsightData sets the InsightData field's value.

func (*Insight) SetInsightId added in v1.44.324 

func (s *Insight) SetInsightId(v string) *Insight

SetInsightId sets the InsightId field's value.

func (*Insight) SetInsightType added in v1.44.324 

func (s *Insight) SetInsightType(v string) *Insight

SetInsightType sets the InsightType field's value.

func (*Insight) SetRecommendations added in v1.44.324 

func (s *Insight) SetRecommendations(v []*Recommendation) *Insight

SetRecommendations sets the Recommendations field's value.

func (*Insight) SetSeverity added in v1.44.324 

func (s *Insight) SetSeverity(v string) *Insight

SetSeverity sets the Severity field's value.

func (*Insight) SetStartTime added in v1.44.324 

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

SetStartTime sets the StartTime field's value.

func (*Insight) SetSupportingInsights added in v1.44.324 

func (s *Insight) SetSupportingInsights(v []*Insight) *Insight

SetSupportingInsights sets the SupportingInsights field's value.

func (Insight) String added in v1.44.324 

func (s Insight) 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 added in v1.28.0 

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 added in v1.28.0 

func (s *InternalServiceError) Code() string

Code returns the exception type name.

func (*InternalServiceError) Error added in v1.28.0 

func (s *InternalServiceError) Error() string

func (InternalServiceError) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *InternalServiceError) Message() string

Message returns the exception's message.

func (*InternalServiceError) OrigErr added in v1.28.0 

func (s *InternalServiceError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServiceError) RequestID added in v1.28.0 

func (s *InternalServiceError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServiceError) StatusCode added in v1.28.0 

func (s *InternalServiceError) StatusCode() int

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

func (InternalServiceError) String added in v1.28.0 

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 added in v1.28.0 

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 added in v1.28.0 

func (s *InvalidArgumentException) Code() string

Code returns the exception type name.

func (*InvalidArgumentException) Error added in v1.28.0 

func (s *InvalidArgumentException) Error() string

func (InvalidArgumentException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *InvalidArgumentException) Message() string

Message returns the exception's message.

func (*InvalidArgumentException) OrigErr added in v1.28.0 

func (s *InvalidArgumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArgumentException) RequestID added in v1.28.0 

func (s *InvalidArgumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArgumentException) StatusCode added in v1.28.0 

func (s *InvalidArgumentException) StatusCode() int

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

func (InvalidArgumentException) String added in v1.28.0 

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 added in v1.42.33 

type ListAvailableResourceDimensionsInput struct {

	// The actions to discover the dimensions you are authorized to access. If you
	// specify multiple actions, then the response will contain the dimensions common
	// for all the actions.
	//
	// When you don't specify this request parameter or provide an empty list, the
	// response contains all the available dimensions for the target database engine
	// whether or not you are authorized to access them.
	AuthorizedActions []*string `type:"list" enum:"FineGrainedAction"`

	// 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 added in v1.42.33 

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) SetAuthorizedActions added in v1.53.7 

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

SetAuthorizedActions sets the AuthorizedActions field's value.

func (*ListAvailableResourceDimensionsInput) SetIdentifier added in v1.42.33 

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

SetIdentifier sets the Identifier field's value.

func (*ListAvailableResourceDimensionsInput) SetMaxResults added in v1.42.33 

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

SetMaxResults sets the MaxResults field's value.

func (*ListAvailableResourceDimensionsInput) SetMetrics added in v1.42.33 

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

SetMetrics sets the Metrics field's value.

func (*ListAvailableResourceDimensionsInput) SetNextToken added in v1.42.33 

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

SetNextToken sets the NextToken field's value.

func (*ListAvailableResourceDimensionsInput) SetServiceType added in v1.42.33 

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

SetServiceType sets the ServiceType field's value.

func (ListAvailableResourceDimensionsInput) String added in v1.42.33 

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 added in v1.42.33 

func (s *ListAvailableResourceDimensionsInput) Validate() error

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

type ListAvailableResourceDimensionsOutput added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetMetricDimensions sets the MetricDimensions field's value.

func (*ListAvailableResourceDimensionsOutput) SetNextToken added in v1.42.33 

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

SetNextToken sets the NextToken field's value.

func (ListAvailableResourceDimensionsOutput) String added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetIdentifier sets the Identifier field's value.

func (*ListAvailableResourceMetricsInput) SetMaxResults added in v1.42.33 

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

SetMaxResults sets the MaxResults field's value.

func (*ListAvailableResourceMetricsInput) SetMetricTypes added in v1.42.33 

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

SetMetricTypes sets the MetricTypes field's value.

func (*ListAvailableResourceMetricsInput) SetNextToken added in v1.42.33 

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

SetNextToken sets the NextToken field's value.

func (*ListAvailableResourceMetricsInput) SetServiceType added in v1.42.33 

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

SetServiceType sets the ServiceType field's value.

func (ListAvailableResourceMetricsInput) String added in v1.42.33 

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 added in v1.42.33 

func (s *ListAvailableResourceMetricsInput) Validate() error

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

type ListAvailableResourceMetricsOutput added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetMetrics sets the Metrics field's value.

func (*ListAvailableResourceMetricsOutput) SetNextToken added in v1.42.33 

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

SetNextToken sets the NextToken field's value.

func (ListAvailableResourceMetricsOutput) String added in v1.42.33 

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 ListPerformanceAnalysisReportsInput added in v1.44.324 

type ListPerformanceAnalysisReportsInput 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.
	// 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"`

	// Specifies whether or not to include the list of tags in the response.
	ListTags *bool `type:"boolean"`

	// The maximum number of items to return in the response. If more items exist
	// than the specified MaxResults value, a pagination token is included in the
	// response so that the remaining results can be retrieved.
	MaxResults *int64 `type:"integer"`

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

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

func (ListPerformanceAnalysisReportsInput) GoString added in v1.44.324 

func (s ListPerformanceAnalysisReportsInput) 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 (*ListPerformanceAnalysisReportsInput) SetIdentifier added in v1.44.324 

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

SetIdentifier sets the Identifier field's value.

func (*ListPerformanceAnalysisReportsInput) SetListTags added in v1.44.324 

func (s *ListPerformanceAnalysisReportsInput) SetListTags(v bool) *ListPerformanceAnalysisReportsInput

SetListTags sets the ListTags field's value.

func (*ListPerformanceAnalysisReportsInput) SetMaxResults added in v1.44.324 

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

SetMaxResults sets the MaxResults field's value.

func (*ListPerformanceAnalysisReportsInput) SetNextToken added in v1.44.324 

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

SetNextToken sets the NextToken field's value.

func (*ListPerformanceAnalysisReportsInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (ListPerformanceAnalysisReportsInput) String added in v1.44.324 

func (s ListPerformanceAnalysisReportsInput) 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 (*ListPerformanceAnalysisReportsInput) Validate added in v1.44.324 

func (s *ListPerformanceAnalysisReportsInput) Validate() error

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

type ListPerformanceAnalysisReportsOutput added in v1.44.324 

type ListPerformanceAnalysisReportsOutput struct {

	// List of reports including the report identifier, start and end time, creation
	// time, and status.
	AnalysisReports []*AnalysisReportSummary `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 MaxResults.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPerformanceAnalysisReportsOutput) GoString added in v1.44.324 

func (s ListPerformanceAnalysisReportsOutput) 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 (*ListPerformanceAnalysisReportsOutput) SetAnalysisReports added in v1.44.324 

func (s *ListPerformanceAnalysisReportsOutput) SetAnalysisReports(v []*AnalysisReportSummary) *ListPerformanceAnalysisReportsOutput

SetAnalysisReports sets the AnalysisReports field's value.

func (*ListPerformanceAnalysisReportsOutput) SetNextToken added in v1.44.324 

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

SetNextToken sets the NextToken field's value.

func (ListPerformanceAnalysisReportsOutput) String added in v1.44.324 

func (s ListPerformanceAnalysisReportsOutput) 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 ListTagsForResourceInput added in v1.44.324 

type ListTagsForResourceInput struct {

	// Lists all the tags for the Amazon RDS Performance Insights resource. This
	// value is an Amazon Resource Name (ARN). For information about creating an
	// ARN, see Constructing an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

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

func (ListTagsForResourceInput) GoString added in v1.44.324 

func (s ListTagsForResourceInput) 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 (*ListTagsForResourceInput) SetResourceARN added in v1.44.324 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*ListTagsForResourceInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (ListTagsForResourceInput) String added in v1.44.324 

func (s ListTagsForResourceInput) 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 (*ListTagsForResourceInput) Validate added in v1.44.324 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.44.324 

type ListTagsForResourceOutput struct {

	// The metadata assigned to an Amazon RDS resource consisting of a key-value
	// pair.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.44.324 

func (s ListTagsForResourceOutput) 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 (*ListTagsForResourceOutput) SetTags added in v1.44.324 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.44.324 

func (s ListTagsForResourceOutput) 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetGroups sets the Groups field's value.

func (*MetricDimensionGroups) SetMetric added in v1.42.33 

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

SetMetric sets the Metric field's value.

func (MetricDimensionGroups) String added in v1.42.33 

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.
	//
	//    * The counter metrics listed in Performance Insights operating system
	//    counters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS)
	//    in the Amazon RDS 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 and append an aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum. 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 added in v1.28.0 

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 added in v1.28.0 

func (s *NotAuthorizedException) Code() string

Code returns the exception type name.

func (*NotAuthorizedException) Error added in v1.28.0 

func (s *NotAuthorizedException) Error() string

func (NotAuthorizedException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *NotAuthorizedException) Message() string

Message returns the exception's message.

func (*NotAuthorizedException) OrigErr added in v1.28.0 

func (s *NotAuthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotAuthorizedException) RequestID added in v1.28.0 

func (s *NotAuthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotAuthorizedException) StatusCode added in v1.28.0 

func (s *NotAuthorizedException) StatusCode() int

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

func (NotAuthorizedException) String added in v1.28.0 

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) CreatePerformanceAnalysisReport added in v1.44.324 

func (c *PI) CreatePerformanceAnalysisReport(input *CreatePerformanceAnalysisReportInput) (*CreatePerformanceAnalysisReportOutput, error)

CreatePerformanceAnalysisReport API operation for AWS Performance Insights.

Creates a new performance analysis report for a specific time period for the 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 CreatePerformanceAnalysisReport 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/CreatePerformanceAnalysisReport

func (*PI) CreatePerformanceAnalysisReportRequest added in v1.44.324 

func (c *PI) CreatePerformanceAnalysisReportRequest(input *CreatePerformanceAnalysisReportInput) (req *request.Request, output *CreatePerformanceAnalysisReportOutput)

CreatePerformanceAnalysisReportRequest generates a "aws/request.Request" representing the client's request for the CreatePerformanceAnalysisReport 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 CreatePerformanceAnalysisReport for more information on using the CreatePerformanceAnalysisReport 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 CreatePerformanceAnalysisReportRequest method.
req, resp := client.CreatePerformanceAnalysisReportRequest(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/CreatePerformanceAnalysisReport

func (*PI) CreatePerformanceAnalysisReportWithContext added in v1.44.324 

func (c *PI) CreatePerformanceAnalysisReportWithContext(ctx aws.Context, input *CreatePerformanceAnalysisReportInput, opts ...request.Option) (*CreatePerformanceAnalysisReportOutput, error)

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

See CreatePerformanceAnalysisReport 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) DeletePerformanceAnalysisReport added in v1.44.324 

func (c *PI) DeletePerformanceAnalysisReport(input *DeletePerformanceAnalysisReportInput) (*DeletePerformanceAnalysisReportOutput, error)

DeletePerformanceAnalysisReport API operation for AWS Performance Insights.

Deletes a performance analysis report.

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 DeletePerformanceAnalysisReport 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/DeletePerformanceAnalysisReport

func (*PI) DeletePerformanceAnalysisReportRequest added in v1.44.324 

func (c *PI) DeletePerformanceAnalysisReportRequest(input *DeletePerformanceAnalysisReportInput) (req *request.Request, output *DeletePerformanceAnalysisReportOutput)

DeletePerformanceAnalysisReportRequest generates a "aws/request.Request" representing the client's request for the DeletePerformanceAnalysisReport 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 DeletePerformanceAnalysisReport for more information on using the DeletePerformanceAnalysisReport 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 DeletePerformanceAnalysisReportRequest method.
req, resp := client.DeletePerformanceAnalysisReportRequest(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/DeletePerformanceAnalysisReport

func (*PI) DeletePerformanceAnalysisReportWithContext added in v1.44.324 

func (c *PI) DeletePerformanceAnalysisReportWithContext(ctx aws.Context, input *DeletePerformanceAnalysisReportInput, opts ...request.Option) (*DeletePerformanceAnalysisReportOutput, error)

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

See DeletePerformanceAnalysisReport 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) 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.38.55 

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 added in v1.38.55 

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 added in v1.38.55 

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) GetPerformanceAnalysisReport added in v1.44.324 

func (c *PI) GetPerformanceAnalysisReport(input *GetPerformanceAnalysisReportInput) (*GetPerformanceAnalysisReportOutput, error)

GetPerformanceAnalysisReport API operation for AWS Performance Insights.

Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

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 GetPerformanceAnalysisReport 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/GetPerformanceAnalysisReport

func (*PI) GetPerformanceAnalysisReportRequest added in v1.44.324 

func (c *PI) GetPerformanceAnalysisReportRequest(input *GetPerformanceAnalysisReportInput) (req *request.Request, output *GetPerformanceAnalysisReportOutput)

GetPerformanceAnalysisReportRequest generates a "aws/request.Request" representing the client's request for the GetPerformanceAnalysisReport 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 GetPerformanceAnalysisReport for more information on using the GetPerformanceAnalysisReport 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 GetPerformanceAnalysisReportRequest method.
req, resp := client.GetPerformanceAnalysisReportRequest(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/GetPerformanceAnalysisReport

func (*PI) GetPerformanceAnalysisReportWithContext added in v1.44.324 

func (c *PI) GetPerformanceAnalysisReportWithContext(ctx aws.Context, input *GetPerformanceAnalysisReportInput, opts ...request.Option) (*GetPerformanceAnalysisReportOutput, error)

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

See GetPerformanceAnalysisReport 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 filtering criteria for each group. You must specify an aggregate function for each 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 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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.

func (*PI) ListPerformanceAnalysisReports added in v1.44.324 

func (c *PI) ListPerformanceAnalysisReports(input *ListPerformanceAnalysisReportsInput) (*ListPerformanceAnalysisReportsOutput, error)

ListPerformanceAnalysisReports API operation for AWS Performance Insights.

Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

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 ListPerformanceAnalysisReports 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/ListPerformanceAnalysisReports

func (*PI) ListPerformanceAnalysisReportsPages added in v1.44.324 

func (c *PI) ListPerformanceAnalysisReportsPages(input *ListPerformanceAnalysisReportsInput, fn func(*ListPerformanceAnalysisReportsOutput, bool) bool) error

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

See ListPerformanceAnalysisReports 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 ListPerformanceAnalysisReports operation.
pageNum := 0
err := client.ListPerformanceAnalysisReportsPages(params,
    func(page *pi.ListPerformanceAnalysisReportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PI) ListPerformanceAnalysisReportsPagesWithContext added in v1.44.324 

func (c *PI) ListPerformanceAnalysisReportsPagesWithContext(ctx aws.Context, input *ListPerformanceAnalysisReportsInput, fn func(*ListPerformanceAnalysisReportsOutput, bool) bool, opts ...request.Option) error

ListPerformanceAnalysisReportsPagesWithContext same as ListPerformanceAnalysisReportsPages 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) ListPerformanceAnalysisReportsRequest added in v1.44.324 

func (c *PI) ListPerformanceAnalysisReportsRequest(input *ListPerformanceAnalysisReportsInput) (req *request.Request, output *ListPerformanceAnalysisReportsOutput)

ListPerformanceAnalysisReportsRequest generates a "aws/request.Request" representing the client's request for the ListPerformanceAnalysisReports 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 ListPerformanceAnalysisReports for more information on using the ListPerformanceAnalysisReports 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 ListPerformanceAnalysisReportsRequest method.
req, resp := client.ListPerformanceAnalysisReportsRequest(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/ListPerformanceAnalysisReports

func (*PI) ListPerformanceAnalysisReportsWithContext added in v1.44.324 

func (c *PI) ListPerformanceAnalysisReportsWithContext(ctx aws.Context, input *ListPerformanceAnalysisReportsInput, opts ...request.Option) (*ListPerformanceAnalysisReportsOutput, error)

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

See ListPerformanceAnalysisReports 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) ListTagsForResource added in v1.44.324 

func (c *PI) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Performance Insights.

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

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 ListTagsForResource 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/ListTagsForResource

func (*PI) ListTagsForResourceRequest added in v1.44.324 

func (c *PI) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*PI) ListTagsForResourceWithContext added in v1.44.324 

func (c *PI) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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) TagResource added in v1.44.324 

func (c *PI) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Performance Insights.

Adds metadata tags to the Amazon RDS Performance Insights resource.

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 TagResource 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/TagResource

func (*PI) TagResourceRequest added in v1.44.324 

func (c *PI) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*PI) TagResourceWithContext added in v1.44.324 

func (c *PI) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.44.324 

func (c *PI) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Performance Insights.

Deletes the metadata tags from the Amazon RDS Performance Insights resource.

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 UntagResource 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/UntagResource

func (*PI) UntagResourceRequest added in v1.44.324 

func (c *PI) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*PI) UntagResourceWithContext added in v1.44.324 

func (c *PI) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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 PerformanceInsightsMetric added in v1.44.324 

type PerformanceInsightsMetric struct {

	// A dimension map that contains the dimensions for this partition.
	Dimensions map[string]*string `type:"map"`

	// The Performance Insights metric name.
	DisplayName *string `min:"1" type:"string"`

	// The Performance Insights metric.
	Metric *string `min:"1" type:"string"`

	// The value of the metric. For example, 9 for db.load.avg.
	Value *float64 `type:"double"`
	// contains filtered or unexported fields
}

This data type helps to determine Performance Insights metric to render for the insight.

func (PerformanceInsightsMetric) GoString added in v1.44.324 

func (s PerformanceInsightsMetric) 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 (*PerformanceInsightsMetric) SetDimensions added in v1.44.324 

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

SetDimensions sets the Dimensions field's value.

func (*PerformanceInsightsMetric) SetDisplayName added in v1.44.324 

func (s *PerformanceInsightsMetric) SetDisplayName(v string) *PerformanceInsightsMetric

SetDisplayName sets the DisplayName field's value.

func (*PerformanceInsightsMetric) SetMetric added in v1.44.324 

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

SetMetric sets the Metric field's value.

func (*PerformanceInsightsMetric) SetValue added in v1.44.324 

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

SetValue sets the Value field's value.

func (PerformanceInsightsMetric) String added in v1.44.324 

func (s PerformanceInsightsMetric) 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 Recommendation added in v1.44.324 

type Recommendation struct {

	// The recommendation details to help resolve the performance issue. For example,
	// Investigate the following SQLs that contributed to 100% of the total DBLoad
	// during that time period: sql-id
	//
	// RecommendationDescription is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Recommendation's
	// String and GoString methods.
	RecommendationDescription *string `type:"string" sensitive:"true"`

	// The unique identifier for the recommendation.
	RecommendationId *string `type:"string"`
	// contains filtered or unexported fields
}

The list of recommendations for the insight.

func (Recommendation) GoString added in v1.44.324 

func (s Recommendation) 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 (*Recommendation) SetRecommendationDescription added in v1.44.324 

func (s *Recommendation) SetRecommendationDescription(v string) *Recommendation

SetRecommendationDescription sets the RecommendationDescription field's value.

func (*Recommendation) SetRecommendationId added in v1.44.324 

func (s *Recommendation) SetRecommendationId(v string) *Recommendation

SetRecommendationId sets the RecommendationId field's value.

func (Recommendation) String added in v1.44.324 

func (s Recommendation) 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 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 added in v1.42.33 

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 added in v1.42.33 

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 added in v1.42.33 

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

SetDescription sets the Description field's value.

func (*ResponseResourceMetric) SetMetric added in v1.42.33 

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

SetMetric sets the Metric field's value.

func (*ResponseResourceMetric) SetUnit added in v1.42.33 

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

SetUnit sets the Unit field's value.

func (ResponseResourceMetric) String added in v1.42.33 

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.
	//
	//    * The counter metrics listed in Performance Insights operating system
	//    counters (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS)
	//    in the Amazon RDS 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".

type Tag added in v1.44.324 

type Tag struct {

	// A key is the required name of the tag. The string value can be from 1 to
	// 128 Unicode characters in length and can't be prefixed with aws: or rds:.
	// The string can only contain only the set of Unicode letters, digits, white-space,
	// '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// A value is the optional value of the tag. The string value can be from 1
	// to 256 Unicode characters in length and can't be prefixed with aws: or rds:.
	// The string can only contain only the set of Unicode letters, digits, white-space,
	// '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

func (Tag) GoString added in v1.44.324 

func (s Tag) 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 (*Tag) SetKey added in v1.44.324 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.44.324 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.44.324 

func (s Tag) 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 (*Tag) Validate added in v1.44.324 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.44.324 

type TagResourceInput struct {

	// The Amazon RDS Performance Insights resource that the tags are added to.
	// This value is an Amazon Resource Name (ARN). For information about creating
	// an ARN, see Constructing an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

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

	// The metadata assigned to an Amazon RDS resource consisting of a key-value
	// pair.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.44.324 

func (s TagResourceInput) 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 (*TagResourceInput) SetResourceARN added in v1.44.324 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (*TagResourceInput) SetTags added in v1.44.324 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.44.324 

func (s TagResourceInput) 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 (*TagResourceInput) Validate added in v1.44.324 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.44.324 

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

func (TagResourceOutput) GoString added in v1.44.324 

func (s TagResourceOutput) 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 (TagResourceOutput) String added in v1.44.324 

func (s TagResourceOutput) 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 UntagResourceInput added in v1.44.324 

type UntagResourceInput struct {

	// The Amazon RDS Performance Insights resource that the tags are added to.
	// This value is an Amazon Resource Name (ARN). For information about creating
	// an ARN, see Constructing an RDS Amazon Resource Name (ARN) (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing).
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// List the tags for the Amazon Web Services service for which Performance Insights
	// returns metrics. Valid value is RDS.
	//
	// ServiceType is a required field
	ServiceType *string `type:"string" required:"true" enum:"ServiceType"`

	// The metadata assigned to an Amazon RDS Performance Insights resource consisting
	// of a key-value pair.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.44.324 

func (s UntagResourceInput) 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 (*UntagResourceInput) SetResourceARN added in v1.44.324 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetServiceType added in v1.44.324 

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

SetServiceType sets the ServiceType field's value.

func (*UntagResourceInput) SetTagKeys added in v1.44.324 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.44.324 

func (s UntagResourceInput) 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 (*UntagResourceInput) Validate added in v1.44.324 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.44.324 

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

func (UntagResourceOutput) GoString added in v1.44.324 

func (s UntagResourceOutput) 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 (UntagResourceOutput) String added in v1.44.324 

func (s UntagResourceOutput) 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".

Source Files

View all Source files

Directories

Path Synopsis
Package piiface provides an interface to enable mocking the AWS Performance Insights service client for testing your code.
 Package piiface provides an interface to enable mocking the AWS Performance Insights service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.