pi

package module
v1.14.6 Latest Latest
Warning

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

 Go to latest Published: May 17, 2022 License: Apache-2.0 Imports: 33 Imported by: 10

Documentation

Overview

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

Amazon RDS 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.

* To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html) .

* To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) .

* To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) .

Index

Constants

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

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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

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

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

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

Types

type Client 

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

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

func New 

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

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

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) DescribeDimensionKeys 

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

For a specific time period, retrieve the top N dimension keys for a metric. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

func (*Client) GetDimensionKeyDetails added in v1.4.0 

func (c *Client) GetDimensionKeyDetails(ctx context.Context, params *GetDimensionKeyDetailsInput, optFns ...func(*Options)) (*GetDimensionKeyDetailsOutput, error)

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.

func (*Client) GetResourceMetadata added in v1.12.0 

func (c *Client) GetResourceMetadata(ctx context.Context, params *GetResourceMetadataInput, optFns ...func(*Options)) (*GetResourceMetadataOutput, error)

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.

func (*Client) GetResourceMetrics 

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

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

func (*Client) ListAvailableResourceDimensions added in v1.12.0 

func (c *Client) ListAvailableResourceDimensions(ctx context.Context, params *ListAvailableResourceDimensionsInput, optFns ...func(*Options)) (*ListAvailableResourceDimensionsOutput, error)

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

func (*Client) ListAvailableResourceMetrics added in v1.12.0 

func (c *Client) ListAvailableResourceMetrics(ctx context.Context, params *ListAvailableResourceMetricsInput, optFns ...func(*Options)) (*ListAvailableResourceMetricsOutput, error)

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

type DescribeDimensionKeysAPIClient added in v1.12.0 

type DescribeDimensionKeysAPIClient interface {
	DescribeDimensionKeys(context.Context, *DescribeDimensionKeysInput, ...func(*Options)) (*DescribeDimensionKeysOutput, error)
}

DescribeDimensionKeysAPIClient is a client that implements the DescribeDimensionKeys operation.

type DescribeDimensionKeysInput 

type DescribeDimensionKeysInput struct {

	// 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.
	//
	// This member is required.
	EndTime *time.Time

	// A specification for how to aggregate the data points from a query result. You
	// must specify a valid dimension group. Performance Insights 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.
	//
	// This member is required.
	GroupBy *types.DimensionGroup

	// 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.
	//
	// This member is required.
	Identifier *string

	// The name of a Performance Insights metric to be measured. Valid values for
	// Metric are:
	//
	// * db.load.avg - A scaled representation of the number of active
	// sessions for the database engine.
	//
	// * db.sampledload.avg - The raw number of
	// active sessions for the database engine.
	//
	// If the number of active sessions is
	// less than an internal Performance Insights threshold, db.load.avg and
	// db.sampledload.avg are the same value. If the number of active sessions is
	// greater than the internal threshold, Performance Insights samples the active
	// sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing
	// the raw values, and db.sampledload.avg less than db.load.avg. For most use
	// cases, you can query db.load.avg only.
	//
	// This member is required.
	Metric *string

	// The Amazon Web Services service for which Performance Insights will return
	// metrics. Valid values are as follows:
	//
	// * RDS
	//
	// * DOCDB
	//
	// This member is required.
	ServiceType types.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.
	//
	// This member is required.
	StartTime *time.Time

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

	// One or more filters to apply in the request. Restrictions:
	//
	// * Any number of
	// filters by the same dimension, as specified in the GroupBy or Partition
	// parameters.
	//
	// * A single filter for any other dimension in this dimension group.
	Filter map[string]string

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

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the token, up to the
	// value specified by MaxRecords.
	NextToken *string

	// For each dimension specified in GroupBy, specify a secondary dimension to
	// further subdivide the partition keys in the response.
	PartitionBy *types.DimensionGroup

	// The granularity, in seconds, of the data points returned from Performance
	// Insights. A period can be as short as one second, or as long as one day (86400
	// seconds). Valid values are:
	//
	// * 1 (one second)
	//
	// * 60 (one minute)
	//
	// * 300 (five
	// minutes)
	//
	// * 3600 (one hour)
	//
	// * 86400 (twenty-four hours)
	//
	// If you don't specify
	// PeriodInSeconds, then Performance Insights chooses a value for you, with a goal
	// of returning roughly 100-200 data points in the response.
	PeriodInSeconds *int32
	// contains filtered or unexported fields
}

type DescribeDimensionKeysOutput 

type DescribeDimensionKeysOutput struct {

	// The end time for the returned dimension keys, after alignment to a granular
	// boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than
	// or equal to the value of the user-specified Endtime.
	AlignedEndTime *time.Time

	// The start time for the returned dimension keys, after alignment to a granular
	// boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than
	// or equal to the value of the user-specified StartTime.
	AlignedStartTime *time.Time

	// The dimension keys that were requested.
	Keys []types.DimensionKeyDescription

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

	// If PartitionBy was present in the request, PartitionKeys contains the breakdown
	// of dimension keys by the specified partitions.
	PartitionKeys []types.ResponsePartitionKey

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDimensionKeysPaginator added in v1.12.0 

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

DescribeDimensionKeysPaginator is a paginator for DescribeDimensionKeys

func NewDescribeDimensionKeysPaginator added in v1.12.0 

func NewDescribeDimensionKeysPaginator(client DescribeDimensionKeysAPIClient, params *DescribeDimensionKeysInput, optFns ...func(*DescribeDimensionKeysPaginatorOptions)) *DescribeDimensionKeysPaginator

NewDescribeDimensionKeysPaginator returns a new DescribeDimensionKeysPaginator

func (*DescribeDimensionKeysPaginator) HasMorePages added in v1.12.0 

func (p *DescribeDimensionKeysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeDimensionKeysPaginator) NextPage added in v1.12.0 

func (p *DescribeDimensionKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDimensionKeysOutput, error)

NextPage retrieves the next DescribeDimensionKeys page.

type DescribeDimensionKeysPaginatorOptions added in v1.12.0 

type DescribeDimensionKeysPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeDimensionKeysPaginatorOptions is the paginator options for DescribeDimensionKeys

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

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

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

type EndpointResolverFunc 

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

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

func (EndpointResolverFunc) ResolveEndpoint 

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

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetDimensionKeyDetailsInput added in v1.4.0 

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)
	//
	// This member is required.
	Group *string

	// 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)
	//
	// This member is required.
	GroupIdentifier *string

	// 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.
	//
	// This member is required.
	Identifier *string

	// The Amazon Web Services service for which Performance Insights returns data. The
	// only valid value is RDS.
	//
	// This member is required.
	ServiceType types.ServiceType

	// 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
	// contains filtered or unexported fields
}

type GetDimensionKeyDetailsOutput added in v1.4.0 

type GetDimensionKeyDetailsOutput struct {

	// The details for the requested dimensions.
	Dimensions []types.DimensionKeyDetail

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceMetadataInput added in v1.12.0 

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.
	//
	// This member is required.
	Identifier *string

	// The Amazon Web Services service for which Performance Insights returns metrics.
	//
	// This member is required.
	ServiceType types.ServiceType
	// contains filtered or unexported fields
}

type GetResourceMetadataOutput added in v1.12.0 

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]types.FeatureMetadata

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceMetricsAPIClient added in v1.12.0 

type GetResourceMetricsAPIClient interface {
	GetResourceMetrics(context.Context, *GetResourceMetricsInput, ...func(*Options)) (*GetResourceMetricsOutput, error)
}

GetResourceMetricsAPIClient is a client that implements the GetResourceMetrics operation.

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.
	//
	// This member is required.
	EndTime *time.Time

	// 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.
	//
	// This member is required.
	Identifier *string

	// An array of one or more queries to perform. Each query must specify a
	// Performance Insights metric, and can optionally specify aggregation and
	// filtering criteria.
	//
	// This member is required.
	MetricQueries []types.MetricQuery

	// The Amazon Web Services service for which Performance Insights returns metrics.
	// Valid values are as follows:
	//
	// * RDS
	//
	// * DOCDB
	//
	// This member is required.
	ServiceType types.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.
	//
	// This member is required.
	StartTime *time.Time

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

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the token, up to the
	// value specified by MaxRecords.
	NextToken *string

	// The granularity, in seconds, of the data points returned from Performance
	// Insights. A period can be as short as one second, or as long as one day (86400
	// seconds). Valid values are:
	//
	// * 1 (one second)
	//
	// * 60 (one minute)
	//
	// * 300 (five
	// minutes)
	//
	// * 3600 (one hour)
	//
	// * 86400 (twenty-four hours)
	//
	// If you don't specify
	// PeriodInSeconds, then Performance Insights will choose a value for you, with a
	// goal of returning roughly 100-200 data points in the response.
	PeriodInSeconds *int32
	// contains filtered or unexported fields
}

type GetResourceMetricsOutput 

type GetResourceMetricsOutput struct {

	// The end time for the returned metrics, after alignment to a granular boundary
	// (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal
	// to the value of the user-specified Endtime.
	AlignedEndTime *time.Time

	// The start time for the returned metrics, after alignment to a granular boundary
	// (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal
	// to the value of the user-specified StartTime.
	AlignedStartTime *time.Time

	// An immutable 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

	// An array of metric results, where each array element contains all of the data
	// points for a particular dimension.
	MetricList []types.MetricKeyDataPoints

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the token, up to the
	// value specified by MaxRecords.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetResourceMetricsPaginator added in v1.12.0 

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

GetResourceMetricsPaginator is a paginator for GetResourceMetrics

func NewGetResourceMetricsPaginator added in v1.12.0 

func NewGetResourceMetricsPaginator(client GetResourceMetricsAPIClient, params *GetResourceMetricsInput, optFns ...func(*GetResourceMetricsPaginatorOptions)) *GetResourceMetricsPaginator

NewGetResourceMetricsPaginator returns a new GetResourceMetricsPaginator

func (*GetResourceMetricsPaginator) HasMorePages added in v1.12.0 

func (p *GetResourceMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetResourceMetricsPaginator) NextPage added in v1.12.0 

func (p *GetResourceMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceMetricsOutput, error)

NextPage retrieves the next GetResourceMetrics page.

type GetResourceMetricsPaginatorOptions added in v1.12.0 

type GetResourceMetricsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetResourceMetricsPaginatorOptions is the paginator options for GetResourceMetrics

type HTTPClient 

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

type HTTPSignerV4 

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

type ListAvailableResourceDimensionsAPIClient added in v1.12.0 

type ListAvailableResourceDimensionsAPIClient interface {
	ListAvailableResourceDimensions(context.Context, *ListAvailableResourceDimensionsInput, ...func(*Options)) (*ListAvailableResourceDimensionsOutput, error)
}

ListAvailableResourceDimensionsAPIClient is a client that implements the ListAvailableResourceDimensions operation.

type ListAvailableResourceDimensionsInput added in v1.12.0 

type ListAvailableResourceDimensionsInput struct {

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

	// The types of metrics for which to retrieve dimensions. Valid values include
	// db.load.
	//
	// This member is required.
	Metrics []string

	// The Amazon Web Services service for which Performance Insights returns metrics.
	//
	// This member is required.
	ServiceType types.ServiceType

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

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the token, up to the
	// value specified by MaxRecords.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAvailableResourceDimensionsOutput added in v1.12.0 

type ListAvailableResourceDimensionsOutput struct {

	// The dimension information returned for requested metric types.
	MetricDimensions []types.MetricDimensionGroups

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the token, up to the
	// value specified by MaxRecords.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAvailableResourceDimensionsPaginator added in v1.12.0 

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

ListAvailableResourceDimensionsPaginator is a paginator for ListAvailableResourceDimensions

func NewListAvailableResourceDimensionsPaginator added in v1.12.0 

func NewListAvailableResourceDimensionsPaginator(client ListAvailableResourceDimensionsAPIClient, params *ListAvailableResourceDimensionsInput, optFns ...func(*ListAvailableResourceDimensionsPaginatorOptions)) *ListAvailableResourceDimensionsPaginator

NewListAvailableResourceDimensionsPaginator returns a new ListAvailableResourceDimensionsPaginator

func (*ListAvailableResourceDimensionsPaginator) HasMorePages added in v1.12.0 

func (p *ListAvailableResourceDimensionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAvailableResourceDimensionsPaginator) NextPage added in v1.12.0 

func (p *ListAvailableResourceDimensionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAvailableResourceDimensionsOutput, error)

NextPage retrieves the next ListAvailableResourceDimensions page.

type ListAvailableResourceDimensionsPaginatorOptions added in v1.12.0 

type ListAvailableResourceDimensionsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAvailableResourceDimensionsPaginatorOptions is the paginator options for ListAvailableResourceDimensions

type ListAvailableResourceMetricsAPIClient added in v1.12.0 

type ListAvailableResourceMetricsAPIClient interface {
	ListAvailableResourceMetrics(context.Context, *ListAvailableResourceMetricsInput, ...func(*Options)) (*ListAvailableResourceMetricsOutput, error)
}

ListAvailableResourceMetricsAPIClient is a client that implements the ListAvailableResourceMetrics operation.

type ListAvailableResourceMetricsInput added in v1.12.0 

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.
	//
	// This member is required.
	Identifier *string

	// 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
	//
	// This member is required.
	MetricTypes []string

	// The Amazon Web Services service for which Performance Insights returns metrics.
	//
	// This member is required.
	ServiceType types.ServiceType

	// 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 *int32

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the token, up to the
	// value specified by MaxRecords.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAvailableResourceMetricsOutput added in v1.12.0 

type ListAvailableResourceMetricsOutput struct {

	// An array of metrics available to query. Each array element contains the full
	// name, description, and unit of the metric.
	Metrics []types.ResponseResourceMetric

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAvailableResourceMetricsPaginator added in v1.12.0 

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

ListAvailableResourceMetricsPaginator is a paginator for ListAvailableResourceMetrics

func NewListAvailableResourceMetricsPaginator added in v1.12.0 

func NewListAvailableResourceMetricsPaginator(client ListAvailableResourceMetricsAPIClient, params *ListAvailableResourceMetricsInput, optFns ...func(*ListAvailableResourceMetricsPaginatorOptions)) *ListAvailableResourceMetricsPaginator

NewListAvailableResourceMetricsPaginator returns a new ListAvailableResourceMetricsPaginator

func (*ListAvailableResourceMetricsPaginator) HasMorePages added in v1.12.0 

func (p *ListAvailableResourceMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAvailableResourceMetricsPaginator) NextPage added in v1.12.0 

func (p *ListAvailableResourceMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAvailableResourceMetricsOutput, error)

NextPage retrieves the next ListAvailableResourceMetrics page.

type ListAvailableResourceMetricsPaginatorOptions added in v1.12.0 

type ListAvailableResourceMetricsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAvailableResourceMetricsPaginatorOptions is the paginator options for ListAvailableResourceMetrics

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.