cloudwatch

package
v1.44.82 Latest Latest
Warning

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

 Go to latest Published: Aug 22, 2022 License: Apache-2.0 Imports: 11 Imported by: 1,780

Documentation

Overview

Package cloudwatch provides the client and types for making API requests to Amazon CloudWatch.

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

See https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01 for more information on this service.

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

Using the Client

To contact Amazon CloudWatch 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 Amazon CloudWatch client CloudWatch for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatch/#New

Index

Examples

Constants

View Source 
const (
	// ActionsSuppressedByWaitPeriod is a ActionsSuppressedBy enum value
	ActionsSuppressedByWaitPeriod = "WaitPeriod"

	// ActionsSuppressedByExtensionPeriod is a ActionsSuppressedBy enum value
	ActionsSuppressedByExtensionPeriod = "ExtensionPeriod"

	// ActionsSuppressedByAlarm is a ActionsSuppressedBy enum value
	ActionsSuppressedByAlarm = "Alarm"
)
View Source 
const (
	// AlarmTypeCompositeAlarm is a AlarmType enum value
	AlarmTypeCompositeAlarm = "CompositeAlarm"

	// AlarmTypeMetricAlarm is a AlarmType enum value
	AlarmTypeMetricAlarm = "MetricAlarm"
)
View Source 
const (
	// AnomalyDetectorStateValuePendingTraining is a AnomalyDetectorStateValue enum value
	AnomalyDetectorStateValuePendingTraining = "PENDING_TRAINING"

	// AnomalyDetectorStateValueTrainedInsufficientData is a AnomalyDetectorStateValue enum value
	AnomalyDetectorStateValueTrainedInsufficientData = "TRAINED_INSUFFICIENT_DATA"

	// AnomalyDetectorStateValueTrained is a AnomalyDetectorStateValue enum value
	AnomalyDetectorStateValueTrained = "TRAINED"
)
View Source 
const (
	// AnomalyDetectorTypeSingleMetric is a AnomalyDetectorType enum value
	AnomalyDetectorTypeSingleMetric = "SINGLE_METRIC"

	// AnomalyDetectorTypeMetricMath is a AnomalyDetectorType enum value
	AnomalyDetectorTypeMetricMath = "METRIC_MATH"
)
View Source 
const (
	// ComparisonOperatorGreaterThanOrEqualToThreshold is a ComparisonOperator enum value
	ComparisonOperatorGreaterThanOrEqualToThreshold = "GreaterThanOrEqualToThreshold"

	// ComparisonOperatorGreaterThanThreshold is a ComparisonOperator enum value
	ComparisonOperatorGreaterThanThreshold = "GreaterThanThreshold"

	// ComparisonOperatorLessThanThreshold is a ComparisonOperator enum value
	ComparisonOperatorLessThanThreshold = "LessThanThreshold"

	// ComparisonOperatorLessThanOrEqualToThreshold is a ComparisonOperator enum value
	ComparisonOperatorLessThanOrEqualToThreshold = "LessThanOrEqualToThreshold"

	// ComparisonOperatorLessThanLowerOrGreaterThanUpperThreshold is a ComparisonOperator enum value
	ComparisonOperatorLessThanLowerOrGreaterThanUpperThreshold = "LessThanLowerOrGreaterThanUpperThreshold"

	// ComparisonOperatorLessThanLowerThreshold is a ComparisonOperator enum value
	ComparisonOperatorLessThanLowerThreshold = "LessThanLowerThreshold"

	// ComparisonOperatorGreaterThanUpperThreshold is a ComparisonOperator enum value
	ComparisonOperatorGreaterThanUpperThreshold = "GreaterThanUpperThreshold"
)
View Source 
const (
	// HistoryItemTypeConfigurationUpdate is a HistoryItemType enum value
	HistoryItemTypeConfigurationUpdate = "ConfigurationUpdate"

	// HistoryItemTypeStateUpdate is a HistoryItemType enum value
	HistoryItemTypeStateUpdate = "StateUpdate"

	// HistoryItemTypeAction is a HistoryItemType enum value
	HistoryItemTypeAction = "Action"
)
View Source 
const (
	// MetricStreamOutputFormatJson is a MetricStreamOutputFormat enum value
	MetricStreamOutputFormatJson = "json"

	// MetricStreamOutputFormatOpentelemetry07 is a MetricStreamOutputFormat enum value
	MetricStreamOutputFormatOpentelemetry07 = "opentelemetry0.7"
)
View Source 
const (
	// ScanByTimestampDescending is a ScanBy enum value
	ScanByTimestampDescending = "TimestampDescending"

	// ScanByTimestampAscending is a ScanBy enum value
	ScanByTimestampAscending = "TimestampAscending"
)
View Source 
const (
	// StandardUnitSeconds is a StandardUnit enum value
	StandardUnitSeconds = "Seconds"

	// StandardUnitMicroseconds is a StandardUnit enum value
	StandardUnitMicroseconds = "Microseconds"

	// StandardUnitMilliseconds is a StandardUnit enum value
	StandardUnitMilliseconds = "Milliseconds"

	// StandardUnitBytes is a StandardUnit enum value
	StandardUnitBytes = "Bytes"

	// StandardUnitKilobytes is a StandardUnit enum value
	StandardUnitKilobytes = "Kilobytes"

	// StandardUnitMegabytes is a StandardUnit enum value
	StandardUnitMegabytes = "Megabytes"

	// StandardUnitGigabytes is a StandardUnit enum value
	StandardUnitGigabytes = "Gigabytes"

	// StandardUnitTerabytes is a StandardUnit enum value
	StandardUnitTerabytes = "Terabytes"

	// StandardUnitBits is a StandardUnit enum value
	StandardUnitBits = "Bits"

	// StandardUnitKilobits is a StandardUnit enum value
	StandardUnitKilobits = "Kilobits"

	// StandardUnitMegabits is a StandardUnit enum value
	StandardUnitMegabits = "Megabits"

	// StandardUnitGigabits is a StandardUnit enum value
	StandardUnitGigabits = "Gigabits"

	// StandardUnitTerabits is a StandardUnit enum value
	StandardUnitTerabits = "Terabits"

	// StandardUnitPercent is a StandardUnit enum value
	StandardUnitPercent = "Percent"

	// StandardUnitCount is a StandardUnit enum value
	StandardUnitCount = "Count"

	// StandardUnitBytesSecond is a StandardUnit enum value
	StandardUnitBytesSecond = "Bytes/Second"

	// StandardUnitKilobytesSecond is a StandardUnit enum value
	StandardUnitKilobytesSecond = "Kilobytes/Second"

	// StandardUnitMegabytesSecond is a StandardUnit enum value
	StandardUnitMegabytesSecond = "Megabytes/Second"

	// StandardUnitGigabytesSecond is a StandardUnit enum value
	StandardUnitGigabytesSecond = "Gigabytes/Second"

	// StandardUnitTerabytesSecond is a StandardUnit enum value
	StandardUnitTerabytesSecond = "Terabytes/Second"

	// StandardUnitBitsSecond is a StandardUnit enum value
	StandardUnitBitsSecond = "Bits/Second"

	// StandardUnitKilobitsSecond is a StandardUnit enum value
	StandardUnitKilobitsSecond = "Kilobits/Second"

	// StandardUnitMegabitsSecond is a StandardUnit enum value
	StandardUnitMegabitsSecond = "Megabits/Second"

	// StandardUnitGigabitsSecond is a StandardUnit enum value
	StandardUnitGigabitsSecond = "Gigabits/Second"

	// StandardUnitTerabitsSecond is a StandardUnit enum value
	StandardUnitTerabitsSecond = "Terabits/Second"

	// StandardUnitCountSecond is a StandardUnit enum value
	StandardUnitCountSecond = "Count/Second"

	// StandardUnitNone is a StandardUnit enum value
	StandardUnitNone = "None"
)
View Source 
const (
	// StateValueOk is a StateValue enum value
	StateValueOk = "OK"

	// StateValueAlarm is a StateValue enum value
	StateValueAlarm = "ALARM"

	// StateValueInsufficientData is a StateValue enum value
	StateValueInsufficientData = "INSUFFICIENT_DATA"
)
View Source 
const (
	// StatisticSampleCount is a Statistic enum value
	StatisticSampleCount = "SampleCount"

	// StatisticAverage is a Statistic enum value
	StatisticAverage = "Average"

	// StatisticSum is a Statistic enum value
	StatisticSum = "Sum"

	// StatisticMinimum is a Statistic enum value
	StatisticMinimum = "Minimum"

	// StatisticMaximum is a Statistic enum value
	StatisticMaximum = "Maximum"
)
View Source 
const (
	// StatusCodeComplete is a StatusCode enum value
	StatusCodeComplete = "Complete"

	// StatusCodeInternalError is a StatusCode enum value
	StatusCodeInternalError = "InternalError"

	// StatusCodePartialData is a StatusCode enum value
	StatusCodePartialData = "PartialData"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// More than one process tried to modify a resource at the same time.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeDashboardInvalidInputError for service response error code
	// "InvalidParameterInput".
	//
	// Some part of the dashboard data is invalid.
	ErrCodeDashboardInvalidInputError = "InvalidParameterInput"

	// ErrCodeDashboardNotFoundError for service response error code
	// "ResourceNotFound".
	//
	// The specified dashboard does not exist.
	ErrCodeDashboardNotFoundError = "ResourceNotFound"

	// ErrCodeInternalServiceFault for service response error code
	// "InternalServiceError".
	//
	// Request processing has failed due to some unknown error, exception, or failure.
	ErrCodeInternalServiceFault = "InternalServiceError"

	// ErrCodeInvalidFormatFault for service response error code
	// "InvalidFormat".
	//
	// Data was not syntactically valid JSON.
	ErrCodeInvalidFormatFault = "InvalidFormat"

	// ErrCodeInvalidNextToken for service response error code
	// "InvalidNextToken".
	//
	// The next token specified is invalid.
	ErrCodeInvalidNextToken = "InvalidNextToken"

	// ErrCodeInvalidParameterCombinationException for service response error code
	// "InvalidParameterCombination".
	//
	// Parameters were used together that cannot be used together.
	ErrCodeInvalidParameterCombinationException = "InvalidParameterCombination"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValue".
	//
	// The value of an input parameter is bad or out-of-range.
	ErrCodeInvalidParameterValueException = "InvalidParameterValue"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The operation exceeded one or more limits.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeLimitExceededFault for service response error code
	// "LimitExceeded".
	//
	// The quota for alarms for this customer has already been reached.
	ErrCodeLimitExceededFault = "LimitExceeded"

	// ErrCodeMissingRequiredParameterException for service response error code
	// "MissingParameter".
	//
	// An input parameter that is required is missing.
	ErrCodeMissingRequiredParameterException = "MissingParameter"

	// ErrCodeResourceNotFound for service response error code
	// "ResourceNotFound".
	//
	// The named resource does not exist.
	ErrCodeResourceNotFound = "ResourceNotFound"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The named resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "monitoring" // Name of service.
	EndpointsID = ServiceName  // ID to lookup a service endpoint with.
	ServiceID   = "CloudWatch" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// RecentlyActivePt3h is a RecentlyActive enum value
	RecentlyActivePt3h = "PT3H"
)

Variables

This section is empty.

Functions

func ActionsSuppressedBy_Values added in v1.44.60 

func ActionsSuppressedBy_Values() []string

ActionsSuppressedBy_Values returns all elements of the ActionsSuppressedBy enum

func AlarmType_Values added in v1.34.3 

func AlarmType_Values() []string

AlarmType_Values returns all elements of the AlarmType enum

func AnomalyDetectorStateValue_Values added in v1.34.3 

func AnomalyDetectorStateValue_Values() []string

AnomalyDetectorStateValue_Values returns all elements of the AnomalyDetectorStateValue enum

func AnomalyDetectorType_Values added in v1.42.8 

func AnomalyDetectorType_Values() []string

AnomalyDetectorType_Values returns all elements of the AnomalyDetectorType enum

func ComparisonOperator_Values added in v1.34.3 

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func HistoryItemType_Values added in v1.34.3 

func HistoryItemType_Values() []string

HistoryItemType_Values returns all elements of the HistoryItemType enum

func MetricStreamOutputFormat_Values added in v1.38.9 

func MetricStreamOutputFormat_Values() []string

MetricStreamOutputFormat_Values returns all elements of the MetricStreamOutputFormat enum

func RecentlyActive_Values added in v1.34.3 

func RecentlyActive_Values() []string

RecentlyActive_Values returns all elements of the RecentlyActive enum

func ScanBy_Values added in v1.34.3 

func ScanBy_Values() []string

ScanBy_Values returns all elements of the ScanBy enum

func StandardUnit_Values added in v1.34.3 

func StandardUnit_Values() []string

StandardUnit_Values returns all elements of the StandardUnit enum

func StateValue_Values added in v1.34.3 

func StateValue_Values() []string

StateValue_Values returns all elements of the StateValue enum

func Statistic_Values added in v1.34.3 

func Statistic_Values() []string

Statistic_Values returns all elements of the Statistic enum

func StatusCode_Values added in v1.34.3 

func StatusCode_Values() []string

StatusCode_Values returns all elements of the StatusCode enum

func WithGzipRequest added in v1.44.28 

func WithGzipRequest(r *request.Request)

WithGzipRequest is a request.Option that adds a request handler to the Build stage of the operation's pipeline that will content-encoding GZIP the request payload before sending it to the API. This will buffer the request payload in memory, GZIP it, and reassign the GZIP'ed payload as the new request payload.

GZIP may not be supported by all API operations. See API's documentation for the operation your using to see if GZIP request payload is supported. https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricData.html

Types

type AlarmHistoryItem 

type AlarmHistoryItem struct {

	// The descriptive name for the alarm.
	AlarmName *string `min:"1" type:"string"`

	// The type of alarm, either metric alarm or composite alarm.
	AlarmType *string `type:"string" enum:"AlarmType"`

	// Data about the alarm, in JSON format.
	HistoryData *string `min:"1" type:"string"`

	// The type of alarm history item.
	HistoryItemType *string `type:"string" enum:"HistoryItemType"`

	// A summary of the alarm history, in text format.
	HistorySummary *string `min:"1" type:"string"`

	// The time stamp for the alarm history item.
	Timestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents the history of a specific alarm.

func (AlarmHistoryItem) GoString added in v0.6.5 

func (s AlarmHistoryItem) 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 (*AlarmHistoryItem) SetAlarmName added in v1.5.0 

func (s *AlarmHistoryItem) SetAlarmName(v string) *AlarmHistoryItem

SetAlarmName sets the AlarmName field's value.

func (*AlarmHistoryItem) SetAlarmType added in v1.29.15 

func (s *AlarmHistoryItem) SetAlarmType(v string) *AlarmHistoryItem

SetAlarmType sets the AlarmType field's value.

func (*AlarmHistoryItem) SetHistoryData added in v1.5.0 

func (s *AlarmHistoryItem) SetHistoryData(v string) *AlarmHistoryItem

SetHistoryData sets the HistoryData field's value.

func (*AlarmHistoryItem) SetHistoryItemType added in v1.5.0 

func (s *AlarmHistoryItem) SetHistoryItemType(v string) *AlarmHistoryItem

SetHistoryItemType sets the HistoryItemType field's value.

func (*AlarmHistoryItem) SetHistorySummary added in v1.5.0 

func (s *AlarmHistoryItem) SetHistorySummary(v string) *AlarmHistoryItem

SetHistorySummary sets the HistorySummary field's value.

func (*AlarmHistoryItem) SetTimestamp added in v1.5.0 

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

SetTimestamp sets the Timestamp field's value.

func (AlarmHistoryItem) String added in v0.6.5 

func (s AlarmHistoryItem) 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 AnomalyDetector added in v1.20.17 

type AnomalyDetector struct {

	// The configuration specifies details about how the anomaly detection model
	// is to be trained, including time ranges to exclude from use for training
	// the model, and the time zone to use for the metric.
	Configuration *AnomalyDetectorConfiguration `type:"structure"`

	// The metric dimensions associated with the anomaly detection model.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.Dimensions property.
	Dimensions []*Dimension `deprecated:"true" type:"list"`

	// The CloudWatch metric math expression for this anomaly detector.
	MetricMathAnomalyDetector *MetricMathAnomalyDetector `type:"structure"`

	// The name of the metric associated with the anomaly detection model.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.MetricName property.
	MetricName *string `min:"1" deprecated:"true" type:"string"`

	// The namespace of the metric associated with the anomaly detection model.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.Namespace property.
	Namespace *string `min:"1" deprecated:"true" type:"string"`

	// The CloudWatch metric and statistic for this anomaly detector.
	SingleMetricAnomalyDetector *SingleMetricAnomalyDetector `type:"structure"`

	// The statistic associated with the anomaly detection model.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.Stat property.
	Stat *string `deprecated:"true" type:"string"`

	// The current status of the anomaly detector's training. The possible values
	// are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
	StateValue *string `type:"string" enum:"AnomalyDetectorStateValue"`
	// contains filtered or unexported fields
}

An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.

func (AnomalyDetector) GoString added in v1.20.17 

func (s AnomalyDetector) 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 (*AnomalyDetector) SetConfiguration added in v1.20.17 

func (s *AnomalyDetector) SetConfiguration(v *AnomalyDetectorConfiguration) *AnomalyDetector

SetConfiguration sets the Configuration field's value.

func (*AnomalyDetector) SetDimensions added in v1.20.17 

func (s *AnomalyDetector) SetDimensions(v []*Dimension) *AnomalyDetector

SetDimensions sets the Dimensions field's value.

func (*AnomalyDetector) SetMetricMathAnomalyDetector added in v1.42.8 

func (s *AnomalyDetector) SetMetricMathAnomalyDetector(v *MetricMathAnomalyDetector) *AnomalyDetector

SetMetricMathAnomalyDetector sets the MetricMathAnomalyDetector field's value.

func (*AnomalyDetector) SetMetricName added in v1.20.17 

func (s *AnomalyDetector) SetMetricName(v string) *AnomalyDetector

SetMetricName sets the MetricName field's value.

func (*AnomalyDetector) SetNamespace added in v1.20.17 

func (s *AnomalyDetector) SetNamespace(v string) *AnomalyDetector

SetNamespace sets the Namespace field's value.

func (*AnomalyDetector) SetSingleMetricAnomalyDetector added in v1.42.8 

func (s *AnomalyDetector) SetSingleMetricAnomalyDetector(v *SingleMetricAnomalyDetector) *AnomalyDetector

SetSingleMetricAnomalyDetector sets the SingleMetricAnomalyDetector field's value.

func (*AnomalyDetector) SetStat added in v1.20.17 

func (s *AnomalyDetector) SetStat(v string) *AnomalyDetector

SetStat sets the Stat field's value.

func (*AnomalyDetector) SetStateValue added in v1.28.6 

func (s *AnomalyDetector) SetStateValue(v string) *AnomalyDetector

SetStateValue sets the StateValue field's value.

func (AnomalyDetector) String added in v1.20.17 

func (s AnomalyDetector) 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 AnomalyDetectorConfiguration added in v1.20.17 

type AnomalyDetectorConfiguration struct {

	// An array of time ranges to exclude from use when the anomaly detection model
	// is trained. Use this to make sure that events that could cause unusual values
	// for the metric, such as deployments, aren't used when CloudWatch creates
	// the model.
	ExcludedTimeRanges []*Range `type:"list"`

	// The time zone to use for the metric. This is useful to enable the model to
	// automatically account for daylight savings time changes if the metric is
	// sensitive to such time changes.
	//
	// To specify a time zone, use the name of the time zone as specified in the
	// standard tz database. For more information, see tz database (https://en.wikipedia.org/wiki/Tz_database).
	MetricTimezone *string `type:"string"`
	// contains filtered or unexported fields
}

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model and the time zone to use for the metric.

func (AnomalyDetectorConfiguration) GoString added in v1.20.17 

func (s AnomalyDetectorConfiguration) 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 (*AnomalyDetectorConfiguration) SetExcludedTimeRanges added in v1.20.17 

func (s *AnomalyDetectorConfiguration) SetExcludedTimeRanges(v []*Range) *AnomalyDetectorConfiguration

SetExcludedTimeRanges sets the ExcludedTimeRanges field's value.

func (*AnomalyDetectorConfiguration) SetMetricTimezone added in v1.20.17 

func (s *AnomalyDetectorConfiguration) SetMetricTimezone(v string) *AnomalyDetectorConfiguration

SetMetricTimezone sets the MetricTimezone field's value.

func (AnomalyDetectorConfiguration) String added in v1.20.17 

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

func (s *AnomalyDetectorConfiguration) Validate() error

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

type CloudWatch 

type CloudWatch struct {
	*client.Client
}

CloudWatch provides the API operation methods for making requests to Amazon CloudWatch. See this package's package overview docs for details on the service.

CloudWatch 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) *CloudWatch

New creates a new instance of the CloudWatch 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 CloudWatch client from just a session.
svc := cloudwatch.New(mySession)

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

func (*CloudWatch) DeleteAlarms 

func (c *CloudWatch) DeleteAlarms(input *DeleteAlarmsInput) (*DeleteAlarmsOutput, error)

DeleteAlarms API operation for Amazon CloudWatch.

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

In the event of an error, no alarms are deleted.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

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 Amazon CloudWatch's API operation DeleteAlarms for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFound "ResourceNotFound" The named resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarms

func (*CloudWatch) DeleteAlarmsRequest 

func (c *CloudWatch) DeleteAlarmsRequest(input *DeleteAlarmsInput) (req *request.Request, output *DeleteAlarmsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarms

func (*CloudWatch) DeleteAlarmsWithContext added in v1.8.0 

func (c *CloudWatch) DeleteAlarmsWithContext(ctx aws.Context, input *DeleteAlarmsInput, opts ...request.Option) (*DeleteAlarmsOutput, error)

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

See DeleteAlarms 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 (*CloudWatch) DeleteAnomalyDetector added in v1.20.17 

func (c *CloudWatch) DeleteAnomalyDetector(input *DeleteAnomalyDetectorInput) (*DeleteAnomalyDetectorOutput, error)

DeleteAnomalyDetector API operation for Amazon CloudWatch.

Deletes the specified anomaly detection model from your account. For more information about how to delete an anomaly detection model, see Deleting an anomaly detection model (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model) in the CloudWatch User Guide.

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 Amazon CloudWatch's API operation DeleteAnomalyDetector for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The named resource does not exist.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAnomalyDetector

func (*CloudWatch) DeleteAnomalyDetectorRequest added in v1.20.17 

func (c *CloudWatch) DeleteAnomalyDetectorRequest(input *DeleteAnomalyDetectorInput) (req *request.Request, output *DeleteAnomalyDetectorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAnomalyDetector

func (*CloudWatch) DeleteAnomalyDetectorWithContext added in v1.20.17 

func (c *CloudWatch) DeleteAnomalyDetectorWithContext(ctx aws.Context, input *DeleteAnomalyDetectorInput, opts ...request.Option) (*DeleteAnomalyDetectorOutput, error)

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

See DeleteAnomalyDetector 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 (*CloudWatch) DeleteDashboards added in v1.10.7 

func (c *CloudWatch) DeleteDashboards(input *DeleteDashboardsInput) (*DeleteDashboardsOutput, error)

DeleteDashboards API operation for Amazon CloudWatch.

Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

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 Amazon CloudWatch's API operation DeleteDashboards for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeDashboardNotFoundError "ResourceNotFound" The specified dashboard does not exist.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboards

func (*CloudWatch) DeleteDashboardsRequest added in v1.10.7 

func (c *CloudWatch) DeleteDashboardsRequest(input *DeleteDashboardsInput) (req *request.Request, output *DeleteDashboardsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboards

func (*CloudWatch) DeleteDashboardsWithContext added in v1.10.7 

func (c *CloudWatch) DeleteDashboardsWithContext(ctx aws.Context, input *DeleteDashboardsInput, opts ...request.Option) (*DeleteDashboardsOutput, error)

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

See DeleteDashboards 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 (*CloudWatch) DeleteInsightRules added in v1.25.42 

func (c *CloudWatch) DeleteInsightRules(input *DeleteInsightRulesInput) (*DeleteInsightRulesOutput, error)

DeleteInsightRules API operation for Amazon CloudWatch.

Permanently deletes the specified Contributor Insights rules.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

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 Amazon CloudWatch's API operation DeleteInsightRules for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteInsightRules

func (*CloudWatch) DeleteInsightRulesRequest added in v1.25.42 

func (c *CloudWatch) DeleteInsightRulesRequest(input *DeleteInsightRulesInput) (req *request.Request, output *DeleteInsightRulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteInsightRules

func (*CloudWatch) DeleteInsightRulesWithContext added in v1.25.42 

func (c *CloudWatch) DeleteInsightRulesWithContext(ctx aws.Context, input *DeleteInsightRulesInput, opts ...request.Option) (*DeleteInsightRulesOutput, error)

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

See DeleteInsightRules 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 (*CloudWatch) DeleteMetricStream added in v1.38.9 

func (c *CloudWatch) DeleteMetricStream(input *DeleteMetricStreamInput) (*DeleteMetricStreamOutput, error)

DeleteMetricStream API operation for Amazon CloudWatch.

Permanently deletes the metric stream that you specify.

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 Amazon CloudWatch's API operation DeleteMetricStream for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteMetricStream

func (*CloudWatch) DeleteMetricStreamRequest added in v1.38.9 

func (c *CloudWatch) DeleteMetricStreamRequest(input *DeleteMetricStreamInput) (req *request.Request, output *DeleteMetricStreamOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteMetricStream

func (*CloudWatch) DeleteMetricStreamWithContext added in v1.38.9 

func (c *CloudWatch) DeleteMetricStreamWithContext(ctx aws.Context, input *DeleteMetricStreamInput, opts ...request.Option) (*DeleteMetricStreamOutput, error)

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

See DeleteMetricStream 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 (*CloudWatch) DescribeAlarmHistory 

func (c *CloudWatch) DescribeAlarmHistory(input *DescribeAlarmHistoryInput) (*DescribeAlarmHistoryOutput, error)

DescribeAlarmHistory API operation for Amazon CloudWatch.

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

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 Amazon CloudWatch's API operation DescribeAlarmHistory for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistory

func (*CloudWatch) DescribeAlarmHistoryPages 

func (c *CloudWatch) DescribeAlarmHistoryPages(input *DescribeAlarmHistoryInput, fn func(*DescribeAlarmHistoryOutput, bool) bool) error

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

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

func (*CloudWatch) DescribeAlarmHistoryPagesWithContext added in v1.8.0 

func (c *CloudWatch) DescribeAlarmHistoryPagesWithContext(ctx aws.Context, input *DescribeAlarmHistoryInput, fn func(*DescribeAlarmHistoryOutput, bool) bool, opts ...request.Option) error

DescribeAlarmHistoryPagesWithContext same as DescribeAlarmHistoryPages 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 (*CloudWatch) DescribeAlarmHistoryRequest 

func (c *CloudWatch) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInput) (req *request.Request, output *DescribeAlarmHistoryOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistory

func (*CloudWatch) DescribeAlarmHistoryWithContext added in v1.8.0 

func (c *CloudWatch) DescribeAlarmHistoryWithContext(ctx aws.Context, input *DescribeAlarmHistoryInput, opts ...request.Option) (*DescribeAlarmHistoryOutput, error)

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

See DescribeAlarmHistory 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 (*CloudWatch) DescribeAlarms 

func (c *CloudWatch) DescribeAlarms(input *DescribeAlarmsInput) (*DescribeAlarmsOutput, error)

DescribeAlarms API operation for Amazon CloudWatch.

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

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 Amazon CloudWatch's API operation DescribeAlarms for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms

func (*CloudWatch) DescribeAlarmsForMetric 

func (c *CloudWatch) DescribeAlarmsForMetric(input *DescribeAlarmsForMetricInput) (*DescribeAlarmsForMetricOutput, error)

DescribeAlarmsForMetric API operation for Amazon CloudWatch.

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

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 Amazon CloudWatch's API operation DescribeAlarmsForMetric for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric

func (*CloudWatch) DescribeAlarmsForMetricRequest 

func (c *CloudWatch) DescribeAlarmsForMetricRequest(input *DescribeAlarmsForMetricInput) (req *request.Request, output *DescribeAlarmsForMetricOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric

func (*CloudWatch) DescribeAlarmsForMetricWithContext added in v1.8.0 

func (c *CloudWatch) DescribeAlarmsForMetricWithContext(ctx aws.Context, input *DescribeAlarmsForMetricInput, opts ...request.Option) (*DescribeAlarmsForMetricOutput, error)

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

See DescribeAlarmsForMetric 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 (*CloudWatch) DescribeAlarmsPages 

func (c *CloudWatch) DescribeAlarmsPages(input *DescribeAlarmsInput, fn func(*DescribeAlarmsOutput, bool) bool) error

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

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

func (*CloudWatch) DescribeAlarmsPagesWithContext added in v1.8.0 

func (c *CloudWatch) DescribeAlarmsPagesWithContext(ctx aws.Context, input *DescribeAlarmsInput, fn func(*DescribeAlarmsOutput, bool) bool, opts ...request.Option) error

DescribeAlarmsPagesWithContext same as DescribeAlarmsPages 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 (*CloudWatch) DescribeAlarmsRequest 

func (c *CloudWatch) DescribeAlarmsRequest(input *DescribeAlarmsInput) (req *request.Request, output *DescribeAlarmsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms

func (*CloudWatch) DescribeAlarmsWithContext added in v1.8.0 

func (c *CloudWatch) DescribeAlarmsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.Option) (*DescribeAlarmsOutput, error)

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

See DescribeAlarms 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 (*CloudWatch) DescribeAnomalyDetectors added in v1.20.17 

func (c *CloudWatch) DescribeAnomalyDetectors(input *DescribeAnomalyDetectorsInput) (*DescribeAnomalyDetectorsOutput, error)

DescribeAnomalyDetectors API operation for Amazon CloudWatch.

Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

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 Amazon CloudWatch's API operation DescribeAnomalyDetectors for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAnomalyDetectors

func (*CloudWatch) DescribeAnomalyDetectorsPages added in v1.44.80 

func (c *CloudWatch) DescribeAnomalyDetectorsPages(input *DescribeAnomalyDetectorsInput, fn func(*DescribeAnomalyDetectorsOutput, bool) bool) error

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

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

func (*CloudWatch) DescribeAnomalyDetectorsPagesWithContext added in v1.44.80 

func (c *CloudWatch) DescribeAnomalyDetectorsPagesWithContext(ctx aws.Context, input *DescribeAnomalyDetectorsInput, fn func(*DescribeAnomalyDetectorsOutput, bool) bool, opts ...request.Option) error

DescribeAnomalyDetectorsPagesWithContext same as DescribeAnomalyDetectorsPages 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 (*CloudWatch) DescribeAnomalyDetectorsRequest added in v1.20.17 

func (c *CloudWatch) DescribeAnomalyDetectorsRequest(input *DescribeAnomalyDetectorsInput) (req *request.Request, output *DescribeAnomalyDetectorsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAnomalyDetectors

func (*CloudWatch) DescribeAnomalyDetectorsWithContext added in v1.20.17 

func (c *CloudWatch) DescribeAnomalyDetectorsWithContext(ctx aws.Context, input *DescribeAnomalyDetectorsInput, opts ...request.Option) (*DescribeAnomalyDetectorsOutput, error)

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

See DescribeAnomalyDetectors 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 (*CloudWatch) DescribeInsightRules added in v1.25.42 

func (c *CloudWatch) DescribeInsightRules(input *DescribeInsightRulesInput) (*DescribeInsightRulesOutput, error)

DescribeInsightRules API operation for Amazon CloudWatch.

Returns a list of all the Contributor Insights rules in your account.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).

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 Amazon CloudWatch's API operation DescribeInsightRules for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeInsightRules

func (*CloudWatch) DescribeInsightRulesPages added in v1.25.42 

func (c *CloudWatch) DescribeInsightRulesPages(input *DescribeInsightRulesInput, fn func(*DescribeInsightRulesOutput, bool) bool) error

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

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

func (*CloudWatch) DescribeInsightRulesPagesWithContext added in v1.25.42 

func (c *CloudWatch) DescribeInsightRulesPagesWithContext(ctx aws.Context, input *DescribeInsightRulesInput, fn func(*DescribeInsightRulesOutput, bool) bool, opts ...request.Option) error

DescribeInsightRulesPagesWithContext same as DescribeInsightRulesPages 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 (*CloudWatch) DescribeInsightRulesRequest added in v1.25.42 

func (c *CloudWatch) DescribeInsightRulesRequest(input *DescribeInsightRulesInput) (req *request.Request, output *DescribeInsightRulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeInsightRules

func (*CloudWatch) DescribeInsightRulesWithContext added in v1.25.42 

func (c *CloudWatch) DescribeInsightRulesWithContext(ctx aws.Context, input *DescribeInsightRulesInput, opts ...request.Option) (*DescribeInsightRulesOutput, error)

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

See DescribeInsightRules 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 (*CloudWatch) DisableAlarmActions 

func (c *CloudWatch) DisableAlarmActions(input *DisableAlarmActionsInput) (*DisableAlarmActionsOutput, error)

DisableAlarmActions API operation for Amazon CloudWatch.

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

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 Amazon CloudWatch's API operation DisableAlarmActions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions

func (*CloudWatch) DisableAlarmActionsRequest 

func (c *CloudWatch) DisableAlarmActionsRequest(input *DisableAlarmActionsInput) (req *request.Request, output *DisableAlarmActionsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions

func (*CloudWatch) DisableAlarmActionsWithContext added in v1.8.0 

func (c *CloudWatch) DisableAlarmActionsWithContext(ctx aws.Context, input *DisableAlarmActionsInput, opts ...request.Option) (*DisableAlarmActionsOutput, error)

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

See DisableAlarmActions 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 (*CloudWatch) DisableInsightRules added in v1.25.42 

func (c *CloudWatch) DisableInsightRules(input *DisableInsightRulesInput) (*DisableInsightRulesOutput, error)

DisableInsightRules API operation for Amazon CloudWatch.

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.

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 Amazon CloudWatch's API operation DisableInsightRules for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableInsightRules

func (*CloudWatch) DisableInsightRulesRequest added in v1.25.42 

func (c *CloudWatch) DisableInsightRulesRequest(input *DisableInsightRulesInput) (req *request.Request, output *DisableInsightRulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableInsightRules

func (*CloudWatch) DisableInsightRulesWithContext added in v1.25.42 

func (c *CloudWatch) DisableInsightRulesWithContext(ctx aws.Context, input *DisableInsightRulesInput, opts ...request.Option) (*DisableInsightRulesOutput, error)

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

See DisableInsightRules 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 (*CloudWatch) EnableAlarmActions 

func (c *CloudWatch) EnableAlarmActions(input *EnableAlarmActionsInput) (*EnableAlarmActionsOutput, error)

EnableAlarmActions API operation for Amazon CloudWatch.

Enables the actions for the specified alarms.

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 Amazon CloudWatch's API operation EnableAlarmActions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions

func (*CloudWatch) EnableAlarmActionsRequest 

func (c *CloudWatch) EnableAlarmActionsRequest(input *EnableAlarmActionsInput) (req *request.Request, output *EnableAlarmActionsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions

func (*CloudWatch) EnableAlarmActionsWithContext added in v1.8.0 

func (c *CloudWatch) EnableAlarmActionsWithContext(ctx aws.Context, input *EnableAlarmActionsInput, opts ...request.Option) (*EnableAlarmActionsOutput, error)

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

See EnableAlarmActions 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 (*CloudWatch) EnableInsightRules added in v1.25.42 

func (c *CloudWatch) EnableInsightRules(input *EnableInsightRulesInput) (*EnableInsightRulesOutput, error)

EnableInsightRules API operation for Amazon CloudWatch.

Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.

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 Amazon CloudWatch's API operation EnableInsightRules for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeLimitExceededException "LimitExceededException" The operation exceeded one or more limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableInsightRules

func (*CloudWatch) EnableInsightRulesRequest added in v1.25.42 

func (c *CloudWatch) EnableInsightRulesRequest(input *EnableInsightRulesInput) (req *request.Request, output *EnableInsightRulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableInsightRules

func (*CloudWatch) EnableInsightRulesWithContext added in v1.25.42 

func (c *CloudWatch) EnableInsightRulesWithContext(ctx aws.Context, input *EnableInsightRulesInput, opts ...request.Option) (*EnableInsightRulesOutput, error)

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

See EnableInsightRules 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 (*CloudWatch) GetDashboard added in v1.10.7 

func (c *CloudWatch) GetDashboard(input *GetDashboardInput) (*GetDashboardOutput, error)

GetDashboard API operation for Amazon CloudWatch.

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

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 Amazon CloudWatch's API operation GetDashboard for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeDashboardNotFoundError "ResourceNotFound" The specified dashboard does not exist.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboard

func (*CloudWatch) GetDashboardRequest added in v1.10.7 

func (c *CloudWatch) GetDashboardRequest(input *GetDashboardInput) (req *request.Request, output *GetDashboardOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboard

func (*CloudWatch) GetDashboardWithContext added in v1.10.7 

func (c *CloudWatch) GetDashboardWithContext(ctx aws.Context, input *GetDashboardInput, opts ...request.Option) (*GetDashboardOutput, error)

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

See GetDashboard 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 (*CloudWatch) GetInsightRuleReport added in v1.25.42 

func (c *CloudWatch) GetInsightRuleReport(input *GetInsightRuleReportInput) (*GetInsightRuleReportOutput, error)

GetInsightRuleReport API operation for Amazon CloudWatch.

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

  • UniqueContributors -- the number of unique contributors for each data point.

  • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph. If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount -- the number of data points matched by the rule.

  • Sum -- the sum of the values from all contributors during the time period represented by that data point.

  • Minimum -- the minimum value from a single observation during the time period represented by that data point.

  • Maximum -- the maximum value from a single observation during the time period represented by that data point.

  • Average -- the average value from all contributors during the time period represented by that data point.

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 Amazon CloudWatch's API operation GetInsightRuleReport for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The named resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetInsightRuleReport

func (*CloudWatch) GetInsightRuleReportRequest added in v1.25.42 

func (c *CloudWatch) GetInsightRuleReportRequest(input *GetInsightRuleReportInput) (req *request.Request, output *GetInsightRuleReportOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetInsightRuleReport

func (*CloudWatch) GetInsightRuleReportWithContext added in v1.25.42 

func (c *CloudWatch) GetInsightRuleReportWithContext(ctx aws.Context, input *GetInsightRuleReportInput, opts ...request.Option) (*GetInsightRuleReportOutput, error)

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

See GetInsightRuleReport 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 (*CloudWatch) GetMetricData added in v1.13.28 

func (c *CloudWatch) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error)

GetMetricData API operation for Amazon CloudWatch.

You can use the GetMetricData API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more metric math functions.

A GetMetricData operation that does not include a query can retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform metric math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide.

If you include a Metrics Insights query, each GetMetricData operation can include only one query. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries can query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html).

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Using Metrics Insights queries with metric math

You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.

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 Amazon CloudWatch's API operation GetMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricData

func (*CloudWatch) GetMetricDataPages added in v1.18.3 

func (c *CloudWatch) GetMetricDataPages(input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool) error

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

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

func (*CloudWatch) GetMetricDataPagesWithContext added in v1.18.3 

func (c *CloudWatch) GetMetricDataPagesWithContext(ctx aws.Context, input *GetMetricDataInput, fn func(*GetMetricDataOutput, bool) bool, opts ...request.Option) error

GetMetricDataPagesWithContext same as GetMetricDataPages 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 (*CloudWatch) GetMetricDataRequest added in v1.13.28 

func (c *CloudWatch) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricData

func (*CloudWatch) GetMetricDataWithContext added in v1.13.28 

func (c *CloudWatch) GetMetricDataWithContext(ctx aws.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error)

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

See GetMetricData 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 (*CloudWatch) GetMetricStatistics 

func (c *CloudWatch) GetMetricStatistics(input *GetMetricStatisticsInput) (*GetMetricStatisticsOutput, error)

GetMetricStatistics API operation for Amazon CloudWatch.

Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html) in the Amazon CloudWatch User Guide.

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 Amazon CloudWatch's API operation GetMetricStatistics for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatistics

func (*CloudWatch) GetMetricStatisticsRequest 

func (c *CloudWatch) GetMetricStatisticsRequest(input *GetMetricStatisticsInput) (req *request.Request, output *GetMetricStatisticsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatistics

func (*CloudWatch) GetMetricStatisticsWithContext added in v1.8.0 

func (c *CloudWatch) GetMetricStatisticsWithContext(ctx aws.Context, input *GetMetricStatisticsInput, opts ...request.Option) (*GetMetricStatisticsOutput, error)

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

See GetMetricStatistics 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 (*CloudWatch) GetMetricStream added in v1.38.9 

func (c *CloudWatch) GetMetricStream(input *GetMetricStreamInput) (*GetMetricStreamOutput, error)

GetMetricStream API operation for Amazon CloudWatch.

Returns information about the metric stream that you specify.

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 Amazon CloudWatch's API operation GetMetricStream for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The named resource does not exist.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStream

func (*CloudWatch) GetMetricStreamRequest added in v1.38.9 

func (c *CloudWatch) GetMetricStreamRequest(input *GetMetricStreamInput) (req *request.Request, output *GetMetricStreamOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStream

func (*CloudWatch) GetMetricStreamWithContext added in v1.38.9 

func (c *CloudWatch) GetMetricStreamWithContext(ctx aws.Context, input *GetMetricStreamInput, opts ...request.Option) (*GetMetricStreamOutput, error)

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

See GetMetricStream 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 (*CloudWatch) GetMetricWidgetImage added in v1.15.38 

func (c *CloudWatch) GetMetricWidgetImage(input *GetMetricWidgetImageInput) (*GetMetricWidgetImageOutput, error)

GetMetricWidgetImage API operation for Amazon CloudWatch.

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

  • As many as 100 metrics in the graph.

  • Up to 100 KB uncompressed payload.

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 Amazon CloudWatch's API operation GetMetricWidgetImage for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImage

func (*CloudWatch) GetMetricWidgetImageRequest added in v1.15.38 

func (c *CloudWatch) GetMetricWidgetImageRequest(input *GetMetricWidgetImageInput) (req *request.Request, output *GetMetricWidgetImageOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImage

func (*CloudWatch) GetMetricWidgetImageWithContext added in v1.15.38 

func (c *CloudWatch) GetMetricWidgetImageWithContext(ctx aws.Context, input *GetMetricWidgetImageInput, opts ...request.Option) (*GetMetricWidgetImageOutput, error)

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

See GetMetricWidgetImage 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 (*CloudWatch) ListDashboards added in v1.10.7 

func (c *CloudWatch) ListDashboards(input *ListDashboardsInput) (*ListDashboardsOutput, error)

ListDashboards API operation for Amazon CloudWatch.

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

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 Amazon CloudWatch's API operation ListDashboards for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboards

func (*CloudWatch) ListDashboardsPages added in v1.18.3 

func (c *CloudWatch) ListDashboardsPages(input *ListDashboardsInput, fn func(*ListDashboardsOutput, bool) bool) error

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

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

func (*CloudWatch) ListDashboardsPagesWithContext added in v1.18.3 

func (c *CloudWatch) ListDashboardsPagesWithContext(ctx aws.Context, input *ListDashboardsInput, fn func(*ListDashboardsOutput, bool) bool, opts ...request.Option) error

ListDashboardsPagesWithContext same as ListDashboardsPages 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 (*CloudWatch) ListDashboardsRequest added in v1.10.7 

func (c *CloudWatch) ListDashboardsRequest(input *ListDashboardsInput) (req *request.Request, output *ListDashboardsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboards

func (*CloudWatch) ListDashboardsWithContext added in v1.10.7 

func (c *CloudWatch) ListDashboardsWithContext(ctx aws.Context, input *ListDashboardsInput, opts ...request.Option) (*ListDashboardsOutput, error)

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

See ListDashboards 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 (*CloudWatch) ListManagedInsightRules added in v1.44.80 

func (c *CloudWatch) ListManagedInsightRules(input *ListManagedInsightRulesInput) (*ListManagedInsightRulesOutput, error)

ListManagedInsightRules API operation for Amazon CloudWatch.

Returns a list that contains the number of managed Contributor Insights rules in your account.

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 Amazon CloudWatch's API operation ListManagedInsightRules for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListManagedInsightRules

func (*CloudWatch) ListManagedInsightRulesPages added in v1.44.80 

func (c *CloudWatch) ListManagedInsightRulesPages(input *ListManagedInsightRulesInput, fn func(*ListManagedInsightRulesOutput, bool) bool) error

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

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

func (*CloudWatch) ListManagedInsightRulesPagesWithContext added in v1.44.80 

func (c *CloudWatch) ListManagedInsightRulesPagesWithContext(ctx aws.Context, input *ListManagedInsightRulesInput, fn func(*ListManagedInsightRulesOutput, bool) bool, opts ...request.Option) error

ListManagedInsightRulesPagesWithContext same as ListManagedInsightRulesPages 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 (*CloudWatch) ListManagedInsightRulesRequest added in v1.44.80 

func (c *CloudWatch) ListManagedInsightRulesRequest(input *ListManagedInsightRulesInput) (req *request.Request, output *ListManagedInsightRulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListManagedInsightRules

func (*CloudWatch) ListManagedInsightRulesWithContext added in v1.44.80 

func (c *CloudWatch) ListManagedInsightRulesWithContext(ctx aws.Context, input *ListManagedInsightRulesInput, opts ...request.Option) (*ListManagedInsightRulesOutput, error)

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

See ListManagedInsightRules 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 (*CloudWatch) ListMetricStreams added in v1.38.9 

func (c *CloudWatch) ListMetricStreams(input *ListMetricStreamsInput) (*ListMetricStreamsOutput, error)

ListMetricStreams API operation for Amazon CloudWatch.

Returns a list of metric streams in this account.

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 Amazon CloudWatch's API operation ListMetricStreams for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricStreams

func (*CloudWatch) ListMetricStreamsPages added in v1.38.9 

func (c *CloudWatch) ListMetricStreamsPages(input *ListMetricStreamsInput, fn func(*ListMetricStreamsOutput, bool) bool) error

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

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

func (*CloudWatch) ListMetricStreamsPagesWithContext added in v1.38.9 

func (c *CloudWatch) ListMetricStreamsPagesWithContext(ctx aws.Context, input *ListMetricStreamsInput, fn func(*ListMetricStreamsOutput, bool) bool, opts ...request.Option) error

ListMetricStreamsPagesWithContext same as ListMetricStreamsPages 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 (*CloudWatch) ListMetricStreamsRequest added in v1.38.9 

func (c *CloudWatch) ListMetricStreamsRequest(input *ListMetricStreamsInput) (req *request.Request, output *ListMetricStreamsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricStreams

func (*CloudWatch) ListMetricStreamsWithContext added in v1.38.9 

func (c *CloudWatch) ListMetricStreamsWithContext(ctx aws.Context, input *ListMetricStreamsInput, opts ...request.Option) (*ListMetricStreamsOutput, error)

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

See ListMetricStreams 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 (*CloudWatch) ListMetrics 

func (c *CloudWatch) ListMetrics(input *ListMetricsInput) (*ListMetricsOutput, error)

ListMetrics API operation for Amazon CloudWatch.

List the specified metrics. You can use the returned metrics with GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).

ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).

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 Amazon CloudWatch's API operation ListMetrics for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics

func (*CloudWatch) ListMetricsPages 

func (c *CloudWatch) ListMetricsPages(input *ListMetricsInput, fn func(*ListMetricsOutput, bool) bool) error

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

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

func (*CloudWatch) ListMetricsPagesWithContext added in v1.8.0 

func (c *CloudWatch) ListMetricsPagesWithContext(ctx aws.Context, input *ListMetricsInput, fn func(*ListMetricsOutput, bool) bool, opts ...request.Option) error

ListMetricsPagesWithContext same as ListMetricsPages 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 (*CloudWatch) ListMetricsRequest 

func (c *CloudWatch) ListMetricsRequest(input *ListMetricsInput) (req *request.Request, output *ListMetricsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics

func (*CloudWatch) ListMetricsWithContext added in v1.8.0 

func (c *CloudWatch) ListMetricsWithContext(ctx aws.Context, input *ListMetricsInput, opts ...request.Option) (*ListMetricsOutput, error)

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

See ListMetrics 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 (*CloudWatch) ListTagsForResource added in v1.19.6 

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

ListTagsForResource API operation for Amazon CloudWatch.

Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.

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 Amazon CloudWatch's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The named resource does not exist.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListTagsForResource

func (*CloudWatch) ListTagsForResourceRequest added in v1.19.6 

func (c *CloudWatch) 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/monitoring-2010-08-01/ListTagsForResource

func (*CloudWatch) ListTagsForResourceWithContext added in v1.19.6 

func (c *CloudWatch) 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 (*CloudWatch) PutAnomalyDetector added in v1.20.17 

func (c *CloudWatch) PutAnomalyDetector(input *PutAnomalyDetectorInput) (*PutAnomalyDetectorOutput, error)

PutAnomalyDetector API operation for Amazon CloudWatch.

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html).

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 Amazon CloudWatch's API operation PutAnomalyDetector for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededException "LimitExceededException" The operation exceeded one or more limits.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutAnomalyDetector

func (*CloudWatch) PutAnomalyDetectorRequest added in v1.20.17 

func (c *CloudWatch) PutAnomalyDetectorRequest(input *PutAnomalyDetectorInput) (req *request.Request, output *PutAnomalyDetectorOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutAnomalyDetector

func (*CloudWatch) PutAnomalyDetectorWithContext added in v1.20.17 

func (c *CloudWatch) PutAnomalyDetectorWithContext(ctx aws.Context, input *PutAnomalyDetectorInput, opts ...request.Option) (*PutAnomalyDetectorOutput, error)

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

See PutAnomalyDetector 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 (*CloudWatch) PutCompositeAlarm added in v1.29.15 

func (c *CloudWatch) PutCompositeAlarm(input *PutCompositeAlarmInput) (*PutCompositeAlarmOutput, error)

PutCompositeAlarm API operation for Amazon CloudWatch.

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. The rule expression of a composite alarm can include as many as 100 underlying alarms. Any single alarm can be included in the rule expressions of as many as 150 composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

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 Amazon CloudWatch's API operation PutCompositeAlarm for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" The quota for alarms for this customer has already been reached.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarm

func (*CloudWatch) PutCompositeAlarmRequest added in v1.29.15 

func (c *CloudWatch) PutCompositeAlarmRequest(input *PutCompositeAlarmInput) (req *request.Request, output *PutCompositeAlarmOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutCompositeAlarm

func (*CloudWatch) PutCompositeAlarmWithContext added in v1.29.15 

func (c *CloudWatch) PutCompositeAlarmWithContext(ctx aws.Context, input *PutCompositeAlarmInput, opts ...request.Option) (*PutCompositeAlarmOutput, error)

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

See PutCompositeAlarm 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 (*CloudWatch) PutDashboard added in v1.10.7 

func (c *CloudWatch) PutDashboard(input *PutDashboardInput) (*PutDashboardOutput, error)

PutDashboard API operation for Amazon CloudWatch.

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

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 Amazon CloudWatch's API operation PutDashboard for usage and error information.

Returned Error Codes:

  • ErrCodeDashboardInvalidInputError "InvalidParameterInput" Some part of the dashboard data is invalid.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboard

func (*CloudWatch) PutDashboardRequest added in v1.10.7 

func (c *CloudWatch) PutDashboardRequest(input *PutDashboardInput) (req *request.Request, output *PutDashboardOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboard

func (*CloudWatch) PutDashboardWithContext added in v1.10.7 

func (c *CloudWatch) PutDashboardWithContext(ctx aws.Context, input *PutDashboardInput, opts ...request.Option) (*PutDashboardOutput, error)

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

See PutDashboard 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 (*CloudWatch) PutInsightRule added in v1.25.42 

func (c *CloudWatch) PutInsightRule(input *PutInsightRuleInput) (*PutInsightRuleOutput, error)

PutInsightRule API operation for Amazon CloudWatch.

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

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 Amazon CloudWatch's API operation PutInsightRule for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeLimitExceededException "LimitExceededException" The operation exceeded one or more limits.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutInsightRule

func (*CloudWatch) PutInsightRuleRequest added in v1.25.42 

func (c *CloudWatch) PutInsightRuleRequest(input *PutInsightRuleInput) (req *request.Request, output *PutInsightRuleOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutInsightRule

func (*CloudWatch) PutInsightRuleWithContext added in v1.25.42 

func (c *CloudWatch) PutInsightRuleWithContext(ctx aws.Context, input *PutInsightRuleInput, opts ...request.Option) (*PutInsightRuleOutput, error)

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

See PutInsightRule 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 (*CloudWatch) PutManagedInsightRules added in v1.44.80 

func (c *CloudWatch) PutManagedInsightRules(input *PutManagedInsightRulesInput) (*PutManagedInsightRulesOutput, error)

PutManagedInsightRules API operation for Amazon CloudWatch.

Creates a managed Contributor Insights rule for a specified Amazon Web Services resource. When you enable a managed rule, you create a Contributor Insights rule that collects data from Amazon Web Services services. You cannot edit these rules with PutInsightRule. The rules can be enabled, disabled, and deleted using EnableInsightRules, DisableInsightRules, and DeleteInsightRules. If a previously created managed rule is currently disabled, a subsequent call to this API will re-enable it. Use ListManagedInsightRules to describe all available rules.

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 Amazon CloudWatch's API operation PutManagedInsightRules for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutManagedInsightRules

func (*CloudWatch) PutManagedInsightRulesRequest added in v1.44.80 

func (c *CloudWatch) PutManagedInsightRulesRequest(input *PutManagedInsightRulesInput) (req *request.Request, output *PutManagedInsightRulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutManagedInsightRules

func (*CloudWatch) PutManagedInsightRulesWithContext added in v1.44.80 

func (c *CloudWatch) PutManagedInsightRulesWithContext(ctx aws.Context, input *PutManagedInsightRulesInput, opts ...request.Option) (*PutManagedInsightRulesOutput, error)

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

See PutManagedInsightRules 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 (*CloudWatch) PutMetricAlarm 

func (c *CloudWatch) PutMetricAlarm(input *PutMetricAlarmInput) (*PutMetricAlarmOutput, error)

PutMetricAlarm API operation for Amazon CloudWatch.

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

  • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

  • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role).

Cross-account alarms

You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

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 Amazon CloudWatch's API operation PutMetricAlarm for usage and error information.

Returned Error Codes:

  • ErrCodeLimitExceededFault "LimitExceeded" The quota for alarms for this customer has already been reached.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm

func (*CloudWatch) PutMetricAlarmRequest 

func (c *CloudWatch) PutMetricAlarmRequest(input *PutMetricAlarmInput) (req *request.Request, output *PutMetricAlarmOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm

func (*CloudWatch) PutMetricAlarmWithContext added in v1.8.0 

func (c *CloudWatch) PutMetricAlarmWithContext(ctx aws.Context, input *PutMetricAlarmInput, opts ...request.Option) (*PutMetricAlarmOutput, error)

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

See PutMetricAlarm 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 (*CloudWatch) PutMetricData 

func (c *CloudWatch) PutMetricData(input *PutMetricDataInput) (*PutMetricDataOutput, error)

PutMetricData API operation for Amazon CloudWatch.

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html).

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 1 MB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 1000 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 30 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide.

You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.

  • The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.

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 Amazon CloudWatch's API operation PutMetricData for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricData

func (*CloudWatch) PutMetricDataRequest 

func (c *CloudWatch) PutMetricDataRequest(input *PutMetricDataInput) (req *request.Request, output *PutMetricDataOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricData

func (*CloudWatch) PutMetricDataWithContext added in v1.8.0 

func (c *CloudWatch) PutMetricDataWithContext(ctx aws.Context, input *PutMetricDataInput, opts ...request.Option) (*PutMetricDataOutput, error)

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

See PutMetricData 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.

Example (WithGzipRequest) 
//go:build go1.7
// +build go1.7

package main

import (
	"context"

	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/awstesting/unit"
	"github.com/aws/aws-sdk-go/service/cloudwatch"
)

func main() {
	client := cloudwatch.New(sess)

	// The WithContext form of the operation methods accept request options.
	// The WithGzipRequest option will gzip the request payload before it is
	// sent.
	result, err := client.PutMetricDataWithContext(context.TODO(), params, cloudwatch.WithGzipRequest)

	_, _ = result, err
}

var params *cloudwatch.PutMetricDataInput
var sess *session.Session = unit.Session

Output:

func (*CloudWatch) PutMetricStream added in v1.38.9 

func (c *CloudWatch) PutMetricStream(input *PutMetricStreamInput) (*PutMetricStreamOutput, error)

PutMetricStream API operation for Amazon CloudWatch.

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations including Amazon S3 and to many third-party solutions.

For more information, see Using Metric Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html).

To create a metric stream, you must be logged on to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission.

When you create or update a metric stream, you choose one of the following:

  • Stream metrics from all metric namespaces in the account.

  • Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters.

  • Stream metrics from only the metric namespaces that you list in IncludeFilters.

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use the StatisticsConfigurations parameter to have the metric stream also send additional statistics in the stream. Streaming additional statistics incurs additional costs. For more information, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).

When you use PutMetricStream to create a new metric stream, the stream is created in the running state. If you use it to update an existing stream, the state of the stream is not changed.

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 Amazon CloudWatch's API operation PutMetricStream for usage and error information.

Returned Error Codes:

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" More than one process tried to modify a resource at the same time.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

  • ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStream

func (*CloudWatch) PutMetricStreamRequest added in v1.38.9 

func (c *CloudWatch) PutMetricStreamRequest(input *PutMetricStreamInput) (req *request.Request, output *PutMetricStreamOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricStream

func (*CloudWatch) PutMetricStreamWithContext added in v1.38.9 

func (c *CloudWatch) PutMetricStreamWithContext(ctx aws.Context, input *PutMetricStreamInput, opts ...request.Option) (*PutMetricStreamOutput, error)

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

See PutMetricStream 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 (*CloudWatch) SetAlarmState 

func (c *CloudWatch) SetAlarmState(input *SetAlarmStateInput) (*SetAlarmStateOutput, error)

SetAlarmState API operation for Amazon CloudWatch.

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html).

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

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 Amazon CloudWatch's API operation SetAlarmState for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFound "ResourceNotFound" The named resource does not exist.

  • ErrCodeInvalidFormatFault "InvalidFormat" Data was not syntactically valid JSON.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmState

func (*CloudWatch) SetAlarmStateRequest 

func (c *CloudWatch) SetAlarmStateRequest(input *SetAlarmStateInput) (req *request.Request, output *SetAlarmStateOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmState

func (*CloudWatch) SetAlarmStateWithContext added in v1.8.0 

func (c *CloudWatch) SetAlarmStateWithContext(ctx aws.Context, input *SetAlarmStateInput, opts ...request.Option) (*SetAlarmStateOutput, error)

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

See SetAlarmState 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 (*CloudWatch) StartMetricStreams added in v1.38.9 

func (c *CloudWatch) StartMetricStreams(input *StartMetricStreamsInput) (*StartMetricStreamsOutput, error)

StartMetricStreams API operation for Amazon CloudWatch.

Starts the streaming of metrics for one or more of your metric streams.

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 Amazon CloudWatch's API operation StartMetricStreams for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StartMetricStreams

func (*CloudWatch) StartMetricStreamsRequest added in v1.38.9 

func (c *CloudWatch) StartMetricStreamsRequest(input *StartMetricStreamsInput) (req *request.Request, output *StartMetricStreamsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StartMetricStreams

func (*CloudWatch) StartMetricStreamsWithContext added in v1.38.9 

func (c *CloudWatch) StartMetricStreamsWithContext(ctx aws.Context, input *StartMetricStreamsInput, opts ...request.Option) (*StartMetricStreamsOutput, error)

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

See StartMetricStreams 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 (*CloudWatch) StopMetricStreams added in v1.38.9 

func (c *CloudWatch) StopMetricStreams(input *StopMetricStreamsInput) (*StopMetricStreamsOutput, error)

StopMetricStreams API operation for Amazon CloudWatch.

Stops the streaming of metrics for one or more of your metric streams.

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 Amazon CloudWatch's API operation StopMetricStreams for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StopMetricStreams

func (*CloudWatch) StopMetricStreamsRequest added in v1.38.9 

func (c *CloudWatch) StopMetricStreamsRequest(input *StopMetricStreamsInput) (req *request.Request, output *StopMetricStreamsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StopMetricStreams

func (*CloudWatch) StopMetricStreamsWithContext added in v1.38.9 

func (c *CloudWatch) StopMetricStreamsWithContext(ctx aws.Context, input *StopMetricStreamsInput, opts ...request.Option) (*StopMetricStreamsOutput, error)

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

See StopMetricStreams 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 (*CloudWatch) TagResource added in v1.19.6 

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

TagResource API operation for Amazon CloudWatch.

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a CloudWatch 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 Amazon CloudWatch's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The named resource does not exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" More than one process tried to modify a resource at the same time.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/TagResource

func (*CloudWatch) TagResourceRequest added in v1.19.6 

func (c *CloudWatch) 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/monitoring-2010-08-01/TagResource

func (*CloudWatch) TagResourceWithContext added in v1.19.6 

func (c *CloudWatch) 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 (*CloudWatch) UntagResource added in v1.19.6 

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

UntagResource API operation for Amazon CloudWatch.

Removes one or more tags from the specified 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 Amazon CloudWatch's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The named resource does not exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" More than one process tried to modify a resource at the same time.

  • ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.

See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/UntagResource

func (*CloudWatch) UntagResourceRequest added in v1.19.6 

func (c *CloudWatch) 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/monitoring-2010-08-01/UntagResource

func (*CloudWatch) UntagResourceWithContext added in v1.19.6 

func (c *CloudWatch) 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.

func (*CloudWatch) WaitUntilAlarmExists added in v1.1.33 

func (c *CloudWatch) WaitUntilAlarmExists(input *DescribeAlarmsInput) error

WaitUntilAlarmExists uses the CloudWatch API operation DescribeAlarms to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudWatch) WaitUntilAlarmExistsWithContext added in v1.8.0 

func (c *CloudWatch) WaitUntilAlarmExistsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.WaiterOption) error

WaitUntilAlarmExistsWithContext is an extended version of WaitUntilAlarmExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*CloudWatch) WaitUntilCompositeAlarmExists added in v1.29.15 

func (c *CloudWatch) WaitUntilCompositeAlarmExists(input *DescribeAlarmsInput) error

WaitUntilCompositeAlarmExists uses the CloudWatch API operation DescribeAlarms to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudWatch) WaitUntilCompositeAlarmExistsWithContext added in v1.29.15 

func (c *CloudWatch) WaitUntilCompositeAlarmExistsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.WaiterOption) error

WaitUntilCompositeAlarmExistsWithContext is an extended version of WaitUntilCompositeAlarmExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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

type CompositeAlarm struct {

	// Indicates whether actions should be executed during any changes to the alarm
	// state.
	ActionsEnabled *bool `type:"boolean"`

	// When the value is ALARM, it means that the actions are suppressed because
	// the suppressor alarm is in ALARM When the value is WaitPeriod, it means that
	// the actions are suppressed because the composite alarm is waiting for the
	// suppressor alarm to go into into the ALARM state. The maximum waiting time
	// is as specified in ActionsSuppressorWaitPeriod. After this time, the composite
	// alarm performs its actions. When the value is ExtensionPeriod, it means that
	// the actions are suppressed because the composite alarm is waiting after the
	// suppressor alarm went out of the ALARM state. The maximum waiting time is
	// as specified in ActionsSuppressorExtensionPeriod. After this time, the composite
	// alarm performs its actions.
	ActionsSuppressedBy *string `type:"string" enum:"ActionsSuppressedBy"`

	// Captures the reason for action suppression.
	ActionsSuppressedReason *string `type:"string"`

	// Actions will be suppressed if the suppressor alarm is in the ALARM state.
	// ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from
	// an existing alarm.
	ActionsSuppressor *string `min:"1" type:"string"`

	// The maximum time in seconds that the composite alarm waits after suppressor
	// alarm goes out of the ALARM state. After this time, the composite alarm performs
	// its actions.
	//
	// ExtensionPeriod is required only when ActionsSuppressor is specified.
	ActionsSuppressorExtensionPeriod *int64 `type:"integer"`

	// The maximum time in seconds that the composite alarm waits for the suppressor
	// alarm to go into the ALARM state. After this time, the composite alarm performs
	// its actions.
	//
	// WaitPeriod is required only when ActionsSuppressor is specified.
	ActionsSuppressorWaitPeriod *int64 `type:"integer"`

	// The actions to execute when this alarm transitions to the ALARM state from
	// any other state. Each action is specified as an Amazon Resource Name (ARN).
	AlarmActions []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the alarm.
	AlarmArn *string `min:"1" type:"string"`

	// The time stamp of the last update to the alarm configuration.
	AlarmConfigurationUpdatedTimestamp *time.Time `type:"timestamp"`

	// The description of the alarm.
	AlarmDescription *string `type:"string"`

	// The name of the alarm.
	AlarmName *string `min:"1" type:"string"`

	// The rule that this alarm uses to evaluate its alarm state.
	AlarmRule *string `min:"1" type:"string"`

	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
	// state from any other state. Each action is specified as an Amazon Resource
	// Name (ARN).
	InsufficientDataActions []*string `type:"list"`

	// The actions to execute when this alarm transitions to the OK state from any
	// other state. Each action is specified as an Amazon Resource Name (ARN).
	OKActions []*string `type:"list"`

	// An explanation for the alarm state, in text format.
	StateReason *string `type:"string"`

	// An explanation for the alarm state, in JSON format.
	StateReasonData *string `type:"string"`

	// The timestamp of the last change to the alarm's StateValue.
	StateTransitionedTimestamp *time.Time `type:"timestamp"`

	// Tracks the timestamp of any state update, even if StateValue doesn't change.
	StateUpdatedTimestamp *time.Time `type:"timestamp"`

	// The state value for the alarm.
	StateValue *string `type:"string" enum:"StateValue"`
	// contains filtered or unexported fields
}

The details about a composite alarm.

func (CompositeAlarm) GoString added in v1.29.15 

func (s CompositeAlarm) 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 (*CompositeAlarm) SetActionsEnabled added in v1.29.15 

func (s *CompositeAlarm) SetActionsEnabled(v bool) *CompositeAlarm

SetActionsEnabled sets the ActionsEnabled field's value.

func (*CompositeAlarm) SetActionsSuppressedBy added in v1.44.60 

func (s *CompositeAlarm) SetActionsSuppressedBy(v string) *CompositeAlarm

SetActionsSuppressedBy sets the ActionsSuppressedBy field's value.

func (*CompositeAlarm) SetActionsSuppressedReason added in v1.44.60 

func (s *CompositeAlarm) SetActionsSuppressedReason(v string) *CompositeAlarm

SetActionsSuppressedReason sets the ActionsSuppressedReason field's value.

func (*CompositeAlarm) SetActionsSuppressor added in v1.44.60 

func (s *CompositeAlarm) SetActionsSuppressor(v string) *CompositeAlarm

SetActionsSuppressor sets the ActionsSuppressor field's value.

func (*CompositeAlarm) SetActionsSuppressorExtensionPeriod added in v1.44.60 

func (s *CompositeAlarm) SetActionsSuppressorExtensionPeriod(v int64) *CompositeAlarm

SetActionsSuppressorExtensionPeriod sets the ActionsSuppressorExtensionPeriod field's value.

func (*CompositeAlarm) SetActionsSuppressorWaitPeriod added in v1.44.60 

func (s *CompositeAlarm) SetActionsSuppressorWaitPeriod(v int64) *CompositeAlarm

SetActionsSuppressorWaitPeriod sets the ActionsSuppressorWaitPeriod field's value.

func (*CompositeAlarm) SetAlarmActions added in v1.29.15 

func (s *CompositeAlarm) SetAlarmActions(v []*string) *CompositeAlarm

SetAlarmActions sets the AlarmActions field's value.

func (*CompositeAlarm) SetAlarmArn added in v1.29.15 

func (s *CompositeAlarm) SetAlarmArn(v string) *CompositeAlarm

SetAlarmArn sets the AlarmArn field's value.

func (*CompositeAlarm) SetAlarmConfigurationUpdatedTimestamp added in v1.29.15 

func (s *CompositeAlarm) SetAlarmConfigurationUpdatedTimestamp(v time.Time) *CompositeAlarm

SetAlarmConfigurationUpdatedTimestamp sets the AlarmConfigurationUpdatedTimestamp field's value.

func (*CompositeAlarm) SetAlarmDescription added in v1.29.15 

func (s *CompositeAlarm) SetAlarmDescription(v string) *CompositeAlarm

SetAlarmDescription sets the AlarmDescription field's value.

func (*CompositeAlarm) SetAlarmName added in v1.29.15 

func (s *CompositeAlarm) SetAlarmName(v string) *CompositeAlarm

SetAlarmName sets the AlarmName field's value.

func (*CompositeAlarm) SetAlarmRule added in v1.29.15 

func (s *CompositeAlarm) SetAlarmRule(v string) *CompositeAlarm

SetAlarmRule sets the AlarmRule field's value.

func (*CompositeAlarm) SetInsufficientDataActions added in v1.29.15 

func (s *CompositeAlarm) SetInsufficientDataActions(v []*string) *CompositeAlarm

SetInsufficientDataActions sets the InsufficientDataActions field's value.

func (*CompositeAlarm) SetOKActions added in v1.29.15 

func (s *CompositeAlarm) SetOKActions(v []*string) *CompositeAlarm

SetOKActions sets the OKActions field's value.

func (*CompositeAlarm) SetStateReason added in v1.29.15 

func (s *CompositeAlarm) SetStateReason(v string) *CompositeAlarm

SetStateReason sets the StateReason field's value.

func (*CompositeAlarm) SetStateReasonData added in v1.29.15 

func (s *CompositeAlarm) SetStateReasonData(v string) *CompositeAlarm

SetStateReasonData sets the StateReasonData field's value.

func (*CompositeAlarm) SetStateTransitionedTimestamp added in v1.44.60 

func (s *CompositeAlarm) SetStateTransitionedTimestamp(v time.Time) *CompositeAlarm

SetStateTransitionedTimestamp sets the StateTransitionedTimestamp field's value.

func (*CompositeAlarm) SetStateUpdatedTimestamp added in v1.29.15 

func (s *CompositeAlarm) SetStateUpdatedTimestamp(v time.Time) *CompositeAlarm

SetStateUpdatedTimestamp sets the StateUpdatedTimestamp field's value.

func (*CompositeAlarm) SetStateValue added in v1.29.15 

func (s *CompositeAlarm) SetStateValue(v string) *CompositeAlarm

SetStateValue sets the StateValue field's value.

func (CompositeAlarm) String added in v1.29.15 

func (s CompositeAlarm) 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 DashboardEntry added in v1.10.7 

type DashboardEntry struct {

	// The Amazon Resource Name (ARN) of the dashboard.
	DashboardArn *string `type:"string"`

	// The name of the dashboard.
	DashboardName *string `type:"string"`

	// The time stamp of when the dashboard was last modified, either by an API
	// call or through the console. This number is expressed as the number of milliseconds
	// since Jan 1, 1970 00:00:00 UTC.
	LastModified *time.Time `type:"timestamp"`

	// The size of the dashboard, in bytes.
	Size *int64 `type:"long"`
	// contains filtered or unexported fields
}

Represents a specific dashboard.

func (DashboardEntry) GoString added in v1.10.7 

func (s DashboardEntry) 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 (*DashboardEntry) SetDashboardArn added in v1.10.7 

func (s *DashboardEntry) SetDashboardArn(v string) *DashboardEntry

SetDashboardArn sets the DashboardArn field's value.

func (*DashboardEntry) SetDashboardName added in v1.10.7 

func (s *DashboardEntry) SetDashboardName(v string) *DashboardEntry

SetDashboardName sets the DashboardName field's value.

func (*DashboardEntry) SetLastModified added in v1.10.7 

func (s *DashboardEntry) SetLastModified(v time.Time) *DashboardEntry

SetLastModified sets the LastModified field's value.

func (*DashboardEntry) SetSize added in v1.10.7 

func (s *DashboardEntry) SetSize(v int64) *DashboardEntry

SetSize sets the Size field's value.

func (DashboardEntry) String added in v1.10.7 

func (s DashboardEntry) 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 DashboardValidationMessage added in v1.10.7 

type DashboardValidationMessage struct {

	// The data path related to the message.
	DataPath *string `type:"string"`

	// A message describing the error or warning.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

An error or warning for the operation.

func (DashboardValidationMessage) GoString added in v1.10.7 

func (s DashboardValidationMessage) 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 (*DashboardValidationMessage) SetDataPath added in v1.10.7 

func (s *DashboardValidationMessage) SetDataPath(v string) *DashboardValidationMessage

SetDataPath sets the DataPath field's value.

func (*DashboardValidationMessage) SetMessage added in v1.10.7 

func (s *DashboardValidationMessage) SetMessage(v string) *DashboardValidationMessage

SetMessage sets the Message field's value.

func (DashboardValidationMessage) String added in v1.10.7 

func (s DashboardValidationMessage) 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 average of the metric values that correspond to the data point.
	Average *float64 `type:"double"`

	// The percentile statistic for the data point.
	ExtendedStatistics map[string]*float64 `type:"map"`

	// The maximum metric value for the data point.
	Maximum *float64 `type:"double"`

	// The minimum metric value for the data point.
	Minimum *float64 `type:"double"`

	// The number of metric values that contributed to the aggregate value of this
	// data point.
	SampleCount *float64 `type:"double"`

	// The sum of the metric values for the data point.
	Sum *float64 `type:"double"`

	// The time stamp used for the data point.
	Timestamp *time.Time `type:"timestamp"`

	// The standard unit for the data point.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

Encapsulates the statistical data that CloudWatch computes from metric data.

func (Datapoint) GoString added in v0.6.5 

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) SetAverage added in v1.5.0 

func (s *Datapoint) SetAverage(v float64) *Datapoint

SetAverage sets the Average field's value.

func (*Datapoint) SetExtendedStatistics added in v1.5.7 

func (s *Datapoint) SetExtendedStatistics(v map[string]*float64) *Datapoint

SetExtendedStatistics sets the ExtendedStatistics field's value.

func (*Datapoint) SetMaximum added in v1.5.0 

func (s *Datapoint) SetMaximum(v float64) *Datapoint

SetMaximum sets the Maximum field's value.

func (*Datapoint) SetMinimum added in v1.5.0 

func (s *Datapoint) SetMinimum(v float64) *Datapoint

SetMinimum sets the Minimum field's value.

func (*Datapoint) SetSampleCount added in v1.5.0 

func (s *Datapoint) SetSampleCount(v float64) *Datapoint

SetSampleCount sets the SampleCount field's value.

func (*Datapoint) SetSum added in v1.5.0 

func (s *Datapoint) SetSum(v float64) *Datapoint

SetSum sets the Sum field's value.

func (*Datapoint) SetTimestamp added in v1.5.0 

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

SetTimestamp sets the Timestamp field's value.

func (*Datapoint) SetUnit added in v1.5.0 

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

SetUnit sets the Unit field's value.

func (Datapoint) String added in v0.6.5 

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 DeleteAlarmsInput 

type DeleteAlarmsInput struct {

	// The alarms to be deleted.
	//
	// AlarmNames is a required field
	AlarmNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAlarmsInput) GoString added in v0.6.5 

func (s DeleteAlarmsInput) 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 (*DeleteAlarmsInput) SetAlarmNames added in v1.5.0 

func (s *DeleteAlarmsInput) SetAlarmNames(v []*string) *DeleteAlarmsInput

SetAlarmNames sets the AlarmNames field's value.

func (DeleteAlarmsInput) String added in v0.6.5 

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

func (s *DeleteAlarmsInput) Validate() error

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

type DeleteAlarmsOutput 

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

func (DeleteAlarmsOutput) GoString added in v0.6.5 

func (s DeleteAlarmsOutput) 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 (DeleteAlarmsOutput) String added in v0.6.5 

func (s DeleteAlarmsOutput) 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 DeleteAnomalyDetectorInput added in v1.20.17 

type DeleteAnomalyDetectorInput struct {

	// The metric dimensions associated with the anomaly detection model to delete.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	Dimensions []*Dimension `deprecated:"true" type:"list"`

	// The metric math anomaly detector to be deleted.
	//
	// When using MetricMathAnomalyDetector, you cannot include following parameters
	// in the same operation:
	//
	//    * Dimensions,
	//
	//    * MetricName
	//
	//    * Namespace
	//
	//    * Stat
	//
	//    * the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput
	//
	// Instead, specify the metric math anomaly detector attributes as part of the
	// MetricMathAnomalyDetector property.
	MetricMathAnomalyDetector *MetricMathAnomalyDetector `type:"structure"`

	// The metric name associated with the anomaly detection model to delete.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	MetricName *string `min:"1" deprecated:"true" type:"string"`

	// The namespace associated with the anomaly detection model to delete.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	Namespace *string `min:"1" deprecated:"true" type:"string"`

	// A single metric anomaly detector to be deleted.
	//
	// When using SingleMetricAnomalyDetector, you cannot include the following
	// parameters in the same operation:
	//
	//    * Dimensions,
	//
	//    * MetricName
	//
	//    * Namespace
	//
	//    * Stat
	//
	//    * the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput
	//
	// Instead, specify the single metric anomaly detector attributes as part of
	// the SingleMetricAnomalyDetector property.
	SingleMetricAnomalyDetector *SingleMetricAnomalyDetector `type:"structure"`

	// The statistic associated with the anomaly detection model to delete.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	Stat *string `deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteAnomalyDetectorInput) GoString added in v1.20.17 

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

func (s *DeleteAnomalyDetectorInput) SetDimensions(v []*Dimension) *DeleteAnomalyDetectorInput

SetDimensions sets the Dimensions field's value.

func (*DeleteAnomalyDetectorInput) SetMetricMathAnomalyDetector added in v1.42.8 

func (s *DeleteAnomalyDetectorInput) SetMetricMathAnomalyDetector(v *MetricMathAnomalyDetector) *DeleteAnomalyDetectorInput

SetMetricMathAnomalyDetector sets the MetricMathAnomalyDetector field's value.

func (*DeleteAnomalyDetectorInput) SetMetricName added in v1.20.17 

func (s *DeleteAnomalyDetectorInput) SetMetricName(v string) *DeleteAnomalyDetectorInput

SetMetricName sets the MetricName field's value.

func (*DeleteAnomalyDetectorInput) SetNamespace added in v1.20.17 

func (s *DeleteAnomalyDetectorInput) SetNamespace(v string) *DeleteAnomalyDetectorInput

SetNamespace sets the Namespace field's value.

func (*DeleteAnomalyDetectorInput) SetSingleMetricAnomalyDetector added in v1.42.8 

func (s *DeleteAnomalyDetectorInput) SetSingleMetricAnomalyDetector(v *SingleMetricAnomalyDetector) *DeleteAnomalyDetectorInput

SetSingleMetricAnomalyDetector sets the SingleMetricAnomalyDetector field's value.

func (*DeleteAnomalyDetectorInput) SetStat added in v1.20.17 

func (s *DeleteAnomalyDetectorInput) SetStat(v string) *DeleteAnomalyDetectorInput

SetStat sets the Stat field's value.

func (DeleteAnomalyDetectorInput) String added in v1.20.17 

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

func (s *DeleteAnomalyDetectorInput) Validate() error

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

type DeleteAnomalyDetectorOutput added in v1.20.17 

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

func (DeleteAnomalyDetectorOutput) GoString added in v1.20.17 

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

func (s DeleteAnomalyDetectorOutput) 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 DeleteDashboardsInput added in v1.10.7 

type DeleteDashboardsInput struct {

	// The dashboards to be deleted. This parameter is required.
	//
	// DashboardNames is a required field
	DashboardNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDashboardsInput) GoString added in v1.10.7 

func (s DeleteDashboardsInput) 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 (*DeleteDashboardsInput) SetDashboardNames added in v1.10.7 

func (s *DeleteDashboardsInput) SetDashboardNames(v []*string) *DeleteDashboardsInput

SetDashboardNames sets the DashboardNames field's value.

func (DeleteDashboardsInput) String added in v1.10.7 

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

func (s *DeleteDashboardsInput) Validate() error

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

type DeleteDashboardsOutput added in v1.10.7 

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

func (DeleteDashboardsOutput) GoString added in v1.10.7 

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

func (s DeleteDashboardsOutput) 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 DeleteInsightRulesInput added in v1.25.42 

type DeleteInsightRulesInput struct {

	// An array of the rule names to delete. If you need to find out the names of
	// your rules, use DescribeInsightRules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html).
	//
	// RuleNames is a required field
	RuleNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteInsightRulesInput) GoString added in v1.25.42 

func (s DeleteInsightRulesInput) 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 (*DeleteInsightRulesInput) SetRuleNames added in v1.25.42 

func (s *DeleteInsightRulesInput) SetRuleNames(v []*string) *DeleteInsightRulesInput

SetRuleNames sets the RuleNames field's value.

func (DeleteInsightRulesInput) String added in v1.25.42 

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

func (s *DeleteInsightRulesInput) Validate() error

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

type DeleteInsightRulesOutput added in v1.25.42 

type DeleteInsightRulesOutput struct {

	// An array listing the rules that could not be deleted. You cannot delete built-in
	// rules.
	Failures []*PartialFailure `type:"list"`
	// contains filtered or unexported fields
}

func (DeleteInsightRulesOutput) GoString added in v1.25.42 

func (s DeleteInsightRulesOutput) 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 (*DeleteInsightRulesOutput) SetFailures added in v1.25.42 

func (s *DeleteInsightRulesOutput) SetFailures(v []*PartialFailure) *DeleteInsightRulesOutput

SetFailures sets the Failures field's value.

func (DeleteInsightRulesOutput) String added in v1.25.42 

func (s DeleteInsightRulesOutput) 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 DeleteMetricStreamInput added in v1.38.9 

type DeleteMetricStreamInput struct {

	// The name of the metric stream to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMetricStreamInput) GoString added in v1.38.9 

func (s DeleteMetricStreamInput) 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 (*DeleteMetricStreamInput) SetName added in v1.38.9 

func (s *DeleteMetricStreamInput) SetName(v string) *DeleteMetricStreamInput

SetName sets the Name field's value.

func (DeleteMetricStreamInput) String added in v1.38.9 

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

func (s *DeleteMetricStreamInput) Validate() error

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

type DeleteMetricStreamOutput added in v1.38.9 

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

func (DeleteMetricStreamOutput) GoString added in v1.38.9 

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

func (s DeleteMetricStreamOutput) 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 DescribeAlarmHistoryInput 

type DescribeAlarmHistoryInput struct {

	// The name of the alarm.
	AlarmName *string `min:"1" type:"string"`

	// Use this parameter to specify whether you want the operation to return metric
	// alarms or composite alarms. If you omit this parameter, only metric alarms
	// are returned.
	AlarmTypes []*string `type:"list" enum:"AlarmType"`

	// The ending date to retrieve alarm history.
	EndDate *time.Time `type:"timestamp"`

	// The type of alarm histories to retrieve.
	HistoryItemType *string `type:"string" enum:"HistoryItemType"`

	// The maximum number of alarm history records to retrieve.
	MaxRecords *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `type:"string"`

	// Specified whether to return the newest or oldest alarm history first. Specify
	// TimestampDescending to have the newest event history returned first, and
	// specify TimestampAscending to have the oldest history returned first.
	ScanBy *string `type:"string" enum:"ScanBy"`

	// The starting date to retrieve alarm history.
	StartDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeAlarmHistoryInput) GoString added in v0.6.5 

func (s DescribeAlarmHistoryInput) 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 (*DescribeAlarmHistoryInput) SetAlarmName added in v1.5.0 

func (s *DescribeAlarmHistoryInput) SetAlarmName(v string) *DescribeAlarmHistoryInput

SetAlarmName sets the AlarmName field's value.

func (*DescribeAlarmHistoryInput) SetAlarmTypes added in v1.29.15 

func (s *DescribeAlarmHistoryInput) SetAlarmTypes(v []*string) *DescribeAlarmHistoryInput

SetAlarmTypes sets the AlarmTypes field's value.

func (*DescribeAlarmHistoryInput) SetEndDate added in v1.5.0 

func (s *DescribeAlarmHistoryInput) SetEndDate(v time.Time) *DescribeAlarmHistoryInput

SetEndDate sets the EndDate field's value.

func (*DescribeAlarmHistoryInput) SetHistoryItemType added in v1.5.0 

func (s *DescribeAlarmHistoryInput) SetHistoryItemType(v string) *DescribeAlarmHistoryInput

SetHistoryItemType sets the HistoryItemType field's value.

func (*DescribeAlarmHistoryInput) SetMaxRecords added in v1.5.0 

func (s *DescribeAlarmHistoryInput) SetMaxRecords(v int64) *DescribeAlarmHistoryInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeAlarmHistoryInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeAlarmHistoryInput) SetScanBy added in v1.29.15 

func (s *DescribeAlarmHistoryInput) SetScanBy(v string) *DescribeAlarmHistoryInput

SetScanBy sets the ScanBy field's value.

func (*DescribeAlarmHistoryInput) SetStartDate added in v1.5.0 

func (s *DescribeAlarmHistoryInput) SetStartDate(v time.Time) *DescribeAlarmHistoryInput

SetStartDate sets the StartDate field's value.

func (DescribeAlarmHistoryInput) String added in v0.6.5 

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

func (s *DescribeAlarmHistoryInput) Validate() error

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

type DescribeAlarmHistoryOutput 

type DescribeAlarmHistoryOutput struct {

	// The alarm histories, in JSON format.
	AlarmHistoryItems []*AlarmHistoryItem `type:"list"`

	// The token that marks the start of the next batch of returned results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAlarmHistoryOutput) GoString added in v0.6.5 

func (s DescribeAlarmHistoryOutput) 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 (*DescribeAlarmHistoryOutput) SetAlarmHistoryItems added in v1.5.0 

func (s *DescribeAlarmHistoryOutput) SetAlarmHistoryItems(v []*AlarmHistoryItem) *DescribeAlarmHistoryOutput

SetAlarmHistoryItems sets the AlarmHistoryItems field's value.

func (*DescribeAlarmHistoryOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (DescribeAlarmHistoryOutput) String added in v0.6.5 

func (s DescribeAlarmHistoryOutput) 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 DescribeAlarmsForMetricInput 

type DescribeAlarmsForMetricInput struct {

	// The dimensions associated with the metric. If the metric has any associated
	// dimensions, you must specify them in order for the call to succeed.
	Dimensions []*Dimension `type:"list"`

	// The percentile statistic for the metric. Specify a value between p0.0 and
	// p100.
	ExtendedStatistic *string `type:"string"`

	// The name of the metric.
	//
	// MetricName is a required field
	MetricName *string `min:"1" type:"string" required:"true"`

	// The namespace of the metric.
	//
	// Namespace is a required field
	Namespace *string `min:"1" type:"string" required:"true"`

	// The period, in seconds, over which the statistic is applied.
	Period *int64 `min:"1" type:"integer"`

	// The statistic for the metric, other than percentiles. For percentile statistics,
	// use ExtendedStatistics.
	Statistic *string `type:"string" enum:"Statistic"`

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

func (DescribeAlarmsForMetricInput) GoString added in v0.6.5 

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

func (s *DescribeAlarmsForMetricInput) SetDimensions(v []*Dimension) *DescribeAlarmsForMetricInput

SetDimensions sets the Dimensions field's value.

func (*DescribeAlarmsForMetricInput) SetExtendedStatistic added in v1.5.7 

func (s *DescribeAlarmsForMetricInput) SetExtendedStatistic(v string) *DescribeAlarmsForMetricInput

SetExtendedStatistic sets the ExtendedStatistic field's value.

func (*DescribeAlarmsForMetricInput) SetMetricName added in v1.5.0 

func (s *DescribeAlarmsForMetricInput) SetMetricName(v string) *DescribeAlarmsForMetricInput

SetMetricName sets the MetricName field's value.

func (*DescribeAlarmsForMetricInput) SetNamespace added in v1.5.0 

func (s *DescribeAlarmsForMetricInput) SetNamespace(v string) *DescribeAlarmsForMetricInput

SetNamespace sets the Namespace field's value.

func (*DescribeAlarmsForMetricInput) SetPeriod added in v1.5.0 

func (s *DescribeAlarmsForMetricInput) SetPeriod(v int64) *DescribeAlarmsForMetricInput

SetPeriod sets the Period field's value.

func (*DescribeAlarmsForMetricInput) SetStatistic added in v1.5.0 

func (s *DescribeAlarmsForMetricInput) SetStatistic(v string) *DescribeAlarmsForMetricInput

SetStatistic sets the Statistic field's value.

func (*DescribeAlarmsForMetricInput) SetUnit added in v1.5.0 

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

SetUnit sets the Unit field's value.

func (DescribeAlarmsForMetricInput) String added in v0.6.5 

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

func (s *DescribeAlarmsForMetricInput) Validate() error

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

type DescribeAlarmsForMetricOutput 

type DescribeAlarmsForMetricOutput struct {

	// The information for each alarm with the specified metric.
	MetricAlarms []*MetricAlarm `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeAlarmsForMetricOutput) GoString added in v0.6.5 

func (s DescribeAlarmsForMetricOutput) 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 (*DescribeAlarmsForMetricOutput) SetMetricAlarms added in v1.5.0 

func (s *DescribeAlarmsForMetricOutput) SetMetricAlarms(v []*MetricAlarm) *DescribeAlarmsForMetricOutput

SetMetricAlarms sets the MetricAlarms field's value.

func (DescribeAlarmsForMetricOutput) String added in v0.6.5 

func (s DescribeAlarmsForMetricOutput) 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 DescribeAlarmsInput 

type DescribeAlarmsInput struct {

	// Use this parameter to filter the results of the operation to only those alarms
	// that use a certain alarm action. For example, you could specify the ARN of
	// an SNS topic to find all alarms that send notifications to that topic.
	ActionPrefix *string `min:"1" type:"string"`

	// An alarm name prefix. If you specify this parameter, you receive information
	// about all alarms that have names that start with this prefix.
	//
	// If this parameter is specified, you cannot specify AlarmNames.
	AlarmNamePrefix *string `min:"1" type:"string"`

	// The names of the alarms to retrieve information about.
	AlarmNames []*string `type:"list"`

	// Use this parameter to specify whether you want the operation to return metric
	// alarms or composite alarms. If you omit this parameter, only metric alarms
	// are returned.
	AlarmTypes []*string `type:"list" enum:"AlarmType"`

	// If you use this parameter and specify the name of a composite alarm, the
	// operation returns information about the "children" alarms of the alarm you
	// specify. These are the metric alarms and composite alarms referenced in the
	// AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName.
	// Information about the composite alarm that you name in ChildrenOfAlarmName
	// is not returned.
	//
	// If you specify ChildrenOfAlarmName, you cannot specify any other parameters
	// in the request except for MaxRecords and NextToken. If you do so, you receive
	// a validation error.
	//
	// Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
	// information are returned by this operation when you use this parameter. To
	// get complete information about these alarms, perform another DescribeAlarms
	// operation and specify the parent alarm names in the AlarmNames parameter.
	ChildrenOfAlarmName *string `min:"1" type:"string"`

	// The maximum number of alarm descriptions to retrieve.
	MaxRecords *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `type:"string"`

	// If you use this parameter and specify the name of a metric or composite alarm,
	// the operation returns information about the "parent" alarms of the alarm
	// you specify. These are the composite alarms that have AlarmRule parameters
	// that reference the alarm named in ParentsOfAlarmName. Information about the
	// alarm that you specify in ParentsOfAlarmName is not returned.
	//
	// If you specify ParentsOfAlarmName, you cannot specify any other parameters
	// in the request except for MaxRecords and NextToken. If you do so, you receive
	// a validation error.
	//
	// Only the Alarm Name and ARN are returned by this operation when you use this
	// parameter. To get complete information about these alarms, perform another
	// DescribeAlarms operation and specify the parent alarm names in the AlarmNames
	// parameter.
	ParentsOfAlarmName *string `min:"1" type:"string"`

	// Specify this parameter to receive information only about alarms that are
	// currently in the state that you specify.
	StateValue *string `type:"string" enum:"StateValue"`
	// contains filtered or unexported fields
}

func (DescribeAlarmsInput) GoString added in v0.6.5 

func (s DescribeAlarmsInput) 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 (*DescribeAlarmsInput) SetActionPrefix added in v1.5.0 

func (s *DescribeAlarmsInput) SetActionPrefix(v string) *DescribeAlarmsInput

SetActionPrefix sets the ActionPrefix field's value.

func (*DescribeAlarmsInput) SetAlarmNamePrefix added in v1.5.0 

func (s *DescribeAlarmsInput) SetAlarmNamePrefix(v string) *DescribeAlarmsInput

SetAlarmNamePrefix sets the AlarmNamePrefix field's value.

func (*DescribeAlarmsInput) SetAlarmNames added in v1.5.0 

func (s *DescribeAlarmsInput) SetAlarmNames(v []*string) *DescribeAlarmsInput

SetAlarmNames sets the AlarmNames field's value.

func (*DescribeAlarmsInput) SetAlarmTypes added in v1.29.15 

func (s *DescribeAlarmsInput) SetAlarmTypes(v []*string) *DescribeAlarmsInput

SetAlarmTypes sets the AlarmTypes field's value.

func (*DescribeAlarmsInput) SetChildrenOfAlarmName added in v1.29.15 

func (s *DescribeAlarmsInput) SetChildrenOfAlarmName(v string) *DescribeAlarmsInput

SetChildrenOfAlarmName sets the ChildrenOfAlarmName field's value.

func (*DescribeAlarmsInput) SetMaxRecords added in v1.5.0 

func (s *DescribeAlarmsInput) SetMaxRecords(v int64) *DescribeAlarmsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeAlarmsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeAlarmsInput) SetParentsOfAlarmName added in v1.29.15 

func (s *DescribeAlarmsInput) SetParentsOfAlarmName(v string) *DescribeAlarmsInput

SetParentsOfAlarmName sets the ParentsOfAlarmName field's value.

func (*DescribeAlarmsInput) SetStateValue added in v1.5.0 

func (s *DescribeAlarmsInput) SetStateValue(v string) *DescribeAlarmsInput

SetStateValue sets the StateValue field's value.

func (DescribeAlarmsInput) String added in v0.6.5 

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

func (s *DescribeAlarmsInput) Validate() error

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

type DescribeAlarmsOutput 

type DescribeAlarmsOutput struct {

	// The information about any composite alarms returned by the operation.
	CompositeAlarms []*CompositeAlarm `type:"list"`

	// The information about any metric alarms returned by the operation.
	MetricAlarms []*MetricAlarm `type:"list"`

	// The token that marks the start of the next batch of returned results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAlarmsOutput) GoString added in v0.6.5 

func (s DescribeAlarmsOutput) 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 (*DescribeAlarmsOutput) SetCompositeAlarms added in v1.29.15 

func (s *DescribeAlarmsOutput) SetCompositeAlarms(v []*CompositeAlarm) *DescribeAlarmsOutput

SetCompositeAlarms sets the CompositeAlarms field's value.

func (*DescribeAlarmsOutput) SetMetricAlarms added in v1.5.0 

func (s *DescribeAlarmsOutput) SetMetricAlarms(v []*MetricAlarm) *DescribeAlarmsOutput

SetMetricAlarms sets the MetricAlarms field's value.

func (*DescribeAlarmsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (DescribeAlarmsOutput) String added in v0.6.5 

func (s DescribeAlarmsOutput) 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 DescribeAnomalyDetectorsInput added in v1.20.17 

type DescribeAnomalyDetectorsInput struct {

	// The anomaly detector types to request when using DescribeAnomalyDetectorsInput.
	// If empty, defaults to SINGLE_METRIC.
	AnomalyDetectorTypes []*string `type:"list" enum:"AnomalyDetectorType"`

	// Limits the results to only the anomaly detection models that are associated
	// with the specified metric dimensions. If there are multiple metrics that
	// have these dimensions and have anomaly detection models associated, they're
	// all returned.
	Dimensions []*Dimension `type:"list"`

	// The maximum number of results to return in one operation. The maximum value
	// that you can specify is 100.
	//
	// To retrieve the remaining results, make another call with the returned NextToken
	// value.
	MaxResults *int64 `min:"1" type:"integer"`

	// Limits the results to only the anomaly detection models that are associated
	// with the specified metric name. If there are multiple metrics with this name
	// in different namespaces that have anomaly detection models, they're all returned.
	MetricName *string `min:"1" type:"string"`

	// Limits the results to only the anomaly detection models that are associated
	// with the specified namespace.
	Namespace *string `min:"1" type:"string"`

	// Use the token returned by the previous operation to request the next page
	// of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAnomalyDetectorsInput) GoString added in v1.20.17 

func (s DescribeAnomalyDetectorsInput) 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 (*DescribeAnomalyDetectorsInput) SetAnomalyDetectorTypes added in v1.42.8 

func (s *DescribeAnomalyDetectorsInput) SetAnomalyDetectorTypes(v []*string) *DescribeAnomalyDetectorsInput

SetAnomalyDetectorTypes sets the AnomalyDetectorTypes field's value.

func (*DescribeAnomalyDetectorsInput) SetDimensions added in v1.20.17 

func (s *DescribeAnomalyDetectorsInput) SetDimensions(v []*Dimension) *DescribeAnomalyDetectorsInput

SetDimensions sets the Dimensions field's value.

func (*DescribeAnomalyDetectorsInput) SetMaxResults added in v1.20.17 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeAnomalyDetectorsInput) SetMetricName added in v1.20.17 

func (s *DescribeAnomalyDetectorsInput) SetMetricName(v string) *DescribeAnomalyDetectorsInput

SetMetricName sets the MetricName field's value.

func (*DescribeAnomalyDetectorsInput) SetNamespace added in v1.20.17 

func (s *DescribeAnomalyDetectorsInput) SetNamespace(v string) *DescribeAnomalyDetectorsInput

SetNamespace sets the Namespace field's value.

func (*DescribeAnomalyDetectorsInput) SetNextToken added in v1.20.17 

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

SetNextToken sets the NextToken field's value.

func (DescribeAnomalyDetectorsInput) String added in v1.20.17 

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

func (s *DescribeAnomalyDetectorsInput) Validate() error

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

type DescribeAnomalyDetectorsOutput added in v1.20.17 

type DescribeAnomalyDetectorsOutput struct {

	// The list of anomaly detection models returned by the operation.
	AnomalyDetectors []*AnomalyDetector `type:"list"`

	// A token that you can use in a subsequent operation to retrieve the next set
	// of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAnomalyDetectorsOutput) GoString added in v1.20.17 

func (s DescribeAnomalyDetectorsOutput) 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 (*DescribeAnomalyDetectorsOutput) SetAnomalyDetectors added in v1.20.17 

func (s *DescribeAnomalyDetectorsOutput) SetAnomalyDetectors(v []*AnomalyDetector) *DescribeAnomalyDetectorsOutput

SetAnomalyDetectors sets the AnomalyDetectors field's value.

func (*DescribeAnomalyDetectorsOutput) SetNextToken added in v1.20.17 

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

SetNextToken sets the NextToken field's value.

func (DescribeAnomalyDetectorsOutput) String added in v1.20.17 

func (s DescribeAnomalyDetectorsOutput) 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 DescribeInsightRulesInput added in v1.25.42 

type DescribeInsightRulesInput struct {

	// The maximum number of results to return in one operation. If you omit this
	// parameter, the default of 500 is used.
	MaxResults *int64 `min:"1" type:"integer"`

	// Include this value, if it was returned by the previous operation, to get
	// the next set of rules.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInsightRulesInput) GoString added in v1.25.42 

func (s DescribeInsightRulesInput) 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 (*DescribeInsightRulesInput) SetMaxResults added in v1.25.42 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeInsightRulesInput) SetNextToken added in v1.25.42 

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

SetNextToken sets the NextToken field's value.

func (DescribeInsightRulesInput) String added in v1.25.42 

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

func (s *DescribeInsightRulesInput) Validate() error

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

type DescribeInsightRulesOutput added in v1.25.42 

type DescribeInsightRulesOutput struct {

	// The rules returned by the operation.
	InsightRules []*InsightRule `type:"list"`

	// If this parameter is present, it is a token that marks the start of the next
	// batch of returned results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeInsightRulesOutput) GoString added in v1.25.42 

func (s DescribeInsightRulesOutput) 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 (*DescribeInsightRulesOutput) SetInsightRules added in v1.25.42 

func (s *DescribeInsightRulesOutput) SetInsightRules(v []*InsightRule) *DescribeInsightRulesOutput

SetInsightRules sets the InsightRules field's value.

func (*DescribeInsightRulesOutput) SetNextToken added in v1.25.42 

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

SetNextToken sets the NextToken field's value.

func (DescribeInsightRulesOutput) String added in v1.25.42 

func (s DescribeInsightRulesOutput) 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 Dimension 

type Dimension struct {

	// The name of the dimension. Dimension names must contain only ASCII characters,
	// must include at least one non-whitespace character, and cannot start with
	// a colon (:).
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The value of the dimension. Dimension values must contain only ASCII characters
	// and must include at least one non-whitespace character.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 30 dimensions to a metric.

func (Dimension) GoString added in v0.6.5 

func (s Dimension) 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 (*Dimension) SetName added in v1.5.0 

func (s *Dimension) SetName(v string) *Dimension

SetName sets the Name field's value.

func (*Dimension) SetValue added in v1.5.0 

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

SetValue sets the Value field's value.

func (Dimension) String added in v0.6.5 

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

func (s *Dimension) Validate() error

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

type DimensionFilter 

type DimensionFilter struct {

	// The dimension name to be matched.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The value of the dimension to be matched.
	Value *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents filters for a dimension.

func (DimensionFilter) GoString added in v0.6.5 

func (s DimensionFilter) 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 (*DimensionFilter) SetName added in v1.5.0 

func (s *DimensionFilter) SetName(v string) *DimensionFilter

SetName sets the Name field's value.

func (*DimensionFilter) SetValue added in v1.5.0 

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

SetValue sets the Value field's value.

func (DimensionFilter) String added in v0.6.5 

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

func (s *DimensionFilter) Validate() error

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

type DisableAlarmActionsInput 

type DisableAlarmActionsInput struct {

	// The names of the alarms.
	//
	// AlarmNames is a required field
	AlarmNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DisableAlarmActionsInput) GoString added in v0.6.5 

func (s DisableAlarmActionsInput) 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 (*DisableAlarmActionsInput) SetAlarmNames added in v1.5.0 

func (s *DisableAlarmActionsInput) SetAlarmNames(v []*string) *DisableAlarmActionsInput

SetAlarmNames sets the AlarmNames field's value.

func (DisableAlarmActionsInput) String added in v0.6.5 

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

func (s *DisableAlarmActionsInput) Validate() error

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

type DisableAlarmActionsOutput 

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

func (DisableAlarmActionsOutput) GoString added in v0.6.5 

func (s DisableAlarmActionsOutput) 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 (DisableAlarmActionsOutput) String added in v0.6.5 

func (s DisableAlarmActionsOutput) 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 DisableInsightRulesInput added in v1.25.42 

type DisableInsightRulesInput struct {

	// An array of the rule names to disable. If you need to find out the names
	// of your rules, use DescribeInsightRules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html).
	//
	// RuleNames is a required field
	RuleNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DisableInsightRulesInput) GoString added in v1.25.42 

func (s DisableInsightRulesInput) 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 (*DisableInsightRulesInput) SetRuleNames added in v1.25.42 

func (s *DisableInsightRulesInput) SetRuleNames(v []*string) *DisableInsightRulesInput

SetRuleNames sets the RuleNames field's value.

func (DisableInsightRulesInput) String added in v1.25.42 

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

func (s *DisableInsightRulesInput) Validate() error

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

type DisableInsightRulesOutput added in v1.25.42 

type DisableInsightRulesOutput struct {

	// An array listing the rules that could not be disabled. You cannot disable
	// built-in rules.
	Failures []*PartialFailure `type:"list"`
	// contains filtered or unexported fields
}

func (DisableInsightRulesOutput) GoString added in v1.25.42 

func (s DisableInsightRulesOutput) 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 (*DisableInsightRulesOutput) SetFailures added in v1.25.42 

func (s *DisableInsightRulesOutput) SetFailures(v []*PartialFailure) *DisableInsightRulesOutput

SetFailures sets the Failures field's value.

func (DisableInsightRulesOutput) String added in v1.25.42 

func (s DisableInsightRulesOutput) 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 EnableAlarmActionsInput 

type EnableAlarmActionsInput struct {

	// The names of the alarms.
	//
	// AlarmNames is a required field
	AlarmNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (EnableAlarmActionsInput) GoString added in v0.6.5 

func (s EnableAlarmActionsInput) 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 (*EnableAlarmActionsInput) SetAlarmNames added in v1.5.0 

func (s *EnableAlarmActionsInput) SetAlarmNames(v []*string) *EnableAlarmActionsInput

SetAlarmNames sets the AlarmNames field's value.

func (EnableAlarmActionsInput) String added in v0.6.5 

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

func (s *EnableAlarmActionsInput) Validate() error

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

type EnableAlarmActionsOutput 

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

func (EnableAlarmActionsOutput) GoString added in v0.6.5 

func (s EnableAlarmActionsOutput) 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 (EnableAlarmActionsOutput) String added in v0.6.5 

func (s EnableAlarmActionsOutput) 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 EnableInsightRulesInput added in v1.25.42 

type EnableInsightRulesInput struct {

	// An array of the rule names to enable. If you need to find out the names of
	// your rules, use DescribeInsightRules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html).
	//
	// RuleNames is a required field
	RuleNames []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (EnableInsightRulesInput) GoString added in v1.25.42 

func (s EnableInsightRulesInput) 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 (*EnableInsightRulesInput) SetRuleNames added in v1.25.42 

func (s *EnableInsightRulesInput) SetRuleNames(v []*string) *EnableInsightRulesInput

SetRuleNames sets the RuleNames field's value.

func (EnableInsightRulesInput) String added in v1.25.42 

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

func (s *EnableInsightRulesInput) Validate() error

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

type EnableInsightRulesOutput added in v1.25.42 

type EnableInsightRulesOutput struct {

	// An array listing the rules that could not be enabled. You cannot disable
	// or enable built-in rules.
	Failures []*PartialFailure `type:"list"`
	// contains filtered or unexported fields
}

func (EnableInsightRulesOutput) GoString added in v1.25.42 

func (s EnableInsightRulesOutput) 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 (*EnableInsightRulesOutput) SetFailures added in v1.25.42 

func (s *EnableInsightRulesOutput) SetFailures(v []*PartialFailure) *EnableInsightRulesOutput

SetFailures sets the Failures field's value.

func (EnableInsightRulesOutput) String added in v1.25.42 

func (s EnableInsightRulesOutput) 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 GetDashboardInput added in v1.10.7 

type GetDashboardInput struct {

	// The name of the dashboard to be described.
	//
	// DashboardName is a required field
	DashboardName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDashboardInput) GoString added in v1.10.7 

func (s GetDashboardInput) 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 (*GetDashboardInput) SetDashboardName added in v1.10.7 

func (s *GetDashboardInput) SetDashboardName(v string) *GetDashboardInput

SetDashboardName sets the DashboardName field's value.

func (GetDashboardInput) String added in v1.10.7 

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

func (s *GetDashboardInput) Validate() error

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

type GetDashboardOutput added in v1.10.7 

type GetDashboardOutput struct {

	// The Amazon Resource Name (ARN) of the dashboard.
	DashboardArn *string `type:"string"`

	// The detailed information about the dashboard, including what widgets are
	// included and their location on the dashboard. For more information about
	// the DashboardBody syntax, see Dashboard Body Structure and Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html).
	DashboardBody *string `type:"string"`

	// The name of the dashboard.
	DashboardName *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetDashboardOutput) GoString added in v1.10.7 

func (s GetDashboardOutput) 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 (*GetDashboardOutput) SetDashboardArn added in v1.10.7 

func (s *GetDashboardOutput) SetDashboardArn(v string) *GetDashboardOutput

SetDashboardArn sets the DashboardArn field's value.

func (*GetDashboardOutput) SetDashboardBody added in v1.10.7 

func (s *GetDashboardOutput) SetDashboardBody(v string) *GetDashboardOutput

SetDashboardBody sets the DashboardBody field's value.

func (*GetDashboardOutput) SetDashboardName added in v1.10.7 

func (s *GetDashboardOutput) SetDashboardName(v string) *GetDashboardOutput

SetDashboardName sets the DashboardName field's value.

func (GetDashboardOutput) String added in v1.10.7 

func (s GetDashboardOutput) 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 GetInsightRuleReportInput added in v1.25.42 

type GetInsightRuleReportInput struct {

	// The end time of the data to use in the report. When used in a raw HTTP Query
	// API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// The maximum number of contributors to include in the report. The range is
	// 1 to 100. If you omit this, the default of 10 is used.
	MaxContributorCount *int64 `type:"integer"`

	// Specifies which metrics to use for aggregation of contributor values for
	// the report. You can specify one or more of the following metrics:
	//
	//    * UniqueContributors -- the number of unique contributors for each data
	//    point.
	//
	//    * MaxContributorValue -- the value of the top contributor for each data
	//    point. The identity of the contributor might change for each data point
	//    in the graph. If this rule aggregates by COUNT, the top contributor for
	//    each data point is the contributor with the most occurrences in that period.
	//    If the rule aggregates by SUM, the top contributor is the contributor
	//    with the highest sum in the log field specified by the rule's Value, during
	//    that period.
	//
	//    * SampleCount -- the number of data points matched by the rule.
	//
	//    * Sum -- the sum of the values from all contributors during the time period
	//    represented by that data point.
	//
	//    * Minimum -- the minimum value from a single observation during the time
	//    period represented by that data point.
	//
	//    * Maximum -- the maximum value from a single observation during the time
	//    period represented by that data point.
	//
	//    * Average -- the average value from all contributors during the time period
	//    represented by that data point.
	Metrics []*string `type:"list"`

	// Determines what statistic to use to rank the contributors. Valid values are
	// SUM and MAXIMUM.
	OrderBy *string `min:"1" type:"string"`

	// The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint
	// results.
	//
	// Period is a required field
	Period *int64 `min:"1" type:"integer" required:"true"`

	// The name of the rule that you want to see data from.
	//
	// RuleName is a required field
	RuleName *string `min:"1" type:"string" required:"true"`

	// The start time of the data to use in the report. When used in a raw HTTP
	// Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetInsightRuleReportInput) GoString added in v1.25.42 

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

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

SetEndTime sets the EndTime field's value.

func (*GetInsightRuleReportInput) SetMaxContributorCount added in v1.25.42 

func (s *GetInsightRuleReportInput) SetMaxContributorCount(v int64) *GetInsightRuleReportInput

SetMaxContributorCount sets the MaxContributorCount field's value.

func (*GetInsightRuleReportInput) SetMetrics added in v1.25.42 

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

SetMetrics sets the Metrics field's value.

func (*GetInsightRuleReportInput) SetOrderBy added in v1.25.42 

func (s *GetInsightRuleReportInput) SetOrderBy(v string) *GetInsightRuleReportInput

SetOrderBy sets the OrderBy field's value.

func (*GetInsightRuleReportInput) SetPeriod added in v1.25.42 

func (s *GetInsightRuleReportInput) SetPeriod(v int64) *GetInsightRuleReportInput

SetPeriod sets the Period field's value.

func (*GetInsightRuleReportInput) SetRuleName added in v1.25.42 

func (s *GetInsightRuleReportInput) SetRuleName(v string) *GetInsightRuleReportInput

SetRuleName sets the RuleName field's value.

func (*GetInsightRuleReportInput) SetStartTime added in v1.25.42 

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

SetStartTime sets the StartTime field's value.

func (GetInsightRuleReportInput) String added in v1.25.42 

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

func (s *GetInsightRuleReportInput) Validate() error

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

type GetInsightRuleReportOutput added in v1.25.42 

type GetInsightRuleReportOutput struct {

	// The sum of the values from all individual contributors that match the rule.
	AggregateValue *float64 `type:"double"`

	// Specifies whether this rule aggregates contributor data by COUNT or SUM.
	AggregationStatistic *string `type:"string"`

	// An approximate count of the unique contributors found by this rule in this
	// time period.
	ApproximateUniqueCount *int64 `type:"long"`

	// An array of the unique contributors found by this rule in this time period.
	// If the rule contains multiple keys, each combination of values for the keys
	// counts as a unique contributor.
	Contributors []*InsightRuleContributor `type:"list"`

	// An array of the strings used as the keys for this rule. The keys are the
	// dimensions used to classify contributors. If the rule contains more than
	// one key, then each unique combination of values for the keys is counted as
	// a unique contributor.
	KeyLabels []*string `type:"list"`

	// A time series of metric data points that matches the time period in the rule
	// request.
	MetricDatapoints []*InsightRuleMetricDatapoint `type:"list"`
	// contains filtered or unexported fields
}

func (GetInsightRuleReportOutput) GoString added in v1.25.42 

func (s GetInsightRuleReportOutput) 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 (*GetInsightRuleReportOutput) SetAggregateValue added in v1.25.42 

func (s *GetInsightRuleReportOutput) SetAggregateValue(v float64) *GetInsightRuleReportOutput

SetAggregateValue sets the AggregateValue field's value.

func (*GetInsightRuleReportOutput) SetAggregationStatistic added in v1.25.42 

func (s *GetInsightRuleReportOutput) SetAggregationStatistic(v string) *GetInsightRuleReportOutput

SetAggregationStatistic sets the AggregationStatistic field's value.

func (*GetInsightRuleReportOutput) SetApproximateUniqueCount added in v1.25.42 

func (s *GetInsightRuleReportOutput) SetApproximateUniqueCount(v int64) *GetInsightRuleReportOutput

SetApproximateUniqueCount sets the ApproximateUniqueCount field's value.

func (*GetInsightRuleReportOutput) SetContributors added in v1.25.42 

func (s *GetInsightRuleReportOutput) SetContributors(v []*InsightRuleContributor) *GetInsightRuleReportOutput

SetContributors sets the Contributors field's value.

func (*GetInsightRuleReportOutput) SetKeyLabels added in v1.25.42 

func (s *GetInsightRuleReportOutput) SetKeyLabels(v []*string) *GetInsightRuleReportOutput

SetKeyLabels sets the KeyLabels field's value.

func (*GetInsightRuleReportOutput) SetMetricDatapoints added in v1.25.42 

func (s *GetInsightRuleReportOutput) SetMetricDatapoints(v []*InsightRuleMetricDatapoint) *GetInsightRuleReportOutput

SetMetricDatapoints sets the MetricDatapoints field's value.

func (GetInsightRuleReportOutput) String added in v1.25.42 

func (s GetInsightRuleReportOutput) 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 GetMetricDataInput added in v1.13.28 

type GetMetricDataInput struct {

	// The time stamp indicating the latest data to be returned.
	//
	// The value specified is exclusive; results include data points up to the specified
	// time stamp.
	//
	// For better performance, specify StartTime and EndTime values that align with
	// the value of the metric's Period and sync up with the beginning and end of
	// an hour. For example, if the Period of a metric is 5 minutes, specifying
	// 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than
	// setting 12:07 or 12:29 as the EndTime.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// This structure includes the Timezone parameter, which you can use to specify
	// your time zone so that the labels of returned data display the correct time
	// for your time zone.
	LabelOptions *LabelOptions `type:"structure"`

	// The maximum number of data points the request should return before paginating.
	// If you omit this, the default of 100,800 is used.
	MaxDatapoints *int64 `type:"integer"`

	// The metric queries to be returned. A single GetMetricData call can include
	// as many as 500 MetricDataQuery structures. Each of these structures can specify
	// either a metric to retrieve, a Metrics Insights query, or a math expression
	// to perform on retrieved data.
	//
	// MetricDataQueries is a required field
	MetricDataQueries []*MetricDataQuery `type:"list" required:"true"`

	// Include this value, if it was returned by the previous GetMetricData operation,
	// to get the next set of data points.
	NextToken *string `type:"string"`

	// The order in which data points should be returned. TimestampDescending returns
	// the newest data first and paginates when the MaxDatapoints limit is reached.
	// TimestampAscending returns the oldest data first and paginates when the MaxDatapoints
	// limit is reached.
	ScanBy *string `type:"string" enum:"ScanBy"`

	// The time stamp indicating the earliest data to be returned.
	//
	// The value specified is inclusive; results include data points with the specified
	// time stamp.
	//
	// CloudWatch rounds the specified time stamp as follows:
	//
	//    * Start time less than 15 days ago - Round down to the nearest whole minute.
	//    For example, 12:32:34 is rounded down to 12:32:00.
	//
	//    * Start time between 15 and 63 days ago - Round down to the nearest 5-minute
	//    clock interval. For example, 12:32:34 is rounded down to 12:30:00.
	//
	//    * Start time greater than 63 days ago - Round down to the nearest 1-hour
	//    clock interval. For example, 12:32:34 is rounded down to 12:00:00.
	//
	// If you set Period to 5, 10, or 30, the start time of your request is rounded
	// down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions
	// of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for
	// the previous 10-second period, the start time of your request is rounded
	// down and you receive data from 01:05:10 to 01:05:20. If you make a query
	// at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds,
	// you receive data timestamped between 15:02:15 and 15:07:15.
	//
	// For better performance, specify StartTime and EndTime values that align with
	// the value of the metric's Period and sync up with the beginning and end of
	// an hour. For example, if the Period of a metric is 5 minutes, specifying
	// 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than
	// setting 12:07 or 12:29 as the StartTime.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetMetricDataInput) GoString added in v1.13.28 

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

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

SetEndTime sets the EndTime field's value.

func (*GetMetricDataInput) SetLabelOptions added in v1.37.0 

func (s *GetMetricDataInput) SetLabelOptions(v *LabelOptions) *GetMetricDataInput

SetLabelOptions sets the LabelOptions field's value.

func (*GetMetricDataInput) SetMaxDatapoints added in v1.13.28 

func (s *GetMetricDataInput) SetMaxDatapoints(v int64) *GetMetricDataInput

SetMaxDatapoints sets the MaxDatapoints field's value.

func (*GetMetricDataInput) SetMetricDataQueries added in v1.13.28 

func (s *GetMetricDataInput) SetMetricDataQueries(v []*MetricDataQuery) *GetMetricDataInput

SetMetricDataQueries sets the MetricDataQueries field's value.

func (*GetMetricDataInput) SetNextToken added in v1.13.28 

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

SetNextToken sets the NextToken field's value.

func (*GetMetricDataInput) SetScanBy added in v1.13.28 

func (s *GetMetricDataInput) SetScanBy(v string) *GetMetricDataInput

SetScanBy sets the ScanBy field's value.

func (*GetMetricDataInput) SetStartTime added in v1.13.28 

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

SetStartTime sets the StartTime field's value.

func (GetMetricDataInput) String added in v1.13.28 

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

func (s *GetMetricDataInput) Validate() error

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

type GetMetricDataOutput added in v1.13.28 

type GetMetricDataOutput struct {

	// Contains a message about this GetMetricData operation, if the operation results
	// in such a message. An example of a message that might be returned is Maximum
	// number of allowed metrics exceeded. If there is a message, as much of the
	// operation as possible is still executed.
	//
	// A message appears here only if it is related to the global GetMetricData
	// operation. Any message about a specific metric returned by the operation
	// appears in the MetricDataResult object returned for that metric.
	Messages []*MessageData `type:"list"`

	// The metrics that are returned, including the metric name, namespace, and
	// dimensions.
	MetricDataResults []*MetricDataResult `type:"list"`

	// A token that marks the next batch of returned results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetMetricDataOutput) GoString added in v1.13.28 

func (s GetMetricDataOutput) 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 (*GetMetricDataOutput) SetMessages added in v1.18.3 

func (s *GetMetricDataOutput) SetMessages(v []*MessageData) *GetMetricDataOutput

SetMessages sets the Messages field's value.

func (*GetMetricDataOutput) SetMetricDataResults added in v1.13.28 

func (s *GetMetricDataOutput) SetMetricDataResults(v []*MetricDataResult) *GetMetricDataOutput

SetMetricDataResults sets the MetricDataResults field's value.

func (*GetMetricDataOutput) SetNextToken added in v1.13.28 

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

SetNextToken sets the NextToken field's value.

func (GetMetricDataOutput) String added in v1.13.28 

func (s GetMetricDataOutput) 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 GetMetricStatisticsInput 

type GetMetricStatisticsInput struct {

	// The dimensions. If the metric contains multiple dimensions, you must include
	// a value for each dimension. CloudWatch treats each unique combination of
	// dimensions as a separate metric. If a specific combination of dimensions
	// was not published, you can't retrieve statistics for it. You must specify
	// the same dimensions that were used when the metrics were created. For an
	// example, see Dimension Combinations (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations)
	// in the Amazon CloudWatch User Guide. For more information about specifying
	// dimensions, see Publishing Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)
	// in the Amazon CloudWatch User Guide.
	Dimensions []*Dimension `type:"list"`

	// The time stamp that determines the last data point to return.
	//
	// The value specified is exclusive; results include data points up to the specified
	// time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format
	// (for example, 2016-10-10T23:00:00Z).
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// The percentile statistics. Specify values between p0.0 and p100. When calling
	// GetMetricStatistics, you must specify either Statistics or ExtendedStatistics,
	// but not both. Percentile statistics are not available for metrics when any
	// of the metric values are negative numbers.
	ExtendedStatistics []*string `min:"1" type:"list"`

	// The name of the metric, with or without spaces.
	//
	// MetricName is a required field
	MetricName *string `min:"1" type:"string" required:"true"`

	// The namespace of the metric, with or without spaces.
	//
	// Namespace is a required field
	Namespace *string `min:"1" type:"string" required:"true"`

	// The granularity, in seconds, of the returned data points. For metrics with
	// regular resolution, a period can be as short as one minute (60 seconds) and
	// must be a multiple of 60. For high-resolution metrics that are collected
	// at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
	// or any multiple of 60. High-resolution metrics are those metrics stored by
	// a PutMetricData call that includes a StorageResolution of 1 second.
	//
	// If the StartTime parameter specifies a time stamp that is greater than 3
	// hours ago, you must specify the period as follows or no data points in that
	// time range is returned:
	//
	//    * Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
	//    (1 minute).
	//
	//    * Start time between 15 and 63 days ago - Use a multiple of 300 seconds
	//    (5 minutes).
	//
	//    * Start time greater than 63 days ago - Use a multiple of 3600 seconds
	//    (1 hour).
	//
	// Period is a required field
	Period *int64 `min:"1" type:"integer" required:"true"`

	// The time stamp that determines the first data point to return. Start times
	// are evaluated relative to the time that CloudWatch receives the request.
	//
	// The value specified is inclusive; results include data points with the specified
	// time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format
	// (for example, 2016-10-03T23:00:00Z).
	//
	// CloudWatch rounds the specified time stamp as follows:
	//
	//    * Start time less than 15 days ago - Round down to the nearest whole minute.
	//    For example, 12:32:34 is rounded down to 12:32:00.
	//
	//    * Start time between 15 and 63 days ago - Round down to the nearest 5-minute
	//    clock interval. For example, 12:32:34 is rounded down to 12:30:00.
	//
	//    * Start time greater than 63 days ago - Round down to the nearest 1-hour
	//    clock interval. For example, 12:32:34 is rounded down to 12:00:00.
	//
	// If you set Period to 5, 10, or 30, the start time of your request is rounded
	// down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions
	// of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for
	// the previous 10-second period, the start time of your request is rounded
	// down and you receive data from 01:05:10 to 01:05:20. If you make a query
	// at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds,
	// you receive data timestamped between 15:02:15 and 15:07:15.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`

	// The metric statistics, other than percentile. For percentile statistics,
	// use ExtendedStatistics. When calling GetMetricStatistics, you must specify
	// either Statistics or ExtendedStatistics, but not both.
	Statistics []*string `min:"1" type:"list" enum:"Statistic"`

	// The unit for a given metric. If you omit Unit, all data that was collected
	// with any unit is returned, along with the corresponding units that were specified
	// when the data was reported to CloudWatch. If you specify a unit, the operation
	// returns only data that was collected with that unit specified. If you specify
	// a unit that does not match the data collected, the results of the operation
	// are null. CloudWatch does not perform unit conversions.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

func (GetMetricStatisticsInput) GoString added in v0.6.5 

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

func (s *GetMetricStatisticsInput) SetDimensions(v []*Dimension) *GetMetricStatisticsInput

SetDimensions sets the Dimensions field's value.

func (*GetMetricStatisticsInput) SetEndTime added in v1.5.0 

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

SetEndTime sets the EndTime field's value.

func (*GetMetricStatisticsInput) SetExtendedStatistics added in v1.5.7 

func (s *GetMetricStatisticsInput) SetExtendedStatistics(v []*string) *GetMetricStatisticsInput

SetExtendedStatistics sets the ExtendedStatistics field's value.

func (*GetMetricStatisticsInput) SetMetricName added in v1.5.0 

func (s *GetMetricStatisticsInput) SetMetricName(v string) *GetMetricStatisticsInput

SetMetricName sets the MetricName field's value.

func (*GetMetricStatisticsInput) SetNamespace added in v1.5.0 

func (s *GetMetricStatisticsInput) SetNamespace(v string) *GetMetricStatisticsInput

SetNamespace sets the Namespace field's value.

func (*GetMetricStatisticsInput) SetPeriod added in v1.5.0 

func (s *GetMetricStatisticsInput) SetPeriod(v int64) *GetMetricStatisticsInput

SetPeriod sets the Period field's value.

func (*GetMetricStatisticsInput) SetStartTime added in v1.5.0 

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

SetStartTime sets the StartTime field's value.

func (*GetMetricStatisticsInput) SetStatistics added in v1.5.0 

func (s *GetMetricStatisticsInput) SetStatistics(v []*string) *GetMetricStatisticsInput

SetStatistics sets the Statistics field's value.

func (*GetMetricStatisticsInput) SetUnit added in v1.5.0 

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

SetUnit sets the Unit field's value.

func (GetMetricStatisticsInput) String added in v0.6.5 

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

func (s *GetMetricStatisticsInput) Validate() error

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

type GetMetricStatisticsOutput 

type GetMetricStatisticsOutput struct {

	// The data points for the specified metric.
	Datapoints []*Datapoint `type:"list"`

	// A label for the specified metric.
	Label *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetMetricStatisticsOutput) GoString added in v0.6.5 

func (s GetMetricStatisticsOutput) 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 (*GetMetricStatisticsOutput) SetDatapoints added in v1.5.0 

func (s *GetMetricStatisticsOutput) SetDatapoints(v []*Datapoint) *GetMetricStatisticsOutput

SetDatapoints sets the Datapoints field's value.

func (*GetMetricStatisticsOutput) SetLabel added in v1.5.0 

func (s *GetMetricStatisticsOutput) SetLabel(v string) *GetMetricStatisticsOutput

SetLabel sets the Label field's value.

func (GetMetricStatisticsOutput) String added in v0.6.5 

func (s GetMetricStatisticsOutput) 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 GetMetricStreamInput added in v1.38.9 

type GetMetricStreamInput struct {

	// The name of the metric stream to retrieve information about.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetMetricStreamInput) GoString added in v1.38.9 

func (s GetMetricStreamInput) 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 (*GetMetricStreamInput) SetName added in v1.38.9 

func (s *GetMetricStreamInput) SetName(v string) *GetMetricStreamInput

SetName sets the Name field's value.

func (GetMetricStreamInput) String added in v1.38.9 

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

func (s *GetMetricStreamInput) Validate() error

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

type GetMetricStreamOutput added in v1.38.9 

type GetMetricStreamOutput struct {

	// The ARN of the metric stream.
	Arn *string `min:"1" type:"string"`

	// The date that the metric stream was created.
	CreationDate *time.Time `type:"timestamp"`

	// If this array of metric namespaces is present, then these namespaces are
	// the only metric namespaces that are not streamed by this metric stream. In
	// this case, all other metric namespaces in the account are streamed by this
	// metric stream.
	ExcludeFilters []*MetricStreamFilter `type:"list"`

	// The ARN of the Amazon Kinesis Firehose delivery stream that is used by this
	// metric stream.
	FirehoseArn *string `min:"1" type:"string"`

	// If this array of metric namespaces is present, then these namespaces are
	// the only metric namespaces that are streamed by this metric stream.
	IncludeFilters []*MetricStreamFilter `type:"list"`

	// The date of the most recent update to the metric stream's configuration.
	LastUpdateDate *time.Time `type:"timestamp"`

	// The name of the metric stream.
	Name *string `min:"1" type:"string"`

	// The output format for the stream. Valid values are json and opentelemetry0.7.
	// For more information about metric stream output formats, see Metric streams
	// output formats (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html).
	OutputFormat *string `min:"1" type:"string" enum:"MetricStreamOutputFormat"`

	// The ARN of the IAM role that is used by this metric stream.
	RoleArn *string `min:"1" type:"string"`

	// The state of the metric stream. The possible values are running and stopped.
	State *string `type:"string"`

	// Each entry in this array displays information about one or more metrics that
	// include additional statistics in the metric stream. For more information
	// about the additional statistics, see CloudWatch statistics definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html).
	StatisticsConfigurations []*MetricStreamStatisticsConfiguration `type:"list"`
	// contains filtered or unexported fields
}

func (GetMetricStreamOutput) GoString added in v1.38.9 

func (s GetMetricStreamOutput) 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 (*GetMetricStreamOutput) SetArn added in v1.38.9 

func (s *GetMetricStreamOutput) SetArn(v string) *GetMetricStreamOutput

SetArn sets the Arn field's value.

func (*GetMetricStreamOutput) SetCreationDate added in v1.38.9 

func (s *GetMetricStreamOutput) SetCreationDate(v time.Time) *GetMetricStreamOutput

SetCreationDate sets the CreationDate field's value.

func (*GetMetricStreamOutput) SetExcludeFilters added in v1.38.9 

func (s *GetMetricStreamOutput) SetExcludeFilters(v []*MetricStreamFilter) *GetMetricStreamOutput

SetExcludeFilters sets the ExcludeFilters field's value.

func (*GetMetricStreamOutput) SetFirehoseArn added in v1.38.9 

func (s *GetMetricStreamOutput) SetFirehoseArn(v string) *GetMetricStreamOutput

SetFirehoseArn sets the FirehoseArn field's value.

func (*GetMetricStreamOutput) SetIncludeFilters added in v1.38.9 

func (s *GetMetricStreamOutput) SetIncludeFilters(v []*MetricStreamFilter) *GetMetricStreamOutput

SetIncludeFilters sets the IncludeFilters field's value.

func (*GetMetricStreamOutput) SetLastUpdateDate added in v1.38.9 

func (s *GetMetricStreamOutput) SetLastUpdateDate(v time.Time) *GetMetricStreamOutput

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*GetMetricStreamOutput) SetName added in v1.38.9 

func (s *GetMetricStreamOutput) SetName(v string) *GetMetricStreamOutput

SetName sets the Name field's value.

func (*GetMetricStreamOutput) SetOutputFormat added in v1.38.9 

func (s *GetMetricStreamOutput) SetOutputFormat(v string) *GetMetricStreamOutput

SetOutputFormat sets the OutputFormat field's value.

func (*GetMetricStreamOutput) SetRoleArn added in v1.38.9 

func (s *GetMetricStreamOutput) SetRoleArn(v string) *GetMetricStreamOutput

SetRoleArn sets the RoleArn field's value.

func (*GetMetricStreamOutput) SetState added in v1.38.9 

func (s *GetMetricStreamOutput) SetState(v string) *GetMetricStreamOutput

SetState sets the State field's value.

func (*GetMetricStreamOutput) SetStatisticsConfigurations added in v1.43.39 

func (s *GetMetricStreamOutput) SetStatisticsConfigurations(v []*MetricStreamStatisticsConfiguration) *GetMetricStreamOutput

SetStatisticsConfigurations sets the StatisticsConfigurations field's value.

func (GetMetricStreamOutput) String added in v1.38.9 

func (s GetMetricStreamOutput) 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 GetMetricWidgetImageInput added in v1.15.38 

type GetMetricWidgetImageInput struct {

	// A JSON string that defines the bitmap graph to be retrieved. The string includes
	// the metrics to include in the graph, statistics, annotations, title, axis
	// limits, and so on. You can include only one MetricWidget parameter in each
	// GetMetricWidgetImage call.
	//
	// For more information about the syntax of MetricWidget see GetMetricWidgetImage:
	// Metric Widget Structure and Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html).
	//
	// If any metric on the graph could not load all the requested data points,
	// an orange triangle with an exclamation point appears next to the graph legend.
	//
	// MetricWidget is a required field
	MetricWidget *string `type:"string" required:"true"`

	// The format of the resulting image. Only PNG images are supported.
	//
	// The default is png. If you specify png, the API returns an HTTP response
	// with the content-type set to text/xml. The image data is in a MetricWidgetImage
	// field. For example:
	//
	// <GetMetricWidgetImageResponse xmlns=<URLstring>>
	//
	// <GetMetricWidgetImageResult>
	//
	// <MetricWidgetImage>
	//
	// iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
	//
	// </MetricWidgetImage>
	//
	// </GetMetricWidgetImageResult>
	//
	// <ResponseMetadata>
	//
	// <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
	//
	// </ResponseMetadata>
	//
	// </GetMetricWidgetImageResponse>
	//
	// The image/png setting is intended only for custom HTTP requests. For most
	// use cases, and all actions using an Amazon Web Services SDK, you should use
	// png. If you specify image/png, the HTTP response has a content-type set to
	// image/png, and the body of the response is a PNG image.
	OutputFormat *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetMetricWidgetImageInput) GoString added in v1.15.38 

func (s GetMetricWidgetImageInput) 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 (*GetMetricWidgetImageInput) SetMetricWidget added in v1.15.38 

func (s *GetMetricWidgetImageInput) SetMetricWidget(v string) *GetMetricWidgetImageInput

SetMetricWidget sets the MetricWidget field's value.

func (*GetMetricWidgetImageInput) SetOutputFormat added in v1.15.38 

func (s *GetMetricWidgetImageInput) SetOutputFormat(v string) *GetMetricWidgetImageInput

SetOutputFormat sets the OutputFormat field's value.

func (GetMetricWidgetImageInput) String added in v1.15.38 

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

func (s *GetMetricWidgetImageInput) Validate() error

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

type GetMetricWidgetImageOutput added in v1.15.38 

type GetMetricWidgetImageOutput struct {

	// The image of the graph, in the output format specified. The output is base64-encoded.
	// MetricWidgetImage is automatically base64 encoded/decoded by the SDK.
	MetricWidgetImage []byte `type:"blob"`
	// contains filtered or unexported fields
}

func (GetMetricWidgetImageOutput) GoString added in v1.15.38 

func (s GetMetricWidgetImageOutput) 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 (*GetMetricWidgetImageOutput) SetMetricWidgetImage added in v1.15.38 

func (s *GetMetricWidgetImageOutput) SetMetricWidgetImage(v []byte) *GetMetricWidgetImageOutput

SetMetricWidgetImage sets the MetricWidgetImage field's value.

func (GetMetricWidgetImageOutput) String added in v1.15.38 

func (s GetMetricWidgetImageOutput) 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 InsightRule added in v1.25.42 

type InsightRule struct {

	// The definition of the rule, as a JSON object. The definition contains the
	// keywords used to define contributors, the value to aggregate on if this rule
	// returns a sum instead of a count, and the filters. For details on the valid
	// syntax, see Contributor Insights Rule Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html).
	//
	// Definition is a required field
	Definition *string `min:"1" type:"string" required:"true"`

	// An optional built-in rule that Amazon Web Services manages.
	ManagedRule *bool `type:"boolean"`

	// The name of the rule.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version":
	// 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
	//
	// Schema is a required field
	Schema *string `type:"string" required:"true"`

	// Indicates whether the rule is enabled or disabled.
	//
	// State is a required field
	State *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) in the Amazon CloudWatch User Guide.

func (InsightRule) GoString added in v1.25.42 

func (s InsightRule) 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 (*InsightRule) SetDefinition added in v1.25.42 

func (s *InsightRule) SetDefinition(v string) *InsightRule

SetDefinition sets the Definition field's value.

func (*InsightRule) SetManagedRule added in v1.44.80 

func (s *InsightRule) SetManagedRule(v bool) *InsightRule

SetManagedRule sets the ManagedRule field's value.

func (*InsightRule) SetName added in v1.25.42 

func (s *InsightRule) SetName(v string) *InsightRule

SetName sets the Name field's value.

func (*InsightRule) SetSchema added in v1.25.42 

func (s *InsightRule) SetSchema(v string) *InsightRule

SetSchema sets the Schema field's value.

func (*InsightRule) SetState added in v1.25.42 

func (s *InsightRule) SetState(v string) *InsightRule

SetState sets the State field's value.

func (InsightRule) String added in v1.25.42 

func (s InsightRule) 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 InsightRuleContributor added in v1.25.42 

type InsightRuleContributor struct {

	// An approximation of the aggregate value that comes from this contributor.
	//
	// ApproximateAggregateValue is a required field
	ApproximateAggregateValue *float64 `type:"double" required:"true"`

	// An array of the data points where this contributor is present. Only the data
	// points when this contributor appeared are included in the array.
	//
	// Datapoints is a required field
	Datapoints []*InsightRuleContributorDatapoint `type:"list" required:"true"`

	// One of the log entry field keywords that is used to define contributors for
	// this rule.
	//
	// Keys is a required field
	Keys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).

func (InsightRuleContributor) GoString added in v1.25.42 

func (s InsightRuleContributor) 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 (*InsightRuleContributor) SetApproximateAggregateValue added in v1.25.42 

func (s *InsightRuleContributor) SetApproximateAggregateValue(v float64) *InsightRuleContributor

SetApproximateAggregateValue sets the ApproximateAggregateValue field's value.

func (*InsightRuleContributor) SetDatapoints added in v1.25.42 

func (s *InsightRuleContributor) SetDatapoints(v []*InsightRuleContributorDatapoint) *InsightRuleContributor

SetDatapoints sets the Datapoints field's value.

func (*InsightRuleContributor) SetKeys added in v1.25.42 

func (s *InsightRuleContributor) SetKeys(v []*string) *InsightRuleContributor

SetKeys sets the Keys field's value.

func (InsightRuleContributor) String added in v1.25.42 

func (s InsightRuleContributor) 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 InsightRuleContributorDatapoint added in v1.25.42 

type InsightRuleContributorDatapoint struct {

	// The approximate value that this contributor added during this timestamp.
	//
	// ApproximateValue is a required field
	ApproximateValue *float64 `type:"double" required:"true"`

	// The timestamp of the data point.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

One data point related to one contributor.

For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) and InsightRuleContributor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html).

func (InsightRuleContributorDatapoint) GoString added in v1.25.42 

func (s InsightRuleContributorDatapoint) 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 (*InsightRuleContributorDatapoint) SetApproximateValue added in v1.25.42 

func (s *InsightRuleContributorDatapoint) SetApproximateValue(v float64) *InsightRuleContributorDatapoint

SetApproximateValue sets the ApproximateValue field's value.

func (*InsightRuleContributorDatapoint) SetTimestamp added in v1.25.42 

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

SetTimestamp sets the Timestamp field's value.

func (InsightRuleContributorDatapoint) String added in v1.25.42 

func (s InsightRuleContributorDatapoint) 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 InsightRuleMetricDatapoint added in v1.25.42 

type InsightRuleMetricDatapoint struct {

	// The average value from all contributors during the time period represented
	// by that data point.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	Average *float64 `type:"double"`

	// The maximum value provided by one contributor during this timestamp. Each
	// timestamp is evaluated separately, so the identity of the max contributor
	// could be different for each timestamp.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	MaxContributorValue *float64 `type:"double"`

	// The maximum value from a single occurence from a single contributor during
	// the time period represented by that data point.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	Maximum *float64 `type:"double"`

	// The minimum value from a single contributor during the time period represented
	// by that data point.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	Minimum *float64 `type:"double"`

	// The number of occurrences that matched the rule during this data point.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	SampleCount *float64 `type:"double"`

	// The sum of the values from all contributors during the time period represented
	// by that data point.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	Sum *float64 `type:"double"`

	// The timestamp of the data point.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`

	// The number of unique contributors who published data during this timestamp.
	//
	// This statistic is returned only if you included it in the Metrics array in
	// your request.
	UniqueContributors *float64 `type:"double"`
	// contains filtered or unexported fields
}

One data point from the metric time series returned in a Contributor Insights rule report.

For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).

func (InsightRuleMetricDatapoint) GoString added in v1.25.42 

func (s InsightRuleMetricDatapoint) 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 (*InsightRuleMetricDatapoint) SetAverage added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetAverage(v float64) *InsightRuleMetricDatapoint

SetAverage sets the Average field's value.

func (*InsightRuleMetricDatapoint) SetMaxContributorValue added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetMaxContributorValue(v float64) *InsightRuleMetricDatapoint

SetMaxContributorValue sets the MaxContributorValue field's value.

func (*InsightRuleMetricDatapoint) SetMaximum added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetMaximum(v float64) *InsightRuleMetricDatapoint

SetMaximum sets the Maximum field's value.

func (*InsightRuleMetricDatapoint) SetMinimum added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetMinimum(v float64) *InsightRuleMetricDatapoint

SetMinimum sets the Minimum field's value.

func (*InsightRuleMetricDatapoint) SetSampleCount added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetSampleCount(v float64) *InsightRuleMetricDatapoint

SetSampleCount sets the SampleCount field's value.

func (*InsightRuleMetricDatapoint) SetSum added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetSum(v float64) *InsightRuleMetricDatapoint

SetSum sets the Sum field's value.

func (*InsightRuleMetricDatapoint) SetTimestamp added in v1.25.42 

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

SetTimestamp sets the Timestamp field's value.

func (*InsightRuleMetricDatapoint) SetUniqueContributors added in v1.25.42 

func (s *InsightRuleMetricDatapoint) SetUniqueContributors(v float64) *InsightRuleMetricDatapoint

SetUniqueContributors sets the UniqueContributors field's value.

func (InsightRuleMetricDatapoint) String added in v1.25.42 

func (s InsightRuleMetricDatapoint) 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 LabelOptions added in v1.37.0 

type LabelOptions struct {

	// The time zone to use for metric data return in this operation. The format
	// is + or - followed by four digits. The first two digits indicate the number
	// of hours ahead or behind of UTC, and the final two digits are the number
	// of minutes. For example, +0130 indicates a time zone that is 1 hour and 30
	// minutes ahead of UTC. The default is +0000.
	Timezone *string `type:"string"`
	// contains filtered or unexported fields
}

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels that are associated with returned metrics display the correct time for your time zone.

The Timezone value affects a label only if you have a time-based dynamic expression in the label. For more information about dynamic expressions in labels, see Using Dynamic Labels (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html).

func (LabelOptions) GoString added in v1.37.0 

func (s LabelOptions) 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 (*LabelOptions) SetTimezone added in v1.37.0 

func (s *LabelOptions) SetTimezone(v string) *LabelOptions

SetTimezone sets the Timezone field's value.

func (LabelOptions) String added in v1.37.0 

func (s LabelOptions) 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 ListDashboardsInput added in v1.10.7 

type ListDashboardsInput struct {

	// If you specify this parameter, only the dashboards with names starting with
	// the specified string are listed. The maximum length is 255, and valid characters
	// are A-Z, a-z, 0-9, ".", "-", and "_".
	DashboardNamePrefix *string `type:"string"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDashboardsInput) GoString added in v1.10.7 

func (s ListDashboardsInput) 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 (*ListDashboardsInput) SetDashboardNamePrefix added in v1.10.7 

func (s *ListDashboardsInput) SetDashboardNamePrefix(v string) *ListDashboardsInput

SetDashboardNamePrefix sets the DashboardNamePrefix field's value.

func (*ListDashboardsInput) SetNextToken added in v1.10.7 

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

SetNextToken sets the NextToken field's value.

func (ListDashboardsInput) String added in v1.10.7 

func (s ListDashboardsInput) 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 ListDashboardsOutput added in v1.10.7 

type ListDashboardsOutput struct {

	// The list of matching dashboards.
	DashboardEntries []*DashboardEntry `type:"list"`

	// The token that marks the start of the next batch of returned results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDashboardsOutput) GoString added in v1.10.7 

func (s ListDashboardsOutput) 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 (*ListDashboardsOutput) SetDashboardEntries added in v1.10.7 

func (s *ListDashboardsOutput) SetDashboardEntries(v []*DashboardEntry) *ListDashboardsOutput

SetDashboardEntries sets the DashboardEntries field's value.

func (*ListDashboardsOutput) SetNextToken added in v1.10.7 

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

SetNextToken sets the NextToken field's value.

func (ListDashboardsOutput) String added in v1.10.7 

func (s ListDashboardsOutput) 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 ListManagedInsightRulesInput added in v1.44.80 

type ListManagedInsightRulesInput struct {

	// The maximum number of results to return in one operation. If you omit this
	// parameter, the default number is used. The default number is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// Include this value to get the next set of rules if the value was returned
	// by the previous operation.
	NextToken *string `type:"string"`

	// The ARN of an Amazon Web Services resource that has managed Contributor Insights
	// rules.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListManagedInsightRulesInput) GoString added in v1.44.80 

func (s ListManagedInsightRulesInput) 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 (*ListManagedInsightRulesInput) SetMaxResults added in v1.44.80 

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

SetMaxResults sets the MaxResults field's value.

func (*ListManagedInsightRulesInput) SetNextToken added in v1.44.80 

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

SetNextToken sets the NextToken field's value.

func (*ListManagedInsightRulesInput) SetResourceARN added in v1.44.80 

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

SetResourceARN sets the ResourceARN field's value.

func (ListManagedInsightRulesInput) String added in v1.44.80 

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

func (s *ListManagedInsightRulesInput) Validate() error

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

type ListManagedInsightRulesOutput added in v1.44.80 

type ListManagedInsightRulesOutput struct {

	// The managed rules that are available for the specified Amazon Web Services
	// resource.
	ManagedRules []*ManagedRuleDescription `type:"list"`

	// Include this value to get the next set of rules if the value was returned
	// by the previous operation.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListManagedInsightRulesOutput) GoString added in v1.44.80 

func (s ListManagedInsightRulesOutput) 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 (*ListManagedInsightRulesOutput) SetManagedRules added in v1.44.80 

func (s *ListManagedInsightRulesOutput) SetManagedRules(v []*ManagedRuleDescription) *ListManagedInsightRulesOutput

SetManagedRules sets the ManagedRules field's value.

func (*ListManagedInsightRulesOutput) SetNextToken added in v1.44.80 

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

SetNextToken sets the NextToken field's value.

func (ListManagedInsightRulesOutput) String added in v1.44.80 

func (s ListManagedInsightRulesOutput) 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 ListMetricStreamsInput added in v1.38.9 

type ListMetricStreamsInput struct {

	// The maximum number of results to return in one operation.
	MaxResults *int64 `min:"1" type:"integer"`

	// Include this value, if it was returned by the previous call, to get the next
	// set of metric streams.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListMetricStreamsInput) GoString added in v1.38.9 

func (s ListMetricStreamsInput) 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 (*ListMetricStreamsInput) SetMaxResults added in v1.38.9 

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

SetMaxResults sets the MaxResults field's value.

func (*ListMetricStreamsInput) SetNextToken added in v1.38.9 

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

SetNextToken sets the NextToken field's value.

func (ListMetricStreamsInput) String added in v1.38.9 

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

func (s *ListMetricStreamsInput) Validate() error

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

type ListMetricStreamsOutput added in v1.38.9 

type ListMetricStreamsOutput struct {

	// The array of metric stream information.
	Entries []*MetricStreamEntry `type:"list"`

	// The token that marks the start of the next batch of returned results. You
	// can use this token in a subsequent operation to get the next batch of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListMetricStreamsOutput) GoString added in v1.38.9 

func (s ListMetricStreamsOutput) 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 (*ListMetricStreamsOutput) SetEntries added in v1.38.9 

func (s *ListMetricStreamsOutput) SetEntries(v []*MetricStreamEntry) *ListMetricStreamsOutput

SetEntries sets the Entries field's value.

func (*ListMetricStreamsOutput) SetNextToken added in v1.38.9 

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

SetNextToken sets the NextToken field's value.

func (ListMetricStreamsOutput) String added in v1.38.9 

func (s ListMetricStreamsOutput) 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 ListMetricsInput 

type ListMetricsInput struct {

	// The dimensions to filter against. Only the dimensions that match exactly
	// will be returned.
	Dimensions []*DimensionFilter `type:"list"`

	// The name of the metric to filter against. Only the metrics with names that
	// match exactly will be returned.
	MetricName *string `min:"1" type:"string"`

	// The metric namespace to filter against. Only the namespace that matches exactly
	// will be returned.
	Namespace *string `min:"1" type:"string"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `type:"string"`

	// To filter the results to show only metrics that have had data points published
	// in the past three hours, specify this parameter with a value of PT3H. This
	// is the only valid value for this parameter.
	//
	// The results that are returned are an approximation of the value you specify.
	// There is a low probability that the returned results include metrics with
	// last published data as much as 40 minutes more than the specified time interval.
	RecentlyActive *string `type:"string" enum:"RecentlyActive"`
	// contains filtered or unexported fields
}

func (ListMetricsInput) GoString added in v0.6.5 

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

func (s *ListMetricsInput) SetDimensions(v []*DimensionFilter) *ListMetricsInput

SetDimensions sets the Dimensions field's value.

func (*ListMetricsInput) SetMetricName added in v1.5.0 

func (s *ListMetricsInput) SetMetricName(v string) *ListMetricsInput

SetMetricName sets the MetricName field's value.

func (*ListMetricsInput) SetNamespace added in v1.5.0 

func (s *ListMetricsInput) SetNamespace(v string) *ListMetricsInput

SetNamespace sets the Namespace field's value.

func (*ListMetricsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListMetricsInput) SetRecentlyActive added in v1.33.12 

func (s *ListMetricsInput) SetRecentlyActive(v string) *ListMetricsInput

SetRecentlyActive sets the RecentlyActive field's value.

func (ListMetricsInput) String added in v0.6.5 

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

func (s *ListMetricsInput) Validate() error

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

type ListMetricsOutput 

type ListMetricsOutput struct {

	// The metrics that match your request.
	Metrics []*Metric `type:"list"`

	// The token that marks the start of the next batch of returned results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListMetricsOutput) GoString added in v0.6.5 

func (s ListMetricsOutput) 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 (*ListMetricsOutput) SetMetrics added in v1.5.0 

func (s *ListMetricsOutput) SetMetrics(v []*Metric) *ListMetricsOutput

SetMetrics sets the Metrics field's value.

func (*ListMetricsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (ListMetricsOutput) String added in v0.6.5 

func (s ListMetricsOutput) 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.19.6 

type ListTagsForResourceInput struct {

	// The ARN of the CloudWatch resource that you want to view tags for.
	//
	// The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
	//
	// The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
	//
	// For more information about ARN format, see Resource Types Defined by Amazon
	// CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
	// in the Amazon Web Services General Reference.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.19.6 

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

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

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.19.6 

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

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.19.6 

type ListTagsForResourceOutput struct {

	// The list of tag keys and values associated with the resource you specified.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.19.6 

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

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.19.6 

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

type ManagedRule struct {

	// The ARN of an Amazon Web Services resource that has managed Contributor Insights
	// rules.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// A list of key-value pairs that you can associate with a managed Contributor
	// Insights rule. You can associate as many as 50 tags with a rule. Tags can
	// help you organize and categorize your resources. You also can use them to
	// scope user permissions by granting a user permission to access or change
	// only the resources that have certain tag values. To associate tags with a
	// rule, you must have the cloudwatch:TagResource permission in addition to
	// the cloudwatch:PutInsightRule permission. If you are using this operation
	// to update an existing Contributor Insights rule, any tags that you specify
	// in this parameter are ignored. To change the tags of an existing rule, use
	// TagResource.
	Tags []*Tag `type:"list"`

	// The template name for the managed Contributor Insights rule, as returned
	// by ListManagedInsightRules.
	//
	// TemplateName is a required field
	TemplateName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the information that's required to enable a managed Contributor Insights rule for an Amazon Web Services resource.

func (ManagedRule) GoString added in v1.44.80 

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

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

SetResourceARN sets the ResourceARN field's value.

func (*ManagedRule) SetTags added in v1.44.80 

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

SetTags sets the Tags field's value.

func (*ManagedRule) SetTemplateName added in v1.44.80 

func (s *ManagedRule) SetTemplateName(v string) *ManagedRule

SetTemplateName sets the TemplateName field's value.

func (ManagedRule) String added in v1.44.80 

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

func (s *ManagedRule) Validate() error

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

type ManagedRuleDescription added in v1.44.80 

type ManagedRuleDescription struct {

	// If a managed rule is enabled, this is the ARN for the related Amazon Web
	// Services resource.
	ResourceARN *string `min:"1" type:"string"`

	// Describes the state of a managed rule. If present, it contains information
	// about the Contributor Insights rule that contains information about the related
	// Amazon Web Services resource.
	RuleState *ManagedRuleState `type:"structure"`

	// The template name for the managed rule. Used to enable managed rules using
	// PutManagedInsightRules.
	TemplateName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about managed Contributor Insights rules, as returned by ListManagedInsightRules.

func (ManagedRuleDescription) GoString added in v1.44.80 

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

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

SetResourceARN sets the ResourceARN field's value.

func (*ManagedRuleDescription) SetRuleState added in v1.44.80 

func (s *ManagedRuleDescription) SetRuleState(v *ManagedRuleState) *ManagedRuleDescription

SetRuleState sets the RuleState field's value.

func (*ManagedRuleDescription) SetTemplateName added in v1.44.80 

func (s *ManagedRuleDescription) SetTemplateName(v string) *ManagedRuleDescription

SetTemplateName sets the TemplateName field's value.

func (ManagedRuleDescription) String added in v1.44.80 

func (s ManagedRuleDescription) 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 ManagedRuleState added in v1.44.80 

type ManagedRuleState struct {

	// The name of the Contributor Insights rule that contains data for the specified
	// Amazon Web Services resource.
	//
	// RuleName is a required field
	RuleName *string `min:"1" type:"string" required:"true"`

	// Indicates whether the rule is enabled or disabled.
	//
	// State is a required field
	State *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The status of a managed Contributor Insights rule.

func (ManagedRuleState) GoString added in v1.44.80 

func (s ManagedRuleState) 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 (*ManagedRuleState) SetRuleName added in v1.44.80 

func (s *ManagedRuleState) SetRuleName(v string) *ManagedRuleState

SetRuleName sets the RuleName field's value.

func (*ManagedRuleState) SetState added in v1.44.80 

func (s *ManagedRuleState) SetState(v string) *ManagedRuleState

SetState sets the State field's value.

func (ManagedRuleState) String added in v1.44.80 

func (s ManagedRuleState) 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 MessageData added in v1.13.28 

type MessageData struct {

	// The error code or status code associated with the message.
	Code *string `type:"string"`

	// The message text.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A message returned by the GetMetricDataAPI, including a code and a description.

If a cross-Region GetMetricData operation fails with a code of Forbidden and a value of Authentication too complex to retrieve cross region data, you can correct the problem by running the GetMetricData operation in the same Region where the metric data is.

func (MessageData) GoString added in v1.13.28 

func (s MessageData) 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 (*MessageData) SetCode added in v1.13.28 

func (s *MessageData) SetCode(v string) *MessageData

SetCode sets the Code field's value.

func (*MessageData) SetValue added in v1.13.28 

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

SetValue sets the Value field's value.

func (MessageData) String added in v1.13.28 

func (s MessageData) 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 Metric 

type Metric struct {

	// The dimensions for the metric.
	Dimensions []*Dimension `type:"list"`

	// The name of the metric. This is a required field.
	MetricName *string `min:"1" type:"string"`

	// The namespace of the metric.
	Namespace *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a specific metric.

func (Metric) GoString added in v0.6.5 

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

func (s *Metric) SetDimensions(v []*Dimension) *Metric

SetDimensions sets the Dimensions field's value.

func (*Metric) SetMetricName added in v1.5.0 

func (s *Metric) SetMetricName(v string) *Metric

SetMetricName sets the MetricName field's value.

func (*Metric) SetNamespace added in v1.5.0 

func (s *Metric) SetNamespace(v string) *Metric

SetNamespace sets the Namespace field's value.

func (Metric) String added in v0.6.5 

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

func (s *Metric) Validate() error

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

type MetricAlarm 

type MetricAlarm struct {

	// Indicates whether actions should be executed during any changes to the alarm
	// state.
	ActionsEnabled *bool `type:"boolean"`

	// The actions to execute when this alarm transitions to the ALARM state from
	// any other state. Each action is specified as an Amazon Resource Name (ARN).
	AlarmActions []*string `type:"list"`

	// The Amazon Resource Name (ARN) of the alarm.
	AlarmArn *string `min:"1" type:"string"`

	// The time stamp of the last update to the alarm configuration.
	AlarmConfigurationUpdatedTimestamp *time.Time `type:"timestamp"`

	// The description of the alarm.
	AlarmDescription *string `type:"string"`

	// The name of the alarm.
	AlarmName *string `min:"1" type:"string"`

	// The arithmetic operation to use when comparing the specified statistic and
	// threshold. The specified statistic value is used as the first operand.
	ComparisonOperator *string `type:"string" enum:"ComparisonOperator"`

	// The number of data points that must be breaching to trigger the alarm.
	DatapointsToAlarm *int64 `min:"1" type:"integer"`

	// The dimensions for the metric associated with the alarm.
	Dimensions []*Dimension `type:"list"`

	// Used only for alarms based on percentiles. If ignore, the alarm state does
	// not change during periods with too few data points to be statistically significant.
	// If evaluate or this parameter is not used, the alarm is always evaluated
	// and possibly changes state no matter how many data points are available.
	EvaluateLowSampleCountPercentile *string `min:"1" type:"string"`

	// The number of periods over which data is compared to the specified threshold.
	EvaluationPeriods *int64 `min:"1" type:"integer"`

	// The percentile statistic for the metric associated with the alarm. Specify
	// a value between p0.0 and p100.
	ExtendedStatistic *string `type:"string"`

	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
	// state from any other state. Each action is specified as an Amazon Resource
	// Name (ARN).
	InsufficientDataActions []*string `type:"list"`

	// The name of the metric associated with the alarm, if this is an alarm based
	// on a single metric.
	MetricName *string `min:"1" type:"string"`

	// An array of MetricDataQuery structures, used in an alarm based on a metric
	// math expression. Each structure either retrieves a metric or performs a math
	// expression. One item in the Metrics array is the math expression that the
	// alarm watches. This expression by designated by having ReturnData set to
	// true.
	Metrics []*MetricDataQuery `type:"list"`

	// The namespace of the metric associated with the alarm.
	Namespace *string `min:"1" type:"string"`

	// The actions to execute when this alarm transitions to the OK state from any
	// other state. Each action is specified as an Amazon Resource Name (ARN).
	OKActions []*string `type:"list"`

	// The period, in seconds, over which the statistic is applied.
	Period *int64 `min:"1" type:"integer"`

	// An explanation for the alarm state, in text format.
	StateReason *string `type:"string"`

	// An explanation for the alarm state, in JSON format.
	StateReasonData *string `type:"string"`

	// The time stamp of the last update to the alarm state.
	StateUpdatedTimestamp *time.Time `type:"timestamp"`

	// The state value for the alarm.
	StateValue *string `type:"string" enum:"StateValue"`

	// The statistic for the metric associated with the alarm, other than percentile.
	// For percentile statistics, use ExtendedStatistic.
	Statistic *string `type:"string" enum:"Statistic"`

	// The value to compare with the specified statistic.
	Threshold *float64 `type:"double"`

	// In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
	// function used as the threshold for the alarm.
	ThresholdMetricId *string `min:"1" type:"string"`

	// Sets how this alarm is to handle missing data points. The valid values are
	// breaching, notBreaching, ignore, and missing. For more information, see Configuring
	// how CloudWatch alarms treat missing data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).
	//
	// If this parameter is omitted, the default behavior of missing is used.
	TreatMissingData *string `min:"1" type:"string"`

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

The details about a metric alarm.

func (MetricAlarm) GoString added in v0.6.5 

func (s MetricAlarm) 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 (*MetricAlarm) SetActionsEnabled added in v1.5.0 

func (s *MetricAlarm) SetActionsEnabled(v bool) *MetricAlarm

SetActionsEnabled sets the ActionsEnabled field's value.

func (*MetricAlarm) SetAlarmActions added in v1.5.0 

func (s *MetricAlarm) SetAlarmActions(v []*string) *MetricAlarm

SetAlarmActions sets the AlarmActions field's value.

func (*MetricAlarm) SetAlarmArn added in v1.5.0 

func (s *MetricAlarm) SetAlarmArn(v string) *MetricAlarm

SetAlarmArn sets the AlarmArn field's value.

func (*MetricAlarm) SetAlarmConfigurationUpdatedTimestamp added in v1.5.0 

func (s *MetricAlarm) SetAlarmConfigurationUpdatedTimestamp(v time.Time) *MetricAlarm

SetAlarmConfigurationUpdatedTimestamp sets the AlarmConfigurationUpdatedTimestamp field's value.

func (*MetricAlarm) SetAlarmDescription added in v1.5.0 

func (s *MetricAlarm) SetAlarmDescription(v string) *MetricAlarm

SetAlarmDescription sets the AlarmDescription field's value.

func (*MetricAlarm) SetAlarmName added in v1.5.0 

func (s *MetricAlarm) SetAlarmName(v string) *MetricAlarm

SetAlarmName sets the AlarmName field's value.

func (*MetricAlarm) SetComparisonOperator added in v1.5.0 

func (s *MetricAlarm) SetComparisonOperator(v string) *MetricAlarm

SetComparisonOperator sets the ComparisonOperator field's value.

func (*MetricAlarm) SetDatapointsToAlarm added in v1.12.44 

func (s *MetricAlarm) SetDatapointsToAlarm(v int64) *MetricAlarm

SetDatapointsToAlarm sets the DatapointsToAlarm field's value.

func (*MetricAlarm) SetDimensions added in v1.5.0 

func (s *MetricAlarm) SetDimensions(v []*Dimension) *MetricAlarm

SetDimensions sets the Dimensions field's value.

func (*MetricAlarm) SetEvaluateLowSampleCountPercentile added in v1.8.8 

func (s *MetricAlarm) SetEvaluateLowSampleCountPercentile(v string) *MetricAlarm

SetEvaluateLowSampleCountPercentile sets the EvaluateLowSampleCountPercentile field's value.

func (*MetricAlarm) SetEvaluationPeriods added in v1.5.0 

func (s *MetricAlarm) SetEvaluationPeriods(v int64) *MetricAlarm

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*MetricAlarm) SetExtendedStatistic added in v1.5.7 

func (s *MetricAlarm) SetExtendedStatistic(v string) *MetricAlarm

SetExtendedStatistic sets the ExtendedStatistic field's value.

func (*MetricAlarm) SetInsufficientDataActions added in v1.5.0 

func (s *MetricAlarm) SetInsufficientDataActions(v []*string) *MetricAlarm

SetInsufficientDataActions sets the InsufficientDataActions field's value.

func (*MetricAlarm) SetMetricName added in v1.5.0 

func (s *MetricAlarm) SetMetricName(v string) *MetricAlarm

SetMetricName sets the MetricName field's value.

func (*MetricAlarm) SetMetrics added in v1.15.80 

func (s *MetricAlarm) SetMetrics(v []*MetricDataQuery) *MetricAlarm

SetMetrics sets the Metrics field's value.

func (*MetricAlarm) SetNamespace added in v1.5.0 

func (s *MetricAlarm) SetNamespace(v string) *MetricAlarm

SetNamespace sets the Namespace field's value.

func (*MetricAlarm) SetOKActions added in v1.5.0 

func (s *MetricAlarm) SetOKActions(v []*string) *MetricAlarm

SetOKActions sets the OKActions field's value.

func (*MetricAlarm) SetPeriod added in v1.5.0 

func (s *MetricAlarm) SetPeriod(v int64) *MetricAlarm

SetPeriod sets the Period field's value.

func (*MetricAlarm) SetStateReason added in v1.5.0 

func (s *MetricAlarm) SetStateReason(v string) *MetricAlarm

SetStateReason sets the StateReason field's value.

func (*MetricAlarm) SetStateReasonData added in v1.5.0 

func (s *MetricAlarm) SetStateReasonData(v string) *MetricAlarm

SetStateReasonData sets the StateReasonData field's value.

func (*MetricAlarm) SetStateUpdatedTimestamp added in v1.5.0 

func (s *MetricAlarm) SetStateUpdatedTimestamp(v time.Time) *MetricAlarm

SetStateUpdatedTimestamp sets the StateUpdatedTimestamp field's value.

func (*MetricAlarm) SetStateValue added in v1.5.0 

func (s *MetricAlarm) SetStateValue(v string) *MetricAlarm

SetStateValue sets the StateValue field's value.

func (*MetricAlarm) SetStatistic added in v1.5.0 

func (s *MetricAlarm) SetStatistic(v string) *MetricAlarm

SetStatistic sets the Statistic field's value.

func (*MetricAlarm) SetThreshold added in v1.5.0 

func (s *MetricAlarm) SetThreshold(v float64) *MetricAlarm

SetThreshold sets the Threshold field's value.

func (*MetricAlarm) SetThresholdMetricId added in v1.20.17 

func (s *MetricAlarm) SetThresholdMetricId(v string) *MetricAlarm

SetThresholdMetricId sets the ThresholdMetricId field's value.

func (*MetricAlarm) SetTreatMissingData added in v1.8.8 

func (s *MetricAlarm) SetTreatMissingData(v string) *MetricAlarm

SetTreatMissingData sets the TreatMissingData field's value.

func (*MetricAlarm) SetUnit added in v1.5.0 

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

SetUnit sets the Unit field's value.

func (MetricAlarm) String added in v0.6.5 

func (s MetricAlarm) 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 MetricDataQuery added in v1.13.28 

type MetricDataQuery struct {

	// The ID of the account where the metrics are located, if this is a cross-account
	// alarm.
	//
	// Use this field only for PutMetricAlarm operations. It is not used in GetMetricData
	// operations.
	AccountId *string `min:"1" type:"string"`

	// This field can contain either a Metrics Insights query, or a metric math
	// expression to be performed on the returned data. For more information about
	// Metrics Insights queries, see Metrics Insights query components and syntax
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage)
	// in the Amazon CloudWatch User Guide.
	//
	// A math expression can use the Id of the other metrics or queries to refer
	// to those metrics, and can also use the Id of other expressions to use the
	// result of those expressions. For more information about metric math expressions,
	// see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)
	// in the Amazon CloudWatch User Guide.
	//
	// Within each MetricDataQuery object, you must specify either Expression or
	// MetricStat but not both.
	Expression *string `min:"1" type:"string"`

	// A short name used to tie this object to the results in the response. This
	// name must be unique within a single call to GetMetricData. If you are performing
	// math expressions on this set of data, this name represents that data and
	// can serve as a variable in the mathematical expression. The valid characters
	// are letters, numbers, and underscore. The first character must be a lowercase
	// letter.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// A human-readable label for this metric or expression. This is especially
	// useful if this is an expression, so that you know what the value represents.
	// If the metric or expression is shown in a CloudWatch dashboard widget, the
	// label is shown. If Label is omitted, CloudWatch generates a default.
	//
	// You can put dynamic expressions into a label, so that it is more descriptive.
	// For more information, see Using Dynamic Labels (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html).
	Label *string `type:"string"`

	// The metric to be returned, along with statistics, period, and units. Use
	// this parameter only if this object is retrieving a metric and not performing
	// a math expression on returned data.
	//
	// Within one MetricDataQuery object, you must specify either Expression or
	// MetricStat but not both.
	MetricStat *MetricStat `type:"structure"`

	// The granularity, in seconds, of the returned data points. For metrics with
	// regular resolution, a period can be as short as one minute (60 seconds) and
	// must be a multiple of 60. For high-resolution metrics that are collected
	// at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
	// or any multiple of 60. High-resolution metrics are those metrics stored by
	// a PutMetricData operation that includes a StorageResolution of 1 second.
	Period *int64 `min:"1" type:"integer"`

	// When used in GetMetricData, this option indicates whether to return the timestamps
	// and raw data values of this metric. If you are performing this call just
	// to do math expressions and do not also need the raw data returned, you can
	// specify False. If you omit this, the default of True is used.
	//
	// When used in PutMetricAlarm, specify True for the one expression result to
	// use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
	// operation, specify ReturnData as False.
	ReturnData *bool `type:"boolean"`
	// contains filtered or unexported fields
}

This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures.

When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

func (MetricDataQuery) GoString added in v1.13.28 

func (s MetricDataQuery) 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 (*MetricDataQuery) SetAccountId added in v1.40.8 

func (s *MetricDataQuery) SetAccountId(v string) *MetricDataQuery

SetAccountId sets the AccountId field's value.

func (*MetricDataQuery) SetExpression added in v1.13.28 

func (s *MetricDataQuery) SetExpression(v string) *MetricDataQuery

SetExpression sets the Expression field's value.

func (*MetricDataQuery) SetId added in v1.13.28 

func (s *MetricDataQuery) SetId(v string) *MetricDataQuery

SetId sets the Id field's value.

func (*MetricDataQuery) SetLabel added in v1.13.28 

func (s *MetricDataQuery) SetLabel(v string) *MetricDataQuery

SetLabel sets the Label field's value.

func (*MetricDataQuery) SetMetricStat added in v1.13.28 

func (s *MetricDataQuery) SetMetricStat(v *MetricStat) *MetricDataQuery

SetMetricStat sets the MetricStat field's value.

func (*MetricDataQuery) SetPeriod added in v1.25.16 

func (s *MetricDataQuery) SetPeriod(v int64) *MetricDataQuery

SetPeriod sets the Period field's value.

func (*MetricDataQuery) SetReturnData added in v1.13.28 

func (s *MetricDataQuery) SetReturnData(v bool) *MetricDataQuery

SetReturnData sets the ReturnData field's value.

func (MetricDataQuery) String added in v1.13.28 

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

func (s *MetricDataQuery) Validate() error

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

type MetricDataResult added in v1.13.28 

type MetricDataResult struct {

	// The short name you specified to represent this metric.
	Id *string `min:"1" type:"string"`

	// The human-readable label associated with the data.
	Label *string `type:"string"`

	// A list of messages with additional information about the data returned.
	Messages []*MessageData `type:"list"`

	// The status of the returned data. Complete indicates that all data points
	// in the requested time range were returned. PartialData means that an incomplete
	// set of data points were returned. You can use the NextToken value that was
	// returned and repeat your request to get more data points. NextToken is not
	// returned if you are performing a math expression. InternalError indicates
	// that an error occurred. Retry your request using NextToken, if present.
	StatusCode *string `type:"string" enum:"StatusCode"`

	// The timestamps for the data points, formatted in Unix timestamp format. The
	// number of timestamps always matches the number of values and the value for
	// Timestamps[x] is Values[x].
	Timestamps []*time.Time `type:"list"`

	// The data points for the metric corresponding to Timestamps. The number of
	// values always matches the number of timestamps and the timestamp for Values[x]
	// is Timestamps[x].
	Values []*float64 `type:"list"`
	// contains filtered or unexported fields
}

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

func (MetricDataResult) GoString added in v1.13.28 

func (s MetricDataResult) 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 (*MetricDataResult) SetId added in v1.13.28 

func (s *MetricDataResult) SetId(v string) *MetricDataResult

SetId sets the Id field's value.

func (*MetricDataResult) SetLabel added in v1.13.28 

func (s *MetricDataResult) SetLabel(v string) *MetricDataResult

SetLabel sets the Label field's value.

func (*MetricDataResult) SetMessages added in v1.13.28 

func (s *MetricDataResult) SetMessages(v []*MessageData) *MetricDataResult

SetMessages sets the Messages field's value.

func (*MetricDataResult) SetStatusCode added in v1.13.28 

func (s *MetricDataResult) SetStatusCode(v string) *MetricDataResult

SetStatusCode sets the StatusCode field's value.

func (*MetricDataResult) SetTimestamps added in v1.13.28 

func (s *MetricDataResult) SetTimestamps(v []*time.Time) *MetricDataResult

SetTimestamps sets the Timestamps field's value.

func (*MetricDataResult) SetValues added in v1.13.28 

func (s *MetricDataResult) SetValues(v []*float64) *MetricDataResult

SetValues sets the Values field's value.

func (MetricDataResult) String added in v1.13.28 

func (s MetricDataResult) 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 MetricDatum 

type MetricDatum struct {

	// Array of numbers that is used along with the Values array. Each number in
	// the Count array is the number of times the corresponding value in the Values
	// array occurred during the period.
	//
	// If you omit the Counts array, the default of 1 is used as the value for each
	// count. If you include a Counts array, it must include the same amount of
	// values as the Values array.
	Counts []*float64 `type:"list"`

	// The dimensions associated with the metric.
	Dimensions []*Dimension `type:"list"`

	// The name of the metric.
	//
	// MetricName is a required field
	MetricName *string `min:"1" type:"string" required:"true"`

	// The statistical values for the metric.
	StatisticValues *StatisticSet `type:"structure"`

	// Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution
	// metric, so that CloudWatch stores the metric with sub-minute resolution down
	// to one second. Setting this to 60 specifies this metric as a regular-resolution
	// metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution
	// is available only for custom metrics. For more information about high-resolution
	// metrics, see High-Resolution Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics)
	// in the Amazon CloudWatch User Guide.
	//
	// This field is optional, if you do not specify it the default of 60 is used.
	StorageResolution *int64 `min:"1" type:"integer"`

	// The time the metric data was received, expressed as the number of milliseconds
	// since Jan 1, 1970 00:00:00 UTC.
	Timestamp *time.Time `type:"timestamp"`

	// When you are using a Put operation, this defines what unit you want to use
	// when storing the metric.
	//
	// In a Get operation, this displays the unit that is used for the metric.
	Unit *string `type:"string" enum:"StandardUnit"`

	// The value for the metric.
	//
	// Although the parameter accepts numbers of type Double, CloudWatch rejects
	// values that are either too small or too large. Values must be in the range
	// of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
	// -Infinity) are not supported.
	Value *float64 `type:"double"`

	// Array of numbers representing the values for the metric during the period.
	// Each unique value is listed just once in this array, and the corresponding
	// number in the Counts array specifies the number of times that value occurred
	// during the period. You can include up to 150 unique values in each PutMetricData
	// action that specifies a Values array.
	//
	// Although the Values array accepts numbers of type Double, CloudWatch rejects
	// values that are either too small or too large. Values must be in the range
	// of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
	// -Infinity) are not supported.
	Values []*float64 `type:"list"`
	// contains filtered or unexported fields
}

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

func (MetricDatum) GoString added in v0.6.5 

func (s MetricDatum) 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 (*MetricDatum) SetCounts added in v1.15.36 

func (s *MetricDatum) SetCounts(v []*float64) *MetricDatum

SetCounts sets the Counts field's value.

func (*MetricDatum) SetDimensions added in v1.5.0 

func (s *MetricDatum) SetDimensions(v []*Dimension) *MetricDatum

SetDimensions sets the Dimensions field's value.

func (*MetricDatum) SetMetricName added in v1.5.0 

func (s *MetricDatum) SetMetricName(v string) *MetricDatum

SetMetricName sets the MetricName field's value.

func (*MetricDatum) SetStatisticValues added in v1.5.0 

func (s *MetricDatum) SetStatisticValues(v *StatisticSet) *MetricDatum

SetStatisticValues sets the StatisticValues field's value.

func (*MetricDatum) SetStorageResolution added in v1.10.7 

func (s *MetricDatum) SetStorageResolution(v int64) *MetricDatum

SetStorageResolution sets the StorageResolution field's value.

func (*MetricDatum) SetTimestamp added in v1.5.0 

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

SetTimestamp sets the Timestamp field's value.

func (*MetricDatum) SetUnit added in v1.5.0 

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

SetUnit sets the Unit field's value.

func (*MetricDatum) SetValue added in v1.5.0 

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

SetValue sets the Value field's value.

func (*MetricDatum) SetValues added in v1.15.36 

func (s *MetricDatum) SetValues(v []*float64) *MetricDatum

SetValues sets the Values field's value.

func (MetricDatum) String added in v0.6.5 

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

func (s *MetricDatum) Validate() error

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

type MetricMathAnomalyDetector added in v1.42.8 

type MetricMathAnomalyDetector struct {

	// An array of metric data query structures that enables you to create an anomaly
	// detector based on the result of a metric math expression. Each item in MetricDataQueries
	// gets a metric or performs a math expression. One item in MetricDataQueries
	// is the expression that provides the time series that the anomaly detector
	// uses as input. Designate the expression by setting ReturnData to True for
	// this object in the array. For all other expressions and metrics, set ReturnData
	// to False. The designated expression must return a single time series.
	MetricDataQueries []*MetricDataQuery `type:"list"`
	// contains filtered or unexported fields
}

Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.

func (MetricMathAnomalyDetector) GoString added in v1.42.8 

func (s MetricMathAnomalyDetector) 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 (*MetricMathAnomalyDetector) SetMetricDataQueries added in v1.42.8 

func (s *MetricMathAnomalyDetector) SetMetricDataQueries(v []*MetricDataQuery) *MetricMathAnomalyDetector

SetMetricDataQueries sets the MetricDataQueries field's value.

func (MetricMathAnomalyDetector) String added in v1.42.8 

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

func (s *MetricMathAnomalyDetector) Validate() error

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

type MetricStat added in v1.13.28 

type MetricStat struct {

	// The metric to return, including the metric name, namespace, and dimensions.
	//
	// Metric is a required field
	Metric *Metric `type:"structure" required:"true"`

	// The granularity, in seconds, of the returned data points. For metrics with
	// regular resolution, a period can be as short as one minute (60 seconds) and
	// must be a multiple of 60. For high-resolution metrics that are collected
	// at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
	// or any multiple of 60. High-resolution metrics are those metrics stored by
	// a PutMetricData call that includes a StorageResolution of 1 second.
	//
	// If the StartTime parameter specifies a time stamp that is greater than 3
	// hours ago, you must specify the period as follows or no data points in that
	// time range is returned:
	//
	//    * Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
	//    (1 minute).
	//
	//    * Start time between 15 and 63 days ago - Use a multiple of 300 seconds
	//    (5 minutes).
	//
	//    * Start time greater than 63 days ago - Use a multiple of 3600 seconds
	//    (1 hour).
	//
	// Period is a required field
	Period *int64 `min:"1" type:"integer" required:"true"`

	// The statistic to return. It can include any CloudWatch statistic or extended
	// statistic.
	//
	// Stat is a required field
	Stat *string `type:"string" required:"true"`

	// When you are using a Put operation, this defines what unit you want to use
	// when storing the metric.
	//
	// In a Get operation, if you omit Unit then all data that was collected with
	// any unit is returned, along with the corresponding units that were specified
	// when the data was reported to CloudWatch. If you specify a unit, the operation
	// returns only data that was collected with that unit specified. If you specify
	// a unit that does not match the data collected, the results of the operation
	// are null. CloudWatch does not perform unit conversions.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

This structure defines the metric to be returned, along with the statistics, period, and units.

func (MetricStat) GoString added in v1.13.28 

func (s MetricStat) 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 (*MetricStat) SetMetric added in v1.13.28 

func (s *MetricStat) SetMetric(v *Metric) *MetricStat

SetMetric sets the Metric field's value.

func (*MetricStat) SetPeriod added in v1.13.28 

func (s *MetricStat) SetPeriod(v int64) *MetricStat

SetPeriod sets the Period field's value.

func (*MetricStat) SetStat added in v1.13.28 

func (s *MetricStat) SetStat(v string) *MetricStat

SetStat sets the Stat field's value.

func (*MetricStat) SetUnit added in v1.13.28 

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

SetUnit sets the Unit field's value.

func (MetricStat) String added in v1.13.28 

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

func (s *MetricStat) Validate() error

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

type MetricStreamEntry added in v1.38.9 

type MetricStreamEntry struct {

	// The ARN of the metric stream.
	Arn *string `min:"1" type:"string"`

	// The date that the metric stream was originally created.
	CreationDate *time.Time `type:"timestamp"`

	// The ARN of the Kinesis Firehose devlivery stream that is used for this metric
	// stream.
	FirehoseArn *string `min:"1" type:"string"`

	// The date that the configuration of this metric stream was most recently updated.
	LastUpdateDate *time.Time `type:"timestamp"`

	// The name of the metric stream.
	Name *string `min:"1" type:"string"`

	// The output format of this metric stream. Valid values are json and opentelemetry0.7.
	OutputFormat *string `min:"1" type:"string" enum:"MetricStreamOutputFormat"`

	// The current state of this stream. Valid values are running and stopped.
	State *string `type:"string"`
	// contains filtered or unexported fields
}

This structure contains the configuration information about one metric stream.

func (MetricStreamEntry) GoString added in v1.38.9 

func (s MetricStreamEntry) 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 (*MetricStreamEntry) SetArn added in v1.38.9 

func (s *MetricStreamEntry) SetArn(v string) *MetricStreamEntry

SetArn sets the Arn field's value.

func (*MetricStreamEntry) SetCreationDate added in v1.38.9 

func (s *MetricStreamEntry) SetCreationDate(v time.Time) *MetricStreamEntry

SetCreationDate sets the CreationDate field's value.

func (*MetricStreamEntry) SetFirehoseArn added in v1.38.9 

func (s *MetricStreamEntry) SetFirehoseArn(v string) *MetricStreamEntry

SetFirehoseArn sets the FirehoseArn field's value.

func (*MetricStreamEntry) SetLastUpdateDate added in v1.38.9 

func (s *MetricStreamEntry) SetLastUpdateDate(v time.Time) *MetricStreamEntry

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*MetricStreamEntry) SetName added in v1.38.9 

func (s *MetricStreamEntry) SetName(v string) *MetricStreamEntry

SetName sets the Name field's value.

func (*MetricStreamEntry) SetOutputFormat added in v1.38.9 

func (s *MetricStreamEntry) SetOutputFormat(v string) *MetricStreamEntry

SetOutputFormat sets the OutputFormat field's value.

func (*MetricStreamEntry) SetState added in v1.38.9 

func (s *MetricStreamEntry) SetState(v string) *MetricStreamEntry

SetState sets the State field's value.

func (MetricStreamEntry) String added in v1.38.9 

func (s MetricStreamEntry) 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 MetricStreamFilter added in v1.38.9 

type MetricStreamFilter struct {

	// The name of the metric namespace in the filter.
	Namespace *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This structure contains the name of one of the metric namespaces that is listed in a filter of a metric stream.

func (MetricStreamFilter) GoString added in v1.38.9 

func (s MetricStreamFilter) 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 (*MetricStreamFilter) SetNamespace added in v1.38.9 

func (s *MetricStreamFilter) SetNamespace(v string) *MetricStreamFilter

SetNamespace sets the Namespace field's value.

func (MetricStreamFilter) String added in v1.38.9 

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

func (s *MetricStreamFilter) Validate() error

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

type MetricStreamStatisticsConfiguration added in v1.43.39 

type MetricStreamStatisticsConfiguration struct {

	// The list of additional statistics that are to be streamed for the metrics
	// listed in the IncludeMetrics array in this structure. This list can include
	// as many as 20 statistics.
	//
	// If the OutputFormat for the stream is opentelemetry0.7, the only valid values
	// are p?? percentile statistics such as p90, p99 and so on.
	//
	// If the OutputFormat for the stream is json, the valid values include the
	// abbreviations for all of the statistics listed in CloudWatch statistics definitions
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html).
	// For example, this includes tm98, wm90, PR(:300), and so on.
	//
	// AdditionalStatistics is a required field
	AdditionalStatistics []*string `type:"list" required:"true"`

	// An array of metric name and namespace pairs that stream the additional statistics
	// listed in the value of the AdditionalStatistics parameter. There can be as
	// many as 100 pairs in the array.
	//
	// All metrics that match the combination of metric name and namespace will
	// be streamed with the additional statistics, no matter their dimensions.
	//
	// IncludeMetrics is a required field
	IncludeMetrics []*MetricStreamStatisticsMetric `type:"list" required:"true"`
	// contains filtered or unexported fields
}

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. This structure contains information for one metric that includes additional statistics in the stream. For more information about statistics, see CloudWatch, listed in CloudWatch statistics definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html).

func (MetricStreamStatisticsConfiguration) GoString added in v1.43.39 

func (s MetricStreamStatisticsConfiguration) 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 (*MetricStreamStatisticsConfiguration) SetAdditionalStatistics added in v1.43.39 

func (s *MetricStreamStatisticsConfiguration) SetAdditionalStatistics(v []*string) *MetricStreamStatisticsConfiguration

SetAdditionalStatistics sets the AdditionalStatistics field's value.

func (*MetricStreamStatisticsConfiguration) SetIncludeMetrics added in v1.43.39 

func (s *MetricStreamStatisticsConfiguration) SetIncludeMetrics(v []*MetricStreamStatisticsMetric) *MetricStreamStatisticsConfiguration

SetIncludeMetrics sets the IncludeMetrics field's value.

func (MetricStreamStatisticsConfiguration) String added in v1.43.39 

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

func (s *MetricStreamStatisticsConfiguration) Validate() error

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

type MetricStreamStatisticsMetric added in v1.43.39 

type MetricStreamStatisticsMetric struct {

	// The name of the metric.
	//
	// MetricName is a required field
	MetricName *string `min:"1" type:"string" required:"true"`

	// The namespace of the metric.
	//
	// Namespace is a required field
	Namespace *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This object contains the information for one metric that is to be streamed with additional statistics.

func (MetricStreamStatisticsMetric) GoString added in v1.43.39 

func (s MetricStreamStatisticsMetric) 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 (*MetricStreamStatisticsMetric) SetMetricName added in v1.43.39 

func (s *MetricStreamStatisticsMetric) SetMetricName(v string) *MetricStreamStatisticsMetric

SetMetricName sets the MetricName field's value.

func (*MetricStreamStatisticsMetric) SetNamespace added in v1.43.39 

func (s *MetricStreamStatisticsMetric) SetNamespace(v string) *MetricStreamStatisticsMetric

SetNamespace sets the Namespace field's value.

func (MetricStreamStatisticsMetric) String added in v1.43.39 

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

func (s *MetricStreamStatisticsMetric) Validate() error

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

type PartialFailure added in v1.25.42 

type PartialFailure struct {

	// The type of error.
	ExceptionType *string `type:"string"`

	// The code of the error.
	FailureCode *string `type:"string"`

	// A description of the error.
	FailureDescription *string `type:"string"`

	// The specified rule that could not be deleted.
	FailureResource *string `type:"string"`
	// contains filtered or unexported fields
}

This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.

func (PartialFailure) GoString added in v1.25.42 

func (s PartialFailure) 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 (*PartialFailure) SetExceptionType added in v1.25.42 

func (s *PartialFailure) SetExceptionType(v string) *PartialFailure

SetExceptionType sets the ExceptionType field's value.

func (*PartialFailure) SetFailureCode added in v1.25.42 

func (s *PartialFailure) SetFailureCode(v string) *PartialFailure

SetFailureCode sets the FailureCode field's value.

func (*PartialFailure) SetFailureDescription added in v1.25.42 

func (s *PartialFailure) SetFailureDescription(v string) *PartialFailure

SetFailureDescription sets the FailureDescription field's value.

func (*PartialFailure) SetFailureResource added in v1.25.42 

func (s *PartialFailure) SetFailureResource(v string) *PartialFailure

SetFailureResource sets the FailureResource field's value.

func (PartialFailure) String added in v1.25.42 

func (s PartialFailure) 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 PutAnomalyDetectorInput added in v1.20.17 

type PutAnomalyDetectorInput struct {

	// The configuration specifies details about how the anomaly detection model
	// is to be trained, including time ranges to exclude when training and updating
	// the model. You can specify as many as 10 time ranges.
	//
	// The configuration can also include the time zone to use for the metric.
	Configuration *AnomalyDetectorConfiguration `type:"structure"`

	// The metric dimensions to create the anomaly detection model for.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	Dimensions []*Dimension `deprecated:"true" type:"list"`

	// The metric math anomaly detector to be created.
	//
	// When using MetricMathAnomalyDetector, you cannot include the following parameters
	// in the same operation:
	//
	//    * Dimensions
	//
	//    * MetricName
	//
	//    * Namespace
	//
	//    * Stat
	//
	//    * the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput
	//
	// Instead, specify the metric math anomaly detector attributes as part of the
	// property MetricMathAnomalyDetector.
	MetricMathAnomalyDetector *MetricMathAnomalyDetector `type:"structure"`

	// The name of the metric to create the anomaly detection model for.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	MetricName *string `min:"1" deprecated:"true" type:"string"`

	// The namespace of the metric to create the anomaly detection model for.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	Namespace *string `min:"1" deprecated:"true" type:"string"`

	// A single metric anomaly detector to be created.
	//
	// When using SingleMetricAnomalyDetector, you cannot include the following
	// parameters in the same operation:
	//
	//    * Dimensions
	//
	//    * MetricName
	//
	//    * Namespace
	//
	//    * Stat
	//
	//    * the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput
	//
	// Instead, specify the single metric anomaly detector attributes as part of
	// the property SingleMetricAnomalyDetector.
	SingleMetricAnomalyDetector *SingleMetricAnomalyDetector `type:"structure"`

	// The statistic to use for the metric and the anomaly detection model.
	//
	// Deprecated: Use SingleMetricAnomalyDetector.
	Stat *string `deprecated:"true" type:"string"`
	// contains filtered or unexported fields
}

func (PutAnomalyDetectorInput) GoString added in v1.20.17 

func (s PutAnomalyDetectorInput) 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 (*PutAnomalyDetectorInput) SetConfiguration added in v1.20.17 

func (s *PutAnomalyDetectorInput) SetConfiguration(v *AnomalyDetectorConfiguration) *PutAnomalyDetectorInput

SetConfiguration sets the Configuration field's value.

func (*PutAnomalyDetectorInput) SetDimensions added in v1.20.17 

func (s *PutAnomalyDetectorInput) SetDimensions(v []*Dimension) *PutAnomalyDetectorInput

SetDimensions sets the Dimensions field's value.

func (*PutAnomalyDetectorInput) SetMetricMathAnomalyDetector added in v1.42.8 

func (s *PutAnomalyDetectorInput) SetMetricMathAnomalyDetector(v *MetricMathAnomalyDetector) *PutAnomalyDetectorInput

SetMetricMathAnomalyDetector sets the MetricMathAnomalyDetector field's value.

func (*PutAnomalyDetectorInput) SetMetricName added in v1.20.17 

func (s *PutAnomalyDetectorInput) SetMetricName(v string) *PutAnomalyDetectorInput

SetMetricName sets the MetricName field's value.

func (*PutAnomalyDetectorInput) SetNamespace added in v1.20.17 

func (s *PutAnomalyDetectorInput) SetNamespace(v string) *PutAnomalyDetectorInput

SetNamespace sets the Namespace field's value.

func (*PutAnomalyDetectorInput) SetSingleMetricAnomalyDetector added in v1.42.8 

func (s *PutAnomalyDetectorInput) SetSingleMetricAnomalyDetector(v *SingleMetricAnomalyDetector) *PutAnomalyDetectorInput

SetSingleMetricAnomalyDetector sets the SingleMetricAnomalyDetector field's value.

func (*PutAnomalyDetectorInput) SetStat added in v1.20.17 

func (s *PutAnomalyDetectorInput) SetStat(v string) *PutAnomalyDetectorInput

SetStat sets the Stat field's value.

func (PutAnomalyDetectorInput) String added in v1.20.17 

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

func (s *PutAnomalyDetectorInput) Validate() error

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

type PutAnomalyDetectorOutput added in v1.20.17 

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

func (PutAnomalyDetectorOutput) GoString added in v1.20.17 

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

func (s PutAnomalyDetectorOutput) 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 PutCompositeAlarmInput added in v1.29.15 

type PutCompositeAlarmInput struct {

	// Indicates whether actions should be executed during any changes to the alarm
	// state of the composite alarm. The default is TRUE.
	ActionsEnabled *bool `type:"boolean"`

	// Actions will be suppressed if the suppressor alarm is in the ALARM state.
	// ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from
	// an existing alarm.
	ActionsSuppressor *string `min:"1" type:"string"`

	// The maximum time in seconds that the composite alarm waits after suppressor
	// alarm goes out of the ALARM state. After this time, the composite alarm performs
	// its actions.
	//
	// ExtensionPeriod is required only when ActionsSuppressor is specified.
	ActionsSuppressorExtensionPeriod *int64 `type:"integer"`

	// The maximum time in seconds that the composite alarm waits for the suppressor
	// alarm to go into the ALARM state. After this time, the composite alarm performs
	// its actions.
	//
	// WaitPeriod is required only when ActionsSuppressor is specified.
	ActionsSuppressorWaitPeriod *int64 `type:"integer"`

	// The actions to execute when this alarm transitions to the ALARM state from
	// any other state. Each action is specified as an Amazon Resource Name (ARN).
	//
	// Valid Values: arn:aws:sns:region:account-id:sns-topic-name | arn:aws:ssm:region:account-id:opsitem:severity
	AlarmActions []*string `type:"list"`

	// The description for the composite alarm.
	AlarmDescription *string `type:"string"`

	// The name for the composite alarm. This name must be unique within the Region.
	//
	// AlarmName is a required field
	AlarmName *string `min:"1" type:"string" required:"true"`

	// An expression that specifies which other alarms are to be evaluated to determine
	// this composite alarm's state. For each alarm that you reference, you designate
	// a function that specifies whether that alarm needs to be in ALARM state,
	// OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and
	// NOT) to combine multiple functions in a single expression. You can use parenthesis
	// to logically group the functions in your expression.
	//
	// You can use either alarm names or ARNs to reference the other alarms that
	// are to be evaluated.
	//
	// Functions can include the following:
	//
	//    * ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM
	//    state.
	//
	//    * OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state.
	//
	//    * INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm
	//    is in INSUFFICIENT_DATA state.
	//
	//    * TRUE always evaluates to TRUE.
	//
	//    * FALSE always evaluates to FALSE.
	//
	// TRUE and FALSE are useful for testing a complex AlarmRule structure, and
	// for testing your alarm actions.
	//
	// Alarm names specified in AlarmRule can be surrounded with double-quotes ("),
	// but do not have to be.
	//
	// The following are some examples of AlarmRule:
	//
	//    * ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies
	//    that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh
	//    and DiskReadOpsTooHigh alarms are in ALARM state.
	//
	//    * ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress) specifies
	//    that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM
	//    state and DeploymentInProgress is not in ALARM state. This example reduces
	//    alarm noise during a known deployment window.
	//
	//    * (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
	//    goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is
	//    in ALARM state, and if NetworkOutTooHigh is in OK state. This provides
	//    another example of using a composite alarm to prevent noise. This rule
	//    ensures that you are not notified with an alarm action on high CPU or
	//    disk usage if a known network problem is also occurring.
	//
	// The AlarmRule can specify as many as 100 "children" alarms. The AlarmRule
	// expression can have as many as 500 elements. Elements are child alarms, TRUE
	// or FALSE statements, and parentheses.
	//
	// AlarmRule is a required field
	AlarmRule *string `min:"1" type:"string" required:"true"`

	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
	// state from any other state. Each action is specified as an Amazon Resource
	// Name (ARN).
	//
	// Valid Values: arn:aws:sns:region:account-id:sns-topic-name
	InsufficientDataActions []*string `type:"list"`

	// The actions to execute when this alarm transitions to an OK state from any
	// other state. Each action is specified as an Amazon Resource Name (ARN).
	//
	// Valid Values: arn:aws:sns:region:account-id:sns-topic-name
	OKActions []*string `type:"list"`

	// A list of key-value pairs to associate with the composite alarm. You can
	// associate as many as 50 tags with an alarm.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions, by granting a user permission to access or
	// change only resources with certain tag values.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (PutCompositeAlarmInput) GoString added in v1.29.15 

func (s PutCompositeAlarmInput) 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 (*PutCompositeAlarmInput) SetActionsEnabled added in v1.29.15 

func (s *PutCompositeAlarmInput) SetActionsEnabled(v bool) *PutCompositeAlarmInput

SetActionsEnabled sets the ActionsEnabled field's value.

func (*PutCompositeAlarmInput) SetActionsSuppressor added in v1.44.60 

func (s *PutCompositeAlarmInput) SetActionsSuppressor(v string) *PutCompositeAlarmInput

SetActionsSuppressor sets the ActionsSuppressor field's value.

func (*PutCompositeAlarmInput) SetActionsSuppressorExtensionPeriod added in v1.44.60 

func (s *PutCompositeAlarmInput) SetActionsSuppressorExtensionPeriod(v int64) *PutCompositeAlarmInput

SetActionsSuppressorExtensionPeriod sets the ActionsSuppressorExtensionPeriod field's value.

func (*PutCompositeAlarmInput) SetActionsSuppressorWaitPeriod added in v1.44.60 

func (s *PutCompositeAlarmInput) SetActionsSuppressorWaitPeriod(v int64) *PutCompositeAlarmInput

SetActionsSuppressorWaitPeriod sets the ActionsSuppressorWaitPeriod field's value.

func (*PutCompositeAlarmInput) SetAlarmActions added in v1.29.15 

func (s *PutCompositeAlarmInput) SetAlarmActions(v []*string) *PutCompositeAlarmInput

SetAlarmActions sets the AlarmActions field's value.

func (*PutCompositeAlarmInput) SetAlarmDescription added in v1.29.15 

func (s *PutCompositeAlarmInput) SetAlarmDescription(v string) *PutCompositeAlarmInput

SetAlarmDescription sets the AlarmDescription field's value.

func (*PutCompositeAlarmInput) SetAlarmName added in v1.29.15 

func (s *PutCompositeAlarmInput) SetAlarmName(v string) *PutCompositeAlarmInput

SetAlarmName sets the AlarmName field's value.

func (*PutCompositeAlarmInput) SetAlarmRule added in v1.29.15 

func (s *PutCompositeAlarmInput) SetAlarmRule(v string) *PutCompositeAlarmInput

SetAlarmRule sets the AlarmRule field's value.

func (*PutCompositeAlarmInput) SetInsufficientDataActions added in v1.29.15 

func (s *PutCompositeAlarmInput) SetInsufficientDataActions(v []*string) *PutCompositeAlarmInput

SetInsufficientDataActions sets the InsufficientDataActions field's value.

func (*PutCompositeAlarmInput) SetOKActions added in v1.29.15 

func (s *PutCompositeAlarmInput) SetOKActions(v []*string) *PutCompositeAlarmInput

SetOKActions sets the OKActions field's value.

func (*PutCompositeAlarmInput) SetTags added in v1.29.15 

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

SetTags sets the Tags field's value.

func (PutCompositeAlarmInput) String added in v1.29.15 

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

func (s *PutCompositeAlarmInput) Validate() error

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

type PutCompositeAlarmOutput added in v1.29.15 

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

func (PutCompositeAlarmOutput) GoString added in v1.29.15 

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

func (s PutCompositeAlarmOutput) 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 PutDashboardInput added in v1.10.7 

type PutDashboardInput struct {

	// The detailed information about the dashboard in JSON format, including the
	// widgets to include and their location on the dashboard. This parameter is
	// required.
	//
	// For more information about the syntax, see Dashboard Body Structure and Syntax
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html).
	//
	// DashboardBody is a required field
	DashboardBody *string `type:"string" required:"true"`

	// The name of the dashboard. If a dashboard with this name already exists,
	// this call modifies that dashboard, replacing its current contents. Otherwise,
	// a new dashboard is created. The maximum length is 255, and valid characters
	// are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
	//
	// DashboardName is a required field
	DashboardName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutDashboardInput) GoString added in v1.10.7 

func (s PutDashboardInput) 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 (*PutDashboardInput) SetDashboardBody added in v1.10.7 

func (s *PutDashboardInput) SetDashboardBody(v string) *PutDashboardInput

SetDashboardBody sets the DashboardBody field's value.

func (*PutDashboardInput) SetDashboardName added in v1.10.7 

func (s *PutDashboardInput) SetDashboardName(v string) *PutDashboardInput

SetDashboardName sets the DashboardName field's value.

func (PutDashboardInput) String added in v1.10.7 

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

func (s *PutDashboardInput) Validate() error

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

type PutDashboardOutput added in v1.10.7 

type PutDashboardOutput struct {

	// If the input for PutDashboard was correct and the dashboard was successfully
	// created or modified, this result is empty.
	//
	// If this result includes only warning messages, then the input was valid enough
	// for the dashboard to be created or modified, but some elements of the dashboard
	// might not render.
	//
	// If this result includes error messages, the input was not valid and the operation
	// failed.
	DashboardValidationMessages []*DashboardValidationMessage `type:"list"`
	// contains filtered or unexported fields
}

func (PutDashboardOutput) GoString added in v1.10.7 

func (s PutDashboardOutput) 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 (*PutDashboardOutput) SetDashboardValidationMessages added in v1.10.7 

func (s *PutDashboardOutput) SetDashboardValidationMessages(v []*DashboardValidationMessage) *PutDashboardOutput

SetDashboardValidationMessages sets the DashboardValidationMessages field's value.

func (PutDashboardOutput) String added in v1.10.7 

func (s PutDashboardOutput) 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 PutInsightRuleInput added in v1.25.42 

type PutInsightRuleInput struct {

	// The definition of the rule, as a JSON object. For details on the valid syntax,
	// see Contributor Insights Rule Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html).
	//
	// RuleDefinition is a required field
	RuleDefinition *string `min:"1" type:"string" required:"true"`

	// A unique name for the rule.
	//
	// RuleName is a required field
	RuleName *string `min:"1" type:"string" required:"true"`

	// The state of the rule. Valid values are ENABLED and DISABLED.
	RuleState *string `min:"1" type:"string"`

	// A list of key-value pairs to associate with the Contributor Insights rule.
	// You can associate as many as 50 tags with a rule.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions, by granting a user permission to access or
	// change only the resources that have certain tag values.
	//
	// To be able to associate tags with a rule, you must have the cloudwatch:TagResource
	// permission in addition to the cloudwatch:PutInsightRule permission.
	//
	// If you are using this operation to update an existing Contributor Insights
	// rule, any tags you specify in this parameter are ignored. To change the tags
	// of an existing rule, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html).
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (PutInsightRuleInput) GoString added in v1.25.42 

func (s PutInsightRuleInput) 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 (*PutInsightRuleInput) SetRuleDefinition added in v1.25.42 

func (s *PutInsightRuleInput) SetRuleDefinition(v string) *PutInsightRuleInput

SetRuleDefinition sets the RuleDefinition field's value.

func (*PutInsightRuleInput) SetRuleName added in v1.25.42 

func (s *PutInsightRuleInput) SetRuleName(v string) *PutInsightRuleInput

SetRuleName sets the RuleName field's value.

func (*PutInsightRuleInput) SetRuleState added in v1.25.42 

func (s *PutInsightRuleInput) SetRuleState(v string) *PutInsightRuleInput

SetRuleState sets the RuleState field's value.

func (*PutInsightRuleInput) SetTags added in v1.30.3 

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

SetTags sets the Tags field's value.

func (PutInsightRuleInput) String added in v1.25.42 

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

func (s *PutInsightRuleInput) Validate() error

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

type PutInsightRuleOutput added in v1.25.42 

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

func (PutInsightRuleOutput) GoString added in v1.25.42 

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

func (s PutInsightRuleOutput) 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 PutManagedInsightRulesInput added in v1.44.80 

type PutManagedInsightRulesInput struct {

	// A list of ManagedRules to enable.
	//
	// ManagedRules is a required field
	ManagedRules []*ManagedRule `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutManagedInsightRulesInput) GoString added in v1.44.80 

func (s PutManagedInsightRulesInput) 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 (*PutManagedInsightRulesInput) SetManagedRules added in v1.44.80 

func (s *PutManagedInsightRulesInput) SetManagedRules(v []*ManagedRule) *PutManagedInsightRulesInput

SetManagedRules sets the ManagedRules field's value.

func (PutManagedInsightRulesInput) String added in v1.44.80 

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

func (s *PutManagedInsightRulesInput) Validate() error

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

type PutManagedInsightRulesOutput added in v1.44.80 

type PutManagedInsightRulesOutput struct {

	// An array that lists the rules that could not be enabled.
	Failures []*PartialFailure `type:"list"`
	// contains filtered or unexported fields
}

func (PutManagedInsightRulesOutput) GoString added in v1.44.80 

func (s PutManagedInsightRulesOutput) 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 (*PutManagedInsightRulesOutput) SetFailures added in v1.44.80 

func (s *PutManagedInsightRulesOutput) SetFailures(v []*PartialFailure) *PutManagedInsightRulesOutput

SetFailures sets the Failures field's value.

func (PutManagedInsightRulesOutput) String added in v1.44.80 

func (s PutManagedInsightRulesOutput) 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 PutMetricAlarmInput 

type PutMetricAlarmInput struct {

	// Indicates whether actions should be executed during any changes to the alarm
	// state. The default is TRUE.
	ActionsEnabled *bool `type:"boolean"`

	// The actions to execute when this alarm transitions to the ALARM state from
	// any other state. Each action is specified as an Amazon Resource Name (ARN).
	//
	// Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate
	// | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot
	// | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
	// | arn:aws:ssm:region:account-id:opsitem:severity | arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
	//
	// Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
	AlarmActions []*string `type:"list"`

	// The description for the alarm.
	AlarmDescription *string `type:"string"`

	// The name for the alarm. This name must be unique within the Region.
	//
	// AlarmName is a required field
	AlarmName *string `min:"1" type:"string" required:"true"`

	// The arithmetic operation to use when comparing the specified statistic and
	// threshold. The specified statistic value is used as the first operand.
	//
	// The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold,
	// and GreaterThanUpperThreshold are used only for alarms based on anomaly detection
	// models.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperator"`

	// The number of data points that must be breaching to trigger the alarm. This
	// is used only if you are setting an "M out of N" alarm. In that case, this
	// value is the M. For more information, see Evaluating an Alarm (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation)
	// in the Amazon CloudWatch User Guide.
	DatapointsToAlarm *int64 `min:"1" type:"integer"`

	// The dimensions for the metric specified in MetricName.
	Dimensions []*Dimension `type:"list"`

	// Used only for alarms based on percentiles. If you specify ignore, the alarm
	// state does not change during periods with too few data points to be statistically
	// significant. If you specify evaluate or omit this parameter, the alarm is
	// always evaluated and possibly changes state no matter how many data points
	// are available. For more information, see Percentile-Based CloudWatch Alarms
	// and Low Data Samples (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples).
	//
	// Valid Values: evaluate | ignore
	EvaluateLowSampleCountPercentile *string `min:"1" type:"string"`

	// The number of periods over which data is compared to the specified threshold.
	// If you are setting an alarm that requires that a number of consecutive data
	// points be breaching to trigger the alarm, this value specifies that number.
	// If you are setting an "M out of N" alarm, this value is the N.
	//
	// An alarm's total current evaluation period can be no longer than one day,
	// so this number multiplied by Period cannot be more than 86,400 seconds.
	//
	// EvaluationPeriods is a required field
	EvaluationPeriods *int64 `min:"1" type:"integer" required:"true"`

	// The percentile statistic for the metric specified in MetricName. Specify
	// a value between p0.0 and p100. When you call PutMetricAlarm and specify a
	// MetricName, you must specify either Statistic or ExtendedStatistic, but not
	// both.
	ExtendedStatistic *string `type:"string"`

	// The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
	// state from any other state. Each action is specified as an Amazon Resource
	// Name (ARN).
	//
	// Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate
	// | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot
	// | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
	//
	// Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
	InsufficientDataActions []*string `type:"list"`

	// The name for the metric associated with the alarm. For each PutMetricAlarm
	// operation, you must specify either MetricName or a Metrics array.
	//
	// If you are creating an alarm based on a math expression, you cannot specify
	// this parameter, or any of the Dimensions, Period, Namespace, Statistic, or
	// ExtendedStatistic parameters. Instead, you specify all this information in
	// the Metrics array.
	MetricName *string `min:"1" type:"string"`

	// An array of MetricDataQuery structures that enable you to create an alarm
	// based on the result of a metric math expression. For each PutMetricAlarm
	// operation, you must specify either MetricName or a Metrics array.
	//
	// Each item in the Metrics array either retrieves a metric or performs a math
	// expression.
	//
	// One item in the Metrics array is the expression that the alarm watches. You
	// designate this expression by setting ReturnData to true for this object in
	// the array. For more information, see MetricDataQuery (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html).
	//
	// If you use the Metrics parameter, you cannot include the MetricName, Dimensions,
	// Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm
	// in the same operation. Instead, you retrieve the metrics you are using in
	// your math expression as part of the Metrics array.
	Metrics []*MetricDataQuery `type:"list"`

	// The namespace for the metric associated specified in MetricName.
	Namespace *string `min:"1" type:"string"`

	// The actions to execute when this alarm transitions to an OK state from any
	// other state. Each action is specified as an Amazon Resource Name (ARN).
	//
	// Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate
	// | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot
	// | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
	//
	// Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
	// | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
	OKActions []*string `type:"list"`

	// The length, in seconds, used each time the metric specified in MetricName
	// is evaluated. Valid values are 10, 30, and any multiple of 60.
	//
	// Period is required for alarms based on static thresholds. If you are creating
	// an alarm based on a metric math expression, you specify the period for each
	// metric within the objects in the Metrics array.
	//
	// Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData
	// call with a StorageResolution of 1. If you specify a period of 10 or 30 for
	// a metric that does not have sub-minute resolution, the alarm still attempts
	// to gather data at the period rate that you specify. In this case, it does
	// not receive data for the attempts that do not correspond to a one-minute
	// data resolution, and the alarm might often lapse into INSUFFICENT_DATA status.
	// Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which
	// has a higher charge than other alarms. For more information about pricing,
	// see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).
	//
	// An alarm's total current evaluation period can be no longer than one day,
	// so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
	Period *int64 `min:"1" type:"integer"`

	// The statistic for the metric specified in MetricName, other than percentile.
	// For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm
	// and specify a MetricName, you must specify either Statistic or ExtendedStatistic,
	// but not both.
	Statistic *string `type:"string" enum:"Statistic"`

	// A list of key-value pairs to associate with the alarm. You can associate
	// as many as 50 tags with an alarm.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions by granting a user permission to access or
	// change only resources with certain tag values.
	//
	// If you are using this operation to update an existing alarm, any tags you
	// specify in this parameter are ignored. To change the tags of an existing
	// alarm, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html)
	// or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html).
	Tags []*Tag `type:"list"`

	// The value against which the specified statistic is compared.
	//
	// This parameter is required for alarms based on static thresholds, but should
	// not be used for alarms based on anomaly detection models.
	Threshold *float64 `type:"double"`

	// If this is an alarm based on an anomaly detection model, make this value
	// match the ID of the ANOMALY_DETECTION_BAND function.
	//
	// For an example of how to use this parameter, see the Anomaly Detection Model
	// Alarm example on this page.
	//
	// If your alarm uses this parameter, it cannot have Auto Scaling actions.
	ThresholdMetricId *string `min:"1" type:"string"`

	// Sets how this alarm is to handle missing data points. If TreatMissingData
	// is omitted, the default behavior of missing is used. For more information,
	// see Configuring How CloudWatch Alarms Treats Missing Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).
	//
	// Valid Values: breaching | notBreaching | ignore | missing
	//
	// Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore
	// missing data even if you choose a different option for TreatMissingData.
	// When an AWS/DynamoDB metric has missing data, alarms that evaluate that metric
	// remain in their current state.
	TreatMissingData *string `min:"1" type:"string"`

	// The unit of measure for the statistic. For example, the units for the Amazon
	// EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes
	// that an instance receives on all network interfaces. You can also specify
	// a unit when you create a custom metric. Units help provide conceptual meaning
	// to your data. Metric data points that specify a unit of measure, such as
	// Percent, are aggregated separately.
	//
	// If you don't specify Unit, CloudWatch retrieves all unit types that have
	// been published for the metric and attempts to evaluate the alarm. Usually,
	// metrics are published with only one unit, so the alarm works as intended.
	//
	// However, if the metric is published with multiple types of units and you
	// don't specify a unit, the alarm's behavior is not defined and it behaves
	// unpredictably.
	//
	// We recommend omitting Unit so that you don't inadvertently specify an incorrect
	// unit that is not published for this metric. Doing so causes the alarm to
	// be stuck in the INSUFFICIENT DATA state.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

func (PutMetricAlarmInput) GoString added in v0.6.5 

func (s PutMetricAlarmInput) 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 (*PutMetricAlarmInput) SetActionsEnabled added in v1.5.0 

func (s *PutMetricAlarmInput) SetActionsEnabled(v bool) *PutMetricAlarmInput

SetActionsEnabled sets the ActionsEnabled field's value.

func (*PutMetricAlarmInput) SetAlarmActions added in v1.5.0 

func (s *PutMetricAlarmInput) SetAlarmActions(v []*string) *PutMetricAlarmInput

SetAlarmActions sets the AlarmActions field's value.

func (*PutMetricAlarmInput) SetAlarmDescription added in v1.5.0 

func (s *PutMetricAlarmInput) SetAlarmDescription(v string) *PutMetricAlarmInput

SetAlarmDescription sets the AlarmDescription field's value.

func (*PutMetricAlarmInput) SetAlarmName added in v1.5.0 

func (s *PutMetricAlarmInput) SetAlarmName(v string) *PutMetricAlarmInput

SetAlarmName sets the AlarmName field's value.

func (*PutMetricAlarmInput) SetComparisonOperator added in v1.5.0 

func (s *PutMetricAlarmInput) SetComparisonOperator(v string) *PutMetricAlarmInput

SetComparisonOperator sets the ComparisonOperator field's value.

func (*PutMetricAlarmInput) SetDatapointsToAlarm added in v1.12.44 

func (s *PutMetricAlarmInput) SetDatapointsToAlarm(v int64) *PutMetricAlarmInput

SetDatapointsToAlarm sets the DatapointsToAlarm field's value.

func (*PutMetricAlarmInput) SetDimensions added in v1.5.0 

func (s *PutMetricAlarmInput) SetDimensions(v []*Dimension) *PutMetricAlarmInput

SetDimensions sets the Dimensions field's value.

func (*PutMetricAlarmInput) SetEvaluateLowSampleCountPercentile added in v1.8.8 

func (s *PutMetricAlarmInput) SetEvaluateLowSampleCountPercentile(v string) *PutMetricAlarmInput

SetEvaluateLowSampleCountPercentile sets the EvaluateLowSampleCountPercentile field's value.

func (*PutMetricAlarmInput) SetEvaluationPeriods added in v1.5.0 

func (s *PutMetricAlarmInput) SetEvaluationPeriods(v int64) *PutMetricAlarmInput

SetEvaluationPeriods sets the EvaluationPeriods field's value.

func (*PutMetricAlarmInput) SetExtendedStatistic added in v1.5.7 

func (s *PutMetricAlarmInput) SetExtendedStatistic(v string) *PutMetricAlarmInput

SetExtendedStatistic sets the ExtendedStatistic field's value.

func (*PutMetricAlarmInput) SetInsufficientDataActions added in v1.5.0 

func (s *PutMetricAlarmInput) SetInsufficientDataActions(v []*string) *PutMetricAlarmInput

SetInsufficientDataActions sets the InsufficientDataActions field's value.

func (*PutMetricAlarmInput) SetMetricName added in v1.5.0 

func (s *PutMetricAlarmInput) SetMetricName(v string) *PutMetricAlarmInput

SetMetricName sets the MetricName field's value.

func (*PutMetricAlarmInput) SetMetrics added in v1.15.80 

func (s *PutMetricAlarmInput) SetMetrics(v []*MetricDataQuery) *PutMetricAlarmInput

SetMetrics sets the Metrics field's value.

func (*PutMetricAlarmInput) SetNamespace added in v1.5.0 

func (s *PutMetricAlarmInput) SetNamespace(v string) *PutMetricAlarmInput

SetNamespace sets the Namespace field's value.

func (*PutMetricAlarmInput) SetOKActions added in v1.5.0 

func (s *PutMetricAlarmInput) SetOKActions(v []*string) *PutMetricAlarmInput

SetOKActions sets the OKActions field's value.

func (*PutMetricAlarmInput) SetPeriod added in v1.5.0 

func (s *PutMetricAlarmInput) SetPeriod(v int64) *PutMetricAlarmInput

SetPeriod sets the Period field's value.

func (*PutMetricAlarmInput) SetStatistic added in v1.5.0 

func (s *PutMetricAlarmInput) SetStatistic(v string) *PutMetricAlarmInput

SetStatistic sets the Statistic field's value.

func (*PutMetricAlarmInput) SetTags added in v1.19.6 

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

SetTags sets the Tags field's value.

func (*PutMetricAlarmInput) SetThreshold added in v1.5.0 

func (s *PutMetricAlarmInput) SetThreshold(v float64) *PutMetricAlarmInput

SetThreshold sets the Threshold field's value.

func (*PutMetricAlarmInput) SetThresholdMetricId added in v1.20.17 

func (s *PutMetricAlarmInput) SetThresholdMetricId(v string) *PutMetricAlarmInput

SetThresholdMetricId sets the ThresholdMetricId field's value.

func (*PutMetricAlarmInput) SetTreatMissingData added in v1.8.8 

func (s *PutMetricAlarmInput) SetTreatMissingData(v string) *PutMetricAlarmInput

SetTreatMissingData sets the TreatMissingData field's value.

func (*PutMetricAlarmInput) SetUnit added in v1.5.0 

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

SetUnit sets the Unit field's value.

func (PutMetricAlarmInput) String added in v0.6.5 

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

func (s *PutMetricAlarmInput) Validate() error

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

type PutMetricAlarmOutput 

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

func (PutMetricAlarmOutput) GoString added in v0.6.5 

func (s PutMetricAlarmOutput) 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 (PutMetricAlarmOutput) String added in v0.6.5 

func (s PutMetricAlarmOutput) 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 PutMetricDataInput 

type PutMetricDataInput struct {

	// The data for the metric. The array can include no more than 1000 metrics
	// per call.
	//
	// MetricData is a required field
	MetricData []*MetricDatum `type:"list" required:"true"`

	// The namespace for the metric data.
	//
	// To avoid conflicts with Amazon Web Services service namespaces, you should
	// not specify a namespace that begins with AWS/
	//
	// Namespace is a required field
	Namespace *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutMetricDataInput) GoString added in v0.6.5 

func (s PutMetricDataInput) 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 (*PutMetricDataInput) SetMetricData added in v1.5.0 

func (s *PutMetricDataInput) SetMetricData(v []*MetricDatum) *PutMetricDataInput

SetMetricData sets the MetricData field's value.

func (*PutMetricDataInput) SetNamespace added in v1.5.0 

func (s *PutMetricDataInput) SetNamespace(v string) *PutMetricDataInput

SetNamespace sets the Namespace field's value.

func (PutMetricDataInput) String added in v0.6.5 

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

func (s *PutMetricDataInput) Validate() error

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

type PutMetricDataOutput 

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

func (PutMetricDataOutput) GoString added in v0.6.5 

func (s PutMetricDataOutput) 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 (PutMetricDataOutput) String added in v0.6.5 

func (s PutMetricDataOutput) 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 PutMetricStreamInput added in v1.38.9 

type PutMetricStreamInput struct {

	// If you specify this parameter, the stream sends metrics from all metric namespaces
	// except for the namespaces that you specify here.
	//
	// You cannot include ExcludeFilters and IncludeFilters in the same operation.
	ExcludeFilters []*MetricStreamFilter `type:"list"`

	// The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric
	// stream. This Amazon Kinesis Firehose delivery stream must already exist and
	// must be in the same account as the metric stream.
	//
	// FirehoseArn is a required field
	FirehoseArn *string `min:"1" type:"string" required:"true"`

	// If you specify this parameter, the stream sends only the metrics from the
	// metric namespaces that you specify here.
	//
	// You cannot include IncludeFilters and ExcludeFilters in the same operation.
	IncludeFilters []*MetricStreamFilter `type:"list"`

	// If you are creating a new metric stream, this is the name for the new stream.
	// The name must be different than the names of other metric streams in this
	// account and Region.
	//
	// If you are updating a metric stream, specify the name of that stream here.
	//
	// Valid characters are A-Z, a-z, 0-9, "-" and "_".
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The output format for the stream. Valid values are json and opentelemetry0.7.
	// For more information about metric stream output formats, see Metric streams
	// output formats (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html).
	//
	// OutputFormat is a required field
	OutputFormat *string `min:"1" type:"string" required:"true" enum:"MetricStreamOutputFormat"`

	// The ARN of an IAM role that this metric stream will use to access Amazon
	// Kinesis Firehose resources. This IAM role must already exist and must be
	// in the same account as the metric stream. This IAM role must include the
	// following permissions:
	//
	//    * firehose:PutRecord
	//
	//    * firehose:PutRecordBatch
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`

	// By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT
	// statistics for each metric that is streamed. You can use this parameter to
	// have the metric stream also send additional statistics in the stream. This
	// array can have up to 100 members.
	//
	// For each entry in this array, you specify one or more metrics and the list
	// of additional statistics to stream for those metrics. The additional statistics
	// that you can stream depend on the stream's OutputFormat. If the OutputFormat
	// is json, you can stream any additional statistic that is supported by CloudWatch,
	// listed in CloudWatch statistics definitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.html).
	// If the OutputFormat is opentelemetry0.7, you can stream percentile statistics
	// such as p95, p99.9 and so on.
	StatisticsConfigurations []*MetricStreamStatisticsConfiguration `type:"list"`

	// A list of key-value pairs to associate with the metric stream. You can associate
	// as many as 50 tags with a metric stream.
	//
	// Tags can help you organize and categorize your resources. You can also use
	// them to scope user permissions by granting a user permission to access or
	// change only resources with certain tag values.
	//
	// You can use this parameter only when you are creating a new metric stream.
	// If you are using this operation to update an existing metric stream, any
	// tags you specify in this parameter are ignored. To change the tags of an
	// existing metric stream, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html)
	// or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html).
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (PutMetricStreamInput) GoString added in v1.38.9 

func (s PutMetricStreamInput) 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 (*PutMetricStreamInput) SetExcludeFilters added in v1.38.9 

func (s *PutMetricStreamInput) SetExcludeFilters(v []*MetricStreamFilter) *PutMetricStreamInput

SetExcludeFilters sets the ExcludeFilters field's value.

func (*PutMetricStreamInput) SetFirehoseArn added in v1.38.9 

func (s *PutMetricStreamInput) SetFirehoseArn(v string) *PutMetricStreamInput

SetFirehoseArn sets the FirehoseArn field's value.

func (*PutMetricStreamInput) SetIncludeFilters added in v1.38.9 

func (s *PutMetricStreamInput) SetIncludeFilters(v []*MetricStreamFilter) *PutMetricStreamInput

SetIncludeFilters sets the IncludeFilters field's value.

func (*PutMetricStreamInput) SetName added in v1.38.9 

func (s *PutMetricStreamInput) SetName(v string) *PutMetricStreamInput

SetName sets the Name field's value.

func (*PutMetricStreamInput) SetOutputFormat added in v1.38.9 

func (s *PutMetricStreamInput) SetOutputFormat(v string) *PutMetricStreamInput

SetOutputFormat sets the OutputFormat field's value.

func (*PutMetricStreamInput) SetRoleArn added in v1.38.9 

func (s *PutMetricStreamInput) SetRoleArn(v string) *PutMetricStreamInput

SetRoleArn sets the RoleArn field's value.

func (*PutMetricStreamInput) SetStatisticsConfigurations added in v1.43.39 

func (s *PutMetricStreamInput) SetStatisticsConfigurations(v []*MetricStreamStatisticsConfiguration) *PutMetricStreamInput

SetStatisticsConfigurations sets the StatisticsConfigurations field's value.

func (*PutMetricStreamInput) SetTags added in v1.38.9 

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

SetTags sets the Tags field's value.

func (PutMetricStreamInput) String added in v1.38.9 

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

func (s *PutMetricStreamInput) Validate() error

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

type PutMetricStreamOutput added in v1.38.9 

type PutMetricStreamOutput struct {

	// The ARN of the metric stream.
	Arn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutMetricStreamOutput) GoString added in v1.38.9 

func (s PutMetricStreamOutput) 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 (*PutMetricStreamOutput) SetArn added in v1.38.9 

func (s *PutMetricStreamOutput) SetArn(v string) *PutMetricStreamOutput

SetArn sets the Arn field's value.

func (PutMetricStreamOutput) String added in v1.38.9 

func (s PutMetricStreamOutput) 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 Range added in v1.20.17 

type Range struct {

	// The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss.
	// For example, 2019-07-01T23:59:59.
	//
	// EndTime is a required field
	EndTime *time.Time `type:"timestamp" required:"true"`

	// The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss.
	// For example, 2019-07-01T23:59:59.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Specifies one range of days or times to exclude from use for training an anomaly detection model.

func (Range) GoString added in v1.20.17 

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

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

SetEndTime sets the EndTime field's value.

func (*Range) SetStartTime added in v1.20.17 

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

SetStartTime sets the StartTime field's value.

func (Range) String added in v1.20.17 

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

func (s *Range) Validate() error

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

type SetAlarmStateInput 

type SetAlarmStateInput struct {

	// The name of the alarm.
	//
	// AlarmName is a required field
	AlarmName *string `min:"1" type:"string" required:"true"`

	// The reason that this alarm is set to this specific state, in text format.
	//
	// StateReason is a required field
	StateReason *string `type:"string" required:"true"`

	// The reason that this alarm is set to this specific state, in JSON format.
	//
	// For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto
	// Scaling or application Auto Scaling alarm actions, the Auto Scaling policy
	// uses the information in this field to take the correct action.
	StateReasonData *string `type:"string"`

	// The value of the state.
	//
	// StateValue is a required field
	StateValue *string `type:"string" required:"true" enum:"StateValue"`
	// contains filtered or unexported fields
}

func (SetAlarmStateInput) GoString added in v0.6.5 

func (s SetAlarmStateInput) 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 (*SetAlarmStateInput) SetAlarmName added in v1.5.0 

func (s *SetAlarmStateInput) SetAlarmName(v string) *SetAlarmStateInput

SetAlarmName sets the AlarmName field's value.

func (*SetAlarmStateInput) SetStateReason added in v1.5.0 

func (s *SetAlarmStateInput) SetStateReason(v string) *SetAlarmStateInput

SetStateReason sets the StateReason field's value.

func (*SetAlarmStateInput) SetStateReasonData added in v1.5.0 

func (s *SetAlarmStateInput) SetStateReasonData(v string) *SetAlarmStateInput

SetStateReasonData sets the StateReasonData field's value.

func (*SetAlarmStateInput) SetStateValue added in v1.5.0 

func (s *SetAlarmStateInput) SetStateValue(v string) *SetAlarmStateInput

SetStateValue sets the StateValue field's value.

func (SetAlarmStateInput) String added in v0.6.5 

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

func (s *SetAlarmStateInput) Validate() error

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

type SetAlarmStateOutput 

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

func (SetAlarmStateOutput) GoString added in v0.6.5 

func (s SetAlarmStateOutput) 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 (SetAlarmStateOutput) String added in v0.6.5 

func (s SetAlarmStateOutput) 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 SingleMetricAnomalyDetector added in v1.42.8 

type SingleMetricAnomalyDetector struct {

	// The metric dimensions to create the anomaly detection model for.
	Dimensions []*Dimension `type:"list"`

	// The name of the metric to create the anomaly detection model for.
	MetricName *string `min:"1" type:"string"`

	// The namespace of the metric to create the anomaly detection model for.
	Namespace *string `min:"1" type:"string"`

	// The statistic to use for the metric and anomaly detection model.
	Stat *string `type:"string"`
	// contains filtered or unexported fields
}

Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.

func (SingleMetricAnomalyDetector) GoString added in v1.42.8 

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

func (s *SingleMetricAnomalyDetector) SetDimensions(v []*Dimension) *SingleMetricAnomalyDetector

SetDimensions sets the Dimensions field's value.

func (*SingleMetricAnomalyDetector) SetMetricName added in v1.42.8 

func (s *SingleMetricAnomalyDetector) SetMetricName(v string) *SingleMetricAnomalyDetector

SetMetricName sets the MetricName field's value.

func (*SingleMetricAnomalyDetector) SetNamespace added in v1.42.8 

func (s *SingleMetricAnomalyDetector) SetNamespace(v string) *SingleMetricAnomalyDetector

SetNamespace sets the Namespace field's value.

func (*SingleMetricAnomalyDetector) SetStat added in v1.42.8 

func (s *SingleMetricAnomalyDetector) SetStat(v string) *SingleMetricAnomalyDetector

SetStat sets the Stat field's value.

func (SingleMetricAnomalyDetector) String added in v1.42.8 

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

func (s *SingleMetricAnomalyDetector) Validate() error

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

type StartMetricStreamsInput added in v1.38.9 

type StartMetricStreamsInput struct {

	// The array of the names of metric streams to start streaming.
	//
	// This is an "all or nothing" operation. If you do not have permission to access
	// all of the metric streams that you list here, then none of the streams that
	// you list in the operation will start streaming.
	//
	// Names is a required field
	Names []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StartMetricStreamsInput) GoString added in v1.38.9 

func (s StartMetricStreamsInput) 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 (*StartMetricStreamsInput) SetNames added in v1.38.9 

func (s *StartMetricStreamsInput) SetNames(v []*string) *StartMetricStreamsInput

SetNames sets the Names field's value.

func (StartMetricStreamsInput) String added in v1.38.9 

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

func (s *StartMetricStreamsInput) Validate() error

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

type StartMetricStreamsOutput added in v1.38.9 

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

func (StartMetricStreamsOutput) GoString added in v1.38.9 

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

func (s StartMetricStreamsOutput) 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 StatisticSet 

type StatisticSet struct {

	// The maximum value of the sample set.
	//
	// Maximum is a required field
	Maximum *float64 `type:"double" required:"true"`

	// The minimum value of the sample set.
	//
	// Minimum is a required field
	Minimum *float64 `type:"double" required:"true"`

	// The number of samples used for the statistic set.
	//
	// SampleCount is a required field
	SampleCount *float64 `type:"double" required:"true"`

	// The sum of values for the sample set.
	//
	// Sum is a required field
	Sum *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Represents a set of statistics that describes a specific metric.

func (StatisticSet) GoString added in v0.6.5 

func (s StatisticSet) 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 (*StatisticSet) SetMaximum added in v1.5.0 

func (s *StatisticSet) SetMaximum(v float64) *StatisticSet

SetMaximum sets the Maximum field's value.

func (*StatisticSet) SetMinimum added in v1.5.0 

func (s *StatisticSet) SetMinimum(v float64) *StatisticSet

SetMinimum sets the Minimum field's value.

func (*StatisticSet) SetSampleCount added in v1.5.0 

func (s *StatisticSet) SetSampleCount(v float64) *StatisticSet

SetSampleCount sets the SampleCount field's value.

func (*StatisticSet) SetSum added in v1.5.0 

func (s *StatisticSet) SetSum(v float64) *StatisticSet

SetSum sets the Sum field's value.

func (StatisticSet) String added in v0.6.5 

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

func (s *StatisticSet) Validate() error

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

type StopMetricStreamsInput added in v1.38.9 

type StopMetricStreamsInput struct {

	// The array of the names of metric streams to stop streaming.
	//
	// This is an "all or nothing" operation. If you do not have permission to access
	// all of the metric streams that you list here, then none of the streams that
	// you list in the operation will stop streaming.
	//
	// Names is a required field
	Names []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StopMetricStreamsInput) GoString added in v1.38.9 

func (s StopMetricStreamsInput) 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 (*StopMetricStreamsInput) SetNames added in v1.38.9 

func (s *StopMetricStreamsInput) SetNames(v []*string) *StopMetricStreamsInput

SetNames sets the Names field's value.

func (StopMetricStreamsInput) String added in v1.38.9 

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

func (s *StopMetricStreamsInput) Validate() error

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

type StopMetricStreamsOutput added in v1.38.9 

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

func (StopMetricStreamsOutput) GoString added in v1.38.9 

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

func (s StopMetricStreamsOutput) 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.19.6 

type Tag struct {

	// A string that you can use to assign a value. The combination of tag keys
	// and values can help you organize and categorize your resources.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value for the specified tag key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A key-value pair associated with a CloudWatch resource.

func (Tag) GoString added in v1.19.6 

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

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

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.19.6 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.19.6 

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

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.19.6 

type TagResourceInput struct {

	// The ARN of the CloudWatch resource that you're adding tags to.
	//
	// The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
	//
	// The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
	//
	// For more information about ARN format, see Resource Types Defined by Amazon
	// CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
	// in the Amazon Web Services General Reference.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The list of key-value pairs to associate with the alarm.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.19.6 

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

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

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.19.6 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.19.6 

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

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.19.6 

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

func (TagResourceOutput) GoString added in v1.19.6 

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

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

type UntagResourceInput struct {

	// The ARN of the CloudWatch resource that you're removing tags from.
	//
	// The ARN format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name
	//
	// The ARN format of a Contributor Insights rule is arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name
	//
	// For more information about ARN format, see Resource Types Defined by Amazon
	// CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
	// in the Amazon Web Services General Reference.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.19.6 

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

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

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.19.6 

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.19.6 

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

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.19.6 

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

func (UntagResourceOutput) GoString added in v1.19.6 

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

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 cloudwatchiface provides an interface to enable mocking the Amazon CloudWatch service client for testing your code.
 Package cloudwatchiface provides an interface to enable mocking the Amazon CloudWatch 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.