cloudwatch

package
v1.8.13 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package cloudwatch provides a client for Amazon CloudWatch.

Index

Examples

Constants

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"
)
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 (
	// 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 (

	// 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 that cannot be used together were 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"

	// 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"
)
View Source 
const (
	ServiceName = "monitoring" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AlarmHistoryItem 

type AlarmHistoryItem struct {

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

	// 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" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Represents the history of a specific alarm. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/AlarmHistoryItem

func (AlarmHistoryItem) GoString added in v0.6.5 

func (s AlarmHistoryItem) GoString() string

GoString returns the string representation

func (*AlarmHistoryItem) SetAlarmName added in v1.5.0 

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

SetAlarmName sets the AlarmName 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

type CloudWatch 

type CloudWatch struct {
	*client.Client
}

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS 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 make changes to 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 Elastic Compute Cloud (Amazon EC2) instances and 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 AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01

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: 

// 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. In the event of an error, no alarms 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 DeleteAlarms for usage and error information.

Returned Error Codes:

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

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.DeleteAlarmsInput{
		AlarmNames: []*string{ // Required
			aws.String("AlarmName"), // Required
			// More values...
		},
	}
	resp, err := svc.DeleteAlarms(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteAlarms for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteAlarms method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) 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 all alarms are returned.

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

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.

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

Example 
package main

import (
	"fmt"
	"time"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.DescribeAlarmHistoryInput{
		AlarmName:       aws.String("AlarmName"),
		EndDate:         aws.Time(time.Now()),
		HistoryItemType: aws.String("HistoryItemType"),
		MaxRecords:      aws.Int64(1),
		NextToken:       aws.String("NextToken"),
		StartDate:       aws.Time(time.Now()),
	}
	resp, err := svc.DescribeAlarmHistory(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See DescribeAlarmHistory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAlarmHistory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any 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 DescribeAlarms for usage and error information.

Returned Error Codes:

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

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.DescribeAlarmsInput{
		ActionPrefix:    aws.String("ActionPrefix"),
		AlarmNamePrefix: aws.String("AlarmNamePrefix"),
		AlarmNames: []*string{
			aws.String("AlarmName"), // Required
			// More values...
		},
		MaxRecords: aws.Int64(1),
		NextToken:  aws.String("NextToken"),
		StateValue: aws.String("StateValue"),
	}
	resp, err := svc.DescribeAlarms(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatch) DescribeAlarmsForMetric 

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

DescribeAlarmsForMetric API operation for Amazon CloudWatch.

Retrieves the alarms for the specified metric. Specify a statistic, period, or unit to filter the 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 DescribeAlarmsForMetric for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.DescribeAlarmsForMetricInput{
		MetricName: aws.String("MetricName"), // Required
		Namespace:  aws.String("Namespace"),  // Required
		Dimensions: []*cloudwatch.Dimension{
			{ // Required
				Name:  aws.String("DimensionName"),  // Required
				Value: aws.String("DimensionValue"), // Required
			},
			// More values...
		},
		ExtendedStatistic: aws.String("ExtendedStatistic"),
		Period:            aws.Int64(1),
		Statistic:         aws.String("Statistic"),
		Unit:              aws.String("StandardUnit"),
	}
	resp, err := svc.DescribeAlarmsForMetric(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DescribeAlarmsForMetric for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAlarmsForMetric method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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 *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 can be used to capture response data after the request's "Send" method is called.

See DescribeAlarms for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAlarms method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.DisableAlarmActionsInput{
		AlarmNames: []*string{ // Required
			aws.String("AlarmName"), // Required
			// More values...
		},
	}
	resp, err := svc.DisableAlarmActions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See DisableAlarmActions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisableAlarmActions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.EnableAlarmActionsInput{
		AlarmNames: []*string{ // Required
			aws.String("AlarmName"), // Required
			// More values...
		},
	}
	resp, err := svc.EnableAlarmActions(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See EnableAlarmActions for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EnableAlarmActions method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) GetMetricStatistics 

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

GetMetricStatistics API operation for Amazon CloudWatch.

Gets statistics for the specified metric.

Amazon CloudWatch retains metric data as follows:

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

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

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon 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. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.

Amazon 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, Amazon 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 cannot retrieve percentile statistics for this data unless one of the following conditions is true:

  • The SampleCount of the statistic set is 1

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

For a list of metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference (http://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 that cannot be used together were used together.

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

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

Example 
package main

import (
	"fmt"
	"time"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.GetMetricStatisticsInput{
		EndTime:    aws.Time(time.Now()),     // Required
		MetricName: aws.String("MetricName"), // Required
		Namespace:  aws.String("Namespace"),  // Required
		Period:     aws.Int64(1),             // Required
		StartTime:  aws.Time(time.Now()),     // Required
		Dimensions: []*cloudwatch.Dimension{
			{ // Required
				Name:  aws.String("DimensionName"),  // Required
				Value: aws.String("DimensionValue"), // Required
			},
			// More values...
		},
		ExtendedStatistics: []*string{
			aws.String("ExtendedStatistic"), // Required
			// More values...
		},
		Statistics: []*string{
			aws.String("Statistic"), // Required
			// More values...
		},
		Unit: aws.String("StandardUnit"),
	}
	resp, err := svc.GetMetricStatistics(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetMetricStatistics for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetMetricStatistics method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) 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 GetMetricStatistics 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 fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.

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.

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.ListMetricsInput{
		Dimensions: []*cloudwatch.DimensionFilter{
			{ // Required
				Name:  aws.String("DimensionName"), // Required
				Value: aws.String("DimensionValue"),
			},
			// More values...
		},
		MetricName: aws.String("MetricName"),
		Namespace:  aws.String("Namespace"),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.ListMetrics(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListMetrics for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListMetrics method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) 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. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its state is set appropriately. Any actions associated with the 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 AWS Identity and Access Management (IAM) user, you must have Amazon EC2 permissions for some operations:

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions won't be performed. However, if you are later granted the required permissions, the alarm actions that you created earlier will be performed.

If you are using an IAM role (for example, an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.

Note that you must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or an API.

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.

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.PutMetricAlarmInput{
		AlarmName:          aws.String("AlarmName"),          // Required
		ComparisonOperator: aws.String("ComparisonOperator"), // Required
		EvaluationPeriods:  aws.Int64(1),                     // Required
		MetricName:         aws.String("MetricName"),         // Required
		Namespace:          aws.String("Namespace"),          // Required
		Period:             aws.Int64(1),                     // Required
		Threshold:          aws.Float64(1.0),                 // Required
		ActionsEnabled:     aws.Bool(true),
		AlarmActions: []*string{
			aws.String("ResourceName"), // Required
			// More values...
		},
		AlarmDescription: aws.String("AlarmDescription"),
		Dimensions: []*cloudwatch.Dimension{
			{ // Required
				Name:  aws.String("DimensionName"),  // Required
				Value: aws.String("DimensionValue"), // Required
			},
			// More values...
		},
		EvaluateLowSampleCountPercentile: aws.String("EvaluateLowSampleCountPercentile"),
		ExtendedStatistic:                aws.String("ExtendedStatistic"),
		InsufficientDataActions: []*string{
			aws.String("ResourceName"), // Required
			// More values...
		},
		OKActions: []*string{
			aws.String("ResourceName"), // Required
			// More values...
		},
		Statistic:        aws.String("Statistic"),
		TreatMissingData: aws.String("TreatMissingData"),
		Unit:             aws.String("StandardUnit"),
	}
	resp, err := svc.PutMetricAlarm(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See PutMetricAlarm for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMetricAlarm method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests.

Although the Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information on specifying dimensions, see Publishing Metrics (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.

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

  • The SampleCount of the statistic set is 1

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

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 that cannot be used together were used together.

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

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

Example 
package main

import (
	"fmt"
	"time"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.PutMetricDataInput{
		MetricData: []*cloudwatch.MetricDatum{ // Required
			{ // Required
				MetricName: aws.String("MetricName"), // Required
				Dimensions: []*cloudwatch.Dimension{
					{ // Required
						Name:  aws.String("DimensionName"),  // Required
						Value: aws.String("DimensionValue"), // Required
					},
					// More values...
				},
				StatisticValues: &cloudwatch.StatisticSet{
					Maximum:     aws.Float64(1.0), // Required
					Minimum:     aws.Float64(1.0), // Required
					SampleCount: aws.Float64(1.0), // Required
					Sum:         aws.Float64(1.0), // Required
				},
				Timestamp: aws.Time(time.Now()),
				Unit:      aws.String("StandardUnit"),
				Value:     aws.Float64(1.0),
			},
			// More values...
		},
		Namespace: aws.String("Namespace"), // Required
	}
	resp, err := svc.PutMetricData(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See PutMetricData for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutMetricData method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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.

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 Amazon SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens very quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

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.

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

Example 
package main

import (
	"fmt"

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

func main() {
	sess := session.Must(session.NewSession())

	svc := cloudwatch.New(sess)

	params := &cloudwatch.SetAlarmStateInput{
		AlarmName:       aws.String("AlarmName"),   // Required
		StateReason:     aws.String("StateReason"), // Required
		StateValue:      aws.String("StateValue"),  // Required
		StateReasonData: aws.String("StateReasonData"),
	}
	resp, err := svc.SetAlarmState(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

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 can be used to capture response data after the request's "Send" method is called.

See SetAlarmState for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetAlarmState method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

Please also see 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) 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 meet 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.

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" timestampFormat:"iso8601"`

	// The standard unit for the data point.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

Encapsulates the statistical data that Amazon CloudWatch computes from metric data. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Datapoint

func (Datapoint) GoString added in v0.6.5 

func (s Datapoint) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarmsInput

func (DeleteAlarmsInput) GoString added in v0.6.5 

func (s DeleteAlarmsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarmsOutput

func (DeleteAlarmsOutput) GoString added in v0.6.5 

func (s DeleteAlarmsOutput) GoString() string

GoString returns the string representation

func (DeleteAlarmsOutput) String added in v0.6.5 

func (s DeleteAlarmsOutput) String() string

String returns the string representation

type DescribeAlarmHistoryInput 

type DescribeAlarmHistoryInput struct {

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

	// The ending date to retrieve alarm history.
	EndDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`

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

	// The starting date to retrieve alarm history.
	StartDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryInput

func (DescribeAlarmHistoryInput) GoString added in v0.6.5 

func (s DescribeAlarmHistoryInput) GoString() string

GoString returns the string representation

func (*DescribeAlarmHistoryInput) SetAlarmName added in v1.5.0 

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

SetAlarmName sets the AlarmName 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) 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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryOutput

func (DescribeAlarmHistoryOutput) GoString added in v0.6.5 

func (s DescribeAlarmHistoryOutput) GoString() string

GoString returns the string representation

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

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:"60" 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetricInput

func (DescribeAlarmsForMetricInput) GoString added in v0.6.5 

func (s DescribeAlarmsForMetricInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetricOutput

func (DescribeAlarmsForMetricOutput) GoString added in v0.6.5 

func (s DescribeAlarmsForMetricOutput) GoString() string

GoString returns the string representation

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

type DescribeAlarmsInput 

type DescribeAlarmsInput struct {

	// The action name prefix.
	ActionPrefix *string `min:"1" type:"string"`

	// The alarm name prefix. You cannot specify AlarmNames if this parameter is
	// specified.
	AlarmNamePrefix *string `min:"1" type:"string"`

	// The names of the alarms.
	AlarmNames []*string `type:"list"`

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

	// The state value to be used in matching alarms.
	StateValue *string `type:"string" enum:"StateValue"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsInput

func (DescribeAlarmsInput) GoString added in v0.6.5 

func (s DescribeAlarmsInput) GoString() string

GoString returns the string representation

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

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 for the specified alarms.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsOutput

func (DescribeAlarmsOutput) GoString added in v0.6.5 

func (s DescribeAlarmsOutput) GoString() string

GoString returns the string representation

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

type Dimension 

type Dimension struct {

	// The name of the dimension.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The value representing the dimension measurement.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Expands the identity of a metric. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension

func (Dimension) GoString added in v0.6.5 

func (s Dimension) GoString() string

GoString returns the string representation

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

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DimensionFilter

func (DimensionFilter) GoString added in v0.6.5 

func (s DimensionFilter) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActionsInput

func (DisableAlarmActionsInput) GoString added in v0.6.5 

func (s DisableAlarmActionsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActionsOutput

func (DisableAlarmActionsOutput) GoString added in v0.6.5 

func (s DisableAlarmActionsOutput) GoString() string

GoString returns the string representation

func (DisableAlarmActionsOutput) String added in v0.6.5 

func (s DisableAlarmActionsOutput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActionsInput

func (EnableAlarmActionsInput) GoString added in v0.6.5 

func (s EnableAlarmActionsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActionsOutput

func (EnableAlarmActionsOutput) GoString added in v0.6.5 

func (s EnableAlarmActionsOutput) GoString() string

GoString returns the string representation

func (EnableAlarmActionsOutput) String added in v0.6.5 

func (s EnableAlarmActionsOutput) String() string

String returns the string representation

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. You can't retrieve statistics using combinations
	// of dimensions that were not specially published. You must specify the same
	// dimensions that were used when the metrics were created. For an example,
	// see Dimension Combinations (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations)
	// in the Amazon CloudWatch User Guide. For more information on specifying dimensions,
	// see Publishing Metrics (http://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 will include data points up to
	// the specified time stamp. 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" timestampFormat:"iso8601" required:"true"`

	// The percentile statistics. Specify values between p0.0 and p100.
	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. A period can be
	// as short as one minute (60 seconds) and must be a multiple of 60. The default
	// value is 60.
	//
	// If the StartTime parameter specifies a time stamp that is greater than 15
	// days ago, you must specify the period as follows or no data points in that
	// time range is returned:
	//
	//    * 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:"60" type:"integer" required:"true"`

	// The time stamp that determines the first data point to return. Note that
	// 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. 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.
	//
	// StartTime is a required field
	StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The metric statistics, other than percentile. For percentile statistics,
	// use ExtendedStatistic.
	Statistics []*string `min:"1" type:"list"`

	// The unit for a given metric. Metrics may be reported in multiple units. Not
	// supplying a unit results in all units being returned. If the metric only
	// ever reports one unit, specifying a unit has no effect.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsInput

func (GetMetricStatisticsInput) GoString added in v0.6.5 

func (s GetMetricStatisticsInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsOutput

func (GetMetricStatisticsOutput) GoString added in v0.6.5 

func (s GetMetricStatisticsOutput) GoString() string

GoString returns the string representation

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

type ListMetricsInput 

type ListMetricsInput struct {

	// The dimensions to filter against.
	Dimensions []*DimensionFilter `type:"list"`

	// The name of the metric to filter against.
	MetricName *string `min:"1" type:"string"`

	// The namespace to filter against.
	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"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput

func (ListMetricsInput) GoString added in v0.6.5 

func (s ListMetricsInput) GoString() string

GoString returns the string representation

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) String added in v0.6.5 

func (s ListMetricsInput) String() string

String returns the string representation

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsOutput

func (ListMetricsOutput) GoString added in v0.6.5 

func (s ListMetricsOutput) GoString() string

GoString returns the string representation

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

type Metric 

type Metric struct {

	// The dimensions for the metric.
	Dimensions []*Dimension `type:"list"`

	// The name of the metric.
	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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Metric

func (Metric) GoString added in v0.6.5 

func (s Metric) GoString() string

GoString returns the string representation

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

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" timestampFormat:"iso8601"`

	// 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 dimensions for the metric associated with the alarm.
	Dimensions []*Dimension `type:"list"`

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

	// 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:"60" 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" timestampFormat:"iso8601"`

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

	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
}

Represents an alarm. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm

func (MetricAlarm) GoString added in v0.6.5 

func (s MetricAlarm) GoString() string

GoString returns the string representation

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

type MetricDatum 

type MetricDatum struct {

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

	// 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" timestampFormat:"iso8601"`

	// The unit of the metric.
	Unit *string `type:"string" enum:"StandardUnit"`

	// The value for the metric.
	//
	// Although the parameter accepts numbers of type Double, Amazon CloudWatch
	// rejects values that are either too small or too large. Values must be in
	// the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360
	// (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity)
	// are not supported.
	Value *float64 `type:"double"`
	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDatum

func (MetricDatum) GoString added in v0.6.5 

func (s MetricDatum) GoString() string

GoString returns the string representation

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) 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) String added in v0.6.5 

func (s MetricDatum) String() string

String returns the string representation

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 PutMetricAlarmInput 

type PutMetricAlarmInput 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).
	//
	// Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate
	// | arn:aws:automate:region:ec2:recover
	//
	// Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0
	// | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0
	// | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/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 AWS account.
	//
	// 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.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperator"`

	// The dimensions for the metric associated with the alarm.
	Dimensions []*Dimension `type:"list"`

	// Used only for alarms based on percentiles. If you specify ignore, the alarm
	// state will not change during periods with too few data points to be statistically
	// significant. If you specify evaluate or omit this parameter, the alarm will
	// always be evaluated and possibly change state no matter how many data points
	// are available. For more information, see Percentile-Based CloudWatch Alarms
	// and Low Data Samples (http://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.
	//
	// EvaluationPeriods is a required field
	EvaluationPeriods *int64 `min:"1" type:"integer" required:"true"`

	// 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).
	//
	// Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate
	// | arn:aws:automate:region:ec2:recover
	//
	// Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0
	// | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0
	// | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
	InsufficientDataActions []*string `type:"list"`

	// The name for the metric associated with the alarm.
	//
	// MetricName is a required field
	MetricName *string `min:"1" type:"string" required:"true"`

	// The namespace for the metric associated with the alarm.
	//
	// Namespace is a required field
	Namespace *string `min:"1" type:"string" required:"true"`

	// 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
	//
	// Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0
	// | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0
	// | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
	OKActions []*string `type:"list"`

	// The period, in seconds, over which the specified statistic is applied.
	//
	// Period is a required field
	Period *int64 `min:"60" type:"integer" required:"true"`

	// 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 against which the specified statistic is compared.
	//
	// Threshold is a required field
	Threshold *float64 `type:"double" required:"true"`

	// 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 (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).
	//
	// Valid Values: breaching | notBreaching | ignore | missing
	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 specify a unit, you must use a unit that is appropriate for the metric.
	// Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT
	// DATA state.
	Unit *string `type:"string" enum:"StandardUnit"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmInput

func (PutMetricAlarmInput) GoString added in v0.6.5 

func (s PutMetricAlarmInput) GoString() string

GoString returns the string representation

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) 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) 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) SetThreshold added in v1.5.0 

func (s *PutMetricAlarmInput) SetThreshold(v float64) *PutMetricAlarmInput

SetThreshold sets the Threshold 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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmOutput

func (PutMetricAlarmOutput) GoString added in v0.6.5 

func (s PutMetricAlarmOutput) GoString() string

GoString returns the string representation

func (PutMetricAlarmOutput) String added in v0.6.5 

func (s PutMetricAlarmOutput) String() string

String returns the string representation

type PutMetricDataInput 

type PutMetricDataInput struct {

	// The data for the metric.
	//
	// MetricData is a required field
	MetricData []*MetricDatum `type:"list" required:"true"`

	// The namespace for the metric data.
	//
	// You cannot specify a namespace that begins with "AWS/". Namespaces that begin
	// with "AWS/" are reserved for use by Amazon Web Services products.
	//
	// Namespace is a required field
	Namespace *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricDataInput

func (PutMetricDataInput) GoString added in v0.6.5 

func (s PutMetricDataInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricDataOutput

func (PutMetricDataOutput) GoString added in v0.6.5 

func (s PutMetricDataOutput) GoString() string

GoString returns the string representation

func (PutMetricDataOutput) String added in v0.6.5 

func (s PutMetricDataOutput) String() string

String returns the string representation

type SetAlarmStateInput 

type SetAlarmStateInput struct {

	// The name for the alarm. This name must be unique within the AWS account.
	// The maximum length is 255 characters.
	//
	// 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.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmStateInput

func (SetAlarmStateInput) GoString added in v0.6.5 

func (s SetAlarmStateInput) GoString() string

GoString returns the string representation

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

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmStateOutput

func (SetAlarmStateOutput) GoString added in v0.6.5 

func (s SetAlarmStateOutput) GoString() string

GoString returns the string representation

func (SetAlarmStateOutput) String added in v0.6.5 

func (s SetAlarmStateOutput) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StatisticSet

func (StatisticSet) GoString added in v0.6.5 

func (s StatisticSet) GoString() string

GoString returns the string representation

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

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.

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.