Documentation ¶
Overview ¶
Package cloudwatch provides the client and types for making API requests to Amazon CloudWatch.
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 change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.
In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.
See https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01 for more information on this service.
See cloudwatch package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatch/
Using the Client ¶
To contact Amazon CloudWatch with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon CloudWatch client CloudWatch for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatch/#New
Index ¶
- Constants
- type AlarmHistoryItem
- func (s AlarmHistoryItem) GoString() string
- func (s *AlarmHistoryItem) SetAlarmName(v string) *AlarmHistoryItem
- func (s *AlarmHistoryItem) SetHistoryData(v string) *AlarmHistoryItem
- func (s *AlarmHistoryItem) SetHistoryItemType(v string) *AlarmHistoryItem
- func (s *AlarmHistoryItem) SetHistorySummary(v string) *AlarmHistoryItem
- func (s *AlarmHistoryItem) SetTimestamp(v time.Time) *AlarmHistoryItem
- func (s AlarmHistoryItem) String() string
- type CloudWatch
- func (c *CloudWatch) DeleteAlarms(input *DeleteAlarmsInput) (*DeleteAlarmsOutput, error)
- func (c *CloudWatch) DeleteAlarmsRequest(input *DeleteAlarmsInput) (req *request.Request, output *DeleteAlarmsOutput)
- func (c *CloudWatch) DeleteAlarmsWithContext(ctx aws.Context, input *DeleteAlarmsInput, opts ...request.Option) (*DeleteAlarmsOutput, error)
- func (c *CloudWatch) DeleteDashboards(input *DeleteDashboardsInput) (*DeleteDashboardsOutput, error)
- func (c *CloudWatch) DeleteDashboardsRequest(input *DeleteDashboardsInput) (req *request.Request, output *DeleteDashboardsOutput)
- func (c *CloudWatch) DeleteDashboardsWithContext(ctx aws.Context, input *DeleteDashboardsInput, opts ...request.Option) (*DeleteDashboardsOutput, error)
- func (c *CloudWatch) DescribeAlarmHistory(input *DescribeAlarmHistoryInput) (*DescribeAlarmHistoryOutput, error)
- func (c *CloudWatch) DescribeAlarmHistoryPages(input *DescribeAlarmHistoryInput, ...) error
- func (c *CloudWatch) DescribeAlarmHistoryPagesWithContext(ctx aws.Context, input *DescribeAlarmHistoryInput, ...) error
- func (c *CloudWatch) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInput) (req *request.Request, output *DescribeAlarmHistoryOutput)
- func (c *CloudWatch) DescribeAlarmHistoryWithContext(ctx aws.Context, input *DescribeAlarmHistoryInput, opts ...request.Option) (*DescribeAlarmHistoryOutput, error)
- func (c *CloudWatch) DescribeAlarms(input *DescribeAlarmsInput) (*DescribeAlarmsOutput, error)
- func (c *CloudWatch) DescribeAlarmsForMetric(input *DescribeAlarmsForMetricInput) (*DescribeAlarmsForMetricOutput, error)
- func (c *CloudWatch) DescribeAlarmsForMetricRequest(input *DescribeAlarmsForMetricInput) (req *request.Request, output *DescribeAlarmsForMetricOutput)
- func (c *CloudWatch) DescribeAlarmsForMetricWithContext(ctx aws.Context, input *DescribeAlarmsForMetricInput, opts ...request.Option) (*DescribeAlarmsForMetricOutput, error)
- func (c *CloudWatch) DescribeAlarmsPages(input *DescribeAlarmsInput, fn func(*DescribeAlarmsOutput, bool) bool) error
- func (c *CloudWatch) DescribeAlarmsPagesWithContext(ctx aws.Context, input *DescribeAlarmsInput, ...) error
- func (c *CloudWatch) DescribeAlarmsRequest(input *DescribeAlarmsInput) (req *request.Request, output *DescribeAlarmsOutput)
- func (c *CloudWatch) DescribeAlarmsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.Option) (*DescribeAlarmsOutput, error)
- func (c *CloudWatch) DisableAlarmActions(input *DisableAlarmActionsInput) (*DisableAlarmActionsOutput, error)
- func (c *CloudWatch) DisableAlarmActionsRequest(input *DisableAlarmActionsInput) (req *request.Request, output *DisableAlarmActionsOutput)
- func (c *CloudWatch) DisableAlarmActionsWithContext(ctx aws.Context, input *DisableAlarmActionsInput, opts ...request.Option) (*DisableAlarmActionsOutput, error)
- func (c *CloudWatch) EnableAlarmActions(input *EnableAlarmActionsInput) (*EnableAlarmActionsOutput, error)
- func (c *CloudWatch) EnableAlarmActionsRequest(input *EnableAlarmActionsInput) (req *request.Request, output *EnableAlarmActionsOutput)
- func (c *CloudWatch) EnableAlarmActionsWithContext(ctx aws.Context, input *EnableAlarmActionsInput, opts ...request.Option) (*EnableAlarmActionsOutput, error)
- func (c *CloudWatch) GetDashboard(input *GetDashboardInput) (*GetDashboardOutput, error)
- func (c *CloudWatch) GetDashboardRequest(input *GetDashboardInput) (req *request.Request, output *GetDashboardOutput)
- func (c *CloudWatch) GetDashboardWithContext(ctx aws.Context, input *GetDashboardInput, opts ...request.Option) (*GetDashboardOutput, error)
- func (c *CloudWatch) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error)
- func (c *CloudWatch) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput)
- func (c *CloudWatch) GetMetricDataWithContext(ctx aws.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error)
- func (c *CloudWatch) GetMetricStatistics(input *GetMetricStatisticsInput) (*GetMetricStatisticsOutput, error)
- func (c *CloudWatch) GetMetricStatisticsRequest(input *GetMetricStatisticsInput) (req *request.Request, output *GetMetricStatisticsOutput)
- func (c *CloudWatch) GetMetricStatisticsWithContext(ctx aws.Context, input *GetMetricStatisticsInput, opts ...request.Option) (*GetMetricStatisticsOutput, error)
- func (c *CloudWatch) GetMetricWidgetImage(input *GetMetricWidgetImageInput) (*GetMetricWidgetImageOutput, error)
- func (c *CloudWatch) GetMetricWidgetImageRequest(input *GetMetricWidgetImageInput) (req *request.Request, output *GetMetricWidgetImageOutput)
- func (c *CloudWatch) GetMetricWidgetImageWithContext(ctx aws.Context, input *GetMetricWidgetImageInput, opts ...request.Option) (*GetMetricWidgetImageOutput, error)
- func (c *CloudWatch) ListDashboards(input *ListDashboardsInput) (*ListDashboardsOutput, error)
- func (c *CloudWatch) ListDashboardsRequest(input *ListDashboardsInput) (req *request.Request, output *ListDashboardsOutput)
- func (c *CloudWatch) ListDashboardsWithContext(ctx aws.Context, input *ListDashboardsInput, opts ...request.Option) (*ListDashboardsOutput, error)
- func (c *CloudWatch) ListMetrics(input *ListMetricsInput) (*ListMetricsOutput, error)
- func (c *CloudWatch) ListMetricsPages(input *ListMetricsInput, fn func(*ListMetricsOutput, bool) bool) error
- func (c *CloudWatch) ListMetricsPagesWithContext(ctx aws.Context, input *ListMetricsInput, ...) error
- func (c *CloudWatch) ListMetricsRequest(input *ListMetricsInput) (req *request.Request, output *ListMetricsOutput)
- func (c *CloudWatch) ListMetricsWithContext(ctx aws.Context, input *ListMetricsInput, opts ...request.Option) (*ListMetricsOutput, error)
- func (c *CloudWatch) PutDashboard(input *PutDashboardInput) (*PutDashboardOutput, error)
- func (c *CloudWatch) PutDashboardRequest(input *PutDashboardInput) (req *request.Request, output *PutDashboardOutput)
- func (c *CloudWatch) PutDashboardWithContext(ctx aws.Context, input *PutDashboardInput, opts ...request.Option) (*PutDashboardOutput, error)
- func (c *CloudWatch) PutMetricAlarm(input *PutMetricAlarmInput) (*PutMetricAlarmOutput, error)
- func (c *CloudWatch) PutMetricAlarmRequest(input *PutMetricAlarmInput) (req *request.Request, output *PutMetricAlarmOutput)
- func (c *CloudWatch) PutMetricAlarmWithContext(ctx aws.Context, input *PutMetricAlarmInput, opts ...request.Option) (*PutMetricAlarmOutput, error)
- func (c *CloudWatch) PutMetricData(input *PutMetricDataInput) (*PutMetricDataOutput, error)
- func (c *CloudWatch) PutMetricDataRequest(input *PutMetricDataInput) (req *request.Request, output *PutMetricDataOutput)
- func (c *CloudWatch) PutMetricDataWithContext(ctx aws.Context, input *PutMetricDataInput, opts ...request.Option) (*PutMetricDataOutput, error)
- func (c *CloudWatch) SetAlarmState(input *SetAlarmStateInput) (*SetAlarmStateOutput, error)
- func (c *CloudWatch) SetAlarmStateRequest(input *SetAlarmStateInput) (req *request.Request, output *SetAlarmStateOutput)
- func (c *CloudWatch) SetAlarmStateWithContext(ctx aws.Context, input *SetAlarmStateInput, opts ...request.Option) (*SetAlarmStateOutput, error)
- func (c *CloudWatch) WaitUntilAlarmExists(input *DescribeAlarmsInput) error
- func (c *CloudWatch) WaitUntilAlarmExistsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.WaiterOption) error
- type DashboardEntry
- func (s DashboardEntry) GoString() string
- func (s *DashboardEntry) SetDashboardArn(v string) *DashboardEntry
- func (s *DashboardEntry) SetDashboardName(v string) *DashboardEntry
- func (s *DashboardEntry) SetLastModified(v time.Time) *DashboardEntry
- func (s *DashboardEntry) SetSize(v int64) *DashboardEntry
- func (s DashboardEntry) String() string
- type DashboardValidationMessage
- type Datapoint
- func (s Datapoint) GoString() string
- func (s *Datapoint) SetAverage(v float64) *Datapoint
- func (s *Datapoint) SetExtendedStatistics(v map[string]*float64) *Datapoint
- func (s *Datapoint) SetMaximum(v float64) *Datapoint
- func (s *Datapoint) SetMinimum(v float64) *Datapoint
- func (s *Datapoint) SetSampleCount(v float64) *Datapoint
- func (s *Datapoint) SetSum(v float64) *Datapoint
- func (s *Datapoint) SetTimestamp(v time.Time) *Datapoint
- func (s *Datapoint) SetUnit(v string) *Datapoint
- func (s Datapoint) String() string
- type DeleteAlarmsInput
- type DeleteAlarmsOutput
- type DeleteDashboardsInput
- type DeleteDashboardsOutput
- type DescribeAlarmHistoryInput
- func (s DescribeAlarmHistoryInput) GoString() string
- func (s *DescribeAlarmHistoryInput) SetAlarmName(v string) *DescribeAlarmHistoryInput
- func (s *DescribeAlarmHistoryInput) SetEndDate(v time.Time) *DescribeAlarmHistoryInput
- func (s *DescribeAlarmHistoryInput) SetHistoryItemType(v string) *DescribeAlarmHistoryInput
- func (s *DescribeAlarmHistoryInput) SetMaxRecords(v int64) *DescribeAlarmHistoryInput
- func (s *DescribeAlarmHistoryInput) SetNextToken(v string) *DescribeAlarmHistoryInput
- func (s *DescribeAlarmHistoryInput) SetStartDate(v time.Time) *DescribeAlarmHistoryInput
- func (s DescribeAlarmHistoryInput) String() string
- func (s *DescribeAlarmHistoryInput) Validate() error
- type DescribeAlarmHistoryOutput
- func (s DescribeAlarmHistoryOutput) GoString() string
- func (s *DescribeAlarmHistoryOutput) SetAlarmHistoryItems(v []*AlarmHistoryItem) *DescribeAlarmHistoryOutput
- func (s *DescribeAlarmHistoryOutput) SetNextToken(v string) *DescribeAlarmHistoryOutput
- func (s DescribeAlarmHistoryOutput) String() string
- type DescribeAlarmsForMetricInput
- func (s DescribeAlarmsForMetricInput) GoString() string
- func (s *DescribeAlarmsForMetricInput) SetDimensions(v []*Dimension) *DescribeAlarmsForMetricInput
- func (s *DescribeAlarmsForMetricInput) SetExtendedStatistic(v string) *DescribeAlarmsForMetricInput
- func (s *DescribeAlarmsForMetricInput) SetMetricName(v string) *DescribeAlarmsForMetricInput
- func (s *DescribeAlarmsForMetricInput) SetNamespace(v string) *DescribeAlarmsForMetricInput
- func (s *DescribeAlarmsForMetricInput) SetPeriod(v int64) *DescribeAlarmsForMetricInput
- func (s *DescribeAlarmsForMetricInput) SetStatistic(v string) *DescribeAlarmsForMetricInput
- func (s *DescribeAlarmsForMetricInput) SetUnit(v string) *DescribeAlarmsForMetricInput
- func (s DescribeAlarmsForMetricInput) String() string
- func (s *DescribeAlarmsForMetricInput) Validate() error
- type DescribeAlarmsForMetricOutput
- type DescribeAlarmsInput
- func (s DescribeAlarmsInput) GoString() string
- func (s *DescribeAlarmsInput) SetActionPrefix(v string) *DescribeAlarmsInput
- func (s *DescribeAlarmsInput) SetAlarmNamePrefix(v string) *DescribeAlarmsInput
- func (s *DescribeAlarmsInput) SetAlarmNames(v []*string) *DescribeAlarmsInput
- func (s *DescribeAlarmsInput) SetMaxRecords(v int64) *DescribeAlarmsInput
- func (s *DescribeAlarmsInput) SetNextToken(v string) *DescribeAlarmsInput
- func (s *DescribeAlarmsInput) SetStateValue(v string) *DescribeAlarmsInput
- func (s DescribeAlarmsInput) String() string
- func (s *DescribeAlarmsInput) Validate() error
- type DescribeAlarmsOutput
- type Dimension
- type DimensionFilter
- type DisableAlarmActionsInput
- type DisableAlarmActionsOutput
- type EnableAlarmActionsInput
- type EnableAlarmActionsOutput
- type GetDashboardInput
- type GetDashboardOutput
- func (s GetDashboardOutput) GoString() string
- func (s *GetDashboardOutput) SetDashboardArn(v string) *GetDashboardOutput
- func (s *GetDashboardOutput) SetDashboardBody(v string) *GetDashboardOutput
- func (s *GetDashboardOutput) SetDashboardName(v string) *GetDashboardOutput
- func (s GetDashboardOutput) String() string
- type GetMetricDataInput
- func (s GetMetricDataInput) GoString() string
- func (s *GetMetricDataInput) SetEndTime(v time.Time) *GetMetricDataInput
- func (s *GetMetricDataInput) SetMaxDatapoints(v int64) *GetMetricDataInput
- func (s *GetMetricDataInput) SetMetricDataQueries(v []*MetricDataQuery) *GetMetricDataInput
- func (s *GetMetricDataInput) SetNextToken(v string) *GetMetricDataInput
- func (s *GetMetricDataInput) SetScanBy(v string) *GetMetricDataInput
- func (s *GetMetricDataInput) SetStartTime(v time.Time) *GetMetricDataInput
- func (s GetMetricDataInput) String() string
- func (s *GetMetricDataInput) Validate() error
- type GetMetricDataOutput
- type GetMetricStatisticsInput
- func (s GetMetricStatisticsInput) GoString() string
- func (s *GetMetricStatisticsInput) SetDimensions(v []*Dimension) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetEndTime(v time.Time) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetExtendedStatistics(v []*string) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetMetricName(v string) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetNamespace(v string) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetPeriod(v int64) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetStartTime(v time.Time) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetStatistics(v []*string) *GetMetricStatisticsInput
- func (s *GetMetricStatisticsInput) SetUnit(v string) *GetMetricStatisticsInput
- func (s GetMetricStatisticsInput) String() string
- func (s *GetMetricStatisticsInput) Validate() error
- type GetMetricStatisticsOutput
- type GetMetricWidgetImageInput
- func (s GetMetricWidgetImageInput) GoString() string
- func (s *GetMetricWidgetImageInput) SetMetricWidget(v string) *GetMetricWidgetImageInput
- func (s *GetMetricWidgetImageInput) SetOutputFormat(v string) *GetMetricWidgetImageInput
- func (s GetMetricWidgetImageInput) String() string
- func (s *GetMetricWidgetImageInput) Validate() error
- type GetMetricWidgetImageOutput
- type ListDashboardsInput
- type ListDashboardsOutput
- type ListMetricsInput
- func (s ListMetricsInput) GoString() string
- func (s *ListMetricsInput) SetDimensions(v []*DimensionFilter) *ListMetricsInput
- func (s *ListMetricsInput) SetMetricName(v string) *ListMetricsInput
- func (s *ListMetricsInput) SetNamespace(v string) *ListMetricsInput
- func (s *ListMetricsInput) SetNextToken(v string) *ListMetricsInput
- func (s ListMetricsInput) String() string
- func (s *ListMetricsInput) Validate() error
- type ListMetricsOutput
- type MessageData
- type Metric
- type MetricAlarm
- func (s MetricAlarm) GoString() string
- func (s *MetricAlarm) SetActionsEnabled(v bool) *MetricAlarm
- func (s *MetricAlarm) SetAlarmActions(v []*string) *MetricAlarm
- func (s *MetricAlarm) SetAlarmArn(v string) *MetricAlarm
- func (s *MetricAlarm) SetAlarmConfigurationUpdatedTimestamp(v time.Time) *MetricAlarm
- func (s *MetricAlarm) SetAlarmDescription(v string) *MetricAlarm
- func (s *MetricAlarm) SetAlarmName(v string) *MetricAlarm
- func (s *MetricAlarm) SetComparisonOperator(v string) *MetricAlarm
- func (s *MetricAlarm) SetDatapointsToAlarm(v int64) *MetricAlarm
- func (s *MetricAlarm) SetDimensions(v []*Dimension) *MetricAlarm
- func (s *MetricAlarm) SetEvaluateLowSampleCountPercentile(v string) *MetricAlarm
- func (s *MetricAlarm) SetEvaluationPeriods(v int64) *MetricAlarm
- func (s *MetricAlarm) SetExtendedStatistic(v string) *MetricAlarm
- func (s *MetricAlarm) SetInsufficientDataActions(v []*string) *MetricAlarm
- func (s *MetricAlarm) SetMetricName(v string) *MetricAlarm
- func (s *MetricAlarm) SetNamespace(v string) *MetricAlarm
- func (s *MetricAlarm) SetOKActions(v []*string) *MetricAlarm
- func (s *MetricAlarm) SetPeriod(v int64) *MetricAlarm
- func (s *MetricAlarm) SetStateReason(v string) *MetricAlarm
- func (s *MetricAlarm) SetStateReasonData(v string) *MetricAlarm
- func (s *MetricAlarm) SetStateUpdatedTimestamp(v time.Time) *MetricAlarm
- func (s *MetricAlarm) SetStateValue(v string) *MetricAlarm
- func (s *MetricAlarm) SetStatistic(v string) *MetricAlarm
- func (s *MetricAlarm) SetThreshold(v float64) *MetricAlarm
- func (s *MetricAlarm) SetTreatMissingData(v string) *MetricAlarm
- func (s *MetricAlarm) SetUnit(v string) *MetricAlarm
- func (s MetricAlarm) String() string
- type MetricDataQuery
- func (s MetricDataQuery) GoString() string
- func (s *MetricDataQuery) SetExpression(v string) *MetricDataQuery
- func (s *MetricDataQuery) SetId(v string) *MetricDataQuery
- func (s *MetricDataQuery) SetLabel(v string) *MetricDataQuery
- func (s *MetricDataQuery) SetMetricStat(v *MetricStat) *MetricDataQuery
- func (s *MetricDataQuery) SetReturnData(v bool) *MetricDataQuery
- func (s MetricDataQuery) String() string
- func (s *MetricDataQuery) Validate() error
- type MetricDataResult
- func (s MetricDataResult) GoString() string
- func (s *MetricDataResult) SetId(v string) *MetricDataResult
- func (s *MetricDataResult) SetLabel(v string) *MetricDataResult
- func (s *MetricDataResult) SetMessages(v []*MessageData) *MetricDataResult
- func (s *MetricDataResult) SetStatusCode(v string) *MetricDataResult
- func (s *MetricDataResult) SetTimestamps(v []*time.Time) *MetricDataResult
- func (s *MetricDataResult) SetValues(v []*float64) *MetricDataResult
- func (s MetricDataResult) String() string
- type MetricDatum
- func (s MetricDatum) GoString() string
- func (s *MetricDatum) SetCounts(v []*float64) *MetricDatum
- func (s *MetricDatum) SetDimensions(v []*Dimension) *MetricDatum
- func (s *MetricDatum) SetMetricName(v string) *MetricDatum
- func (s *MetricDatum) SetStatisticValues(v *StatisticSet) *MetricDatum
- func (s *MetricDatum) SetStorageResolution(v int64) *MetricDatum
- func (s *MetricDatum) SetTimestamp(v time.Time) *MetricDatum
- func (s *MetricDatum) SetUnit(v string) *MetricDatum
- func (s *MetricDatum) SetValue(v float64) *MetricDatum
- func (s *MetricDatum) SetValues(v []*float64) *MetricDatum
- func (s MetricDatum) String() string
- func (s *MetricDatum) Validate() error
- type MetricStat
- func (s MetricStat) GoString() string
- func (s *MetricStat) SetMetric(v *Metric) *MetricStat
- func (s *MetricStat) SetPeriod(v int64) *MetricStat
- func (s *MetricStat) SetStat(v string) *MetricStat
- func (s *MetricStat) SetUnit(v string) *MetricStat
- func (s MetricStat) String() string
- func (s *MetricStat) Validate() error
- type PutDashboardInput
- type PutDashboardOutput
- type PutMetricAlarmInput
- func (s PutMetricAlarmInput) GoString() string
- func (s *PutMetricAlarmInput) SetActionsEnabled(v bool) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetAlarmActions(v []*string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetAlarmDescription(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetAlarmName(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetComparisonOperator(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetDatapointsToAlarm(v int64) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetDimensions(v []*Dimension) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetEvaluateLowSampleCountPercentile(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetEvaluationPeriods(v int64) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetExtendedStatistic(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetInsufficientDataActions(v []*string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetMetricName(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetNamespace(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetOKActions(v []*string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetPeriod(v int64) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetStatistic(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetThreshold(v float64) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetTreatMissingData(v string) *PutMetricAlarmInput
- func (s *PutMetricAlarmInput) SetUnit(v string) *PutMetricAlarmInput
- func (s PutMetricAlarmInput) String() string
- func (s *PutMetricAlarmInput) Validate() error
- type PutMetricAlarmOutput
- type PutMetricDataInput
- type PutMetricDataOutput
- type SetAlarmStateInput
- func (s SetAlarmStateInput) GoString() string
- func (s *SetAlarmStateInput) SetAlarmName(v string) *SetAlarmStateInput
- func (s *SetAlarmStateInput) SetStateReason(v string) *SetAlarmStateInput
- func (s *SetAlarmStateInput) SetStateReasonData(v string) *SetAlarmStateInput
- func (s *SetAlarmStateInput) SetStateValue(v string) *SetAlarmStateInput
- func (s SetAlarmStateInput) String() string
- func (s *SetAlarmStateInput) Validate() error
- type SetAlarmStateOutput
- type StatisticSet
- func (s StatisticSet) GoString() string
- func (s *StatisticSet) SetMaximum(v float64) *StatisticSet
- func (s *StatisticSet) SetMinimum(v float64) *StatisticSet
- func (s *StatisticSet) SetSampleCount(v float64) *StatisticSet
- func (s *StatisticSet) SetSum(v float64) *StatisticSet
- func (s StatisticSet) String() string
- func (s *StatisticSet) Validate() error
Constants ¶
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" )
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" )
const ( // ScanByTimestampDescending is a ScanBy enum value ScanByTimestampDescending = "TimestampDescending" // ScanByTimestampAscending is a ScanBy enum value ScanByTimestampAscending = "TimestampAscending" )
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" )
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" )
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" )
const ( // StatusCodeComplete is a StatusCode enum value StatusCodeComplete = "Complete" // StatusCodeInternalError is a StatusCode enum value StatusCodeInternalError = "InternalError" // StatusCodePartialData is a StatusCode enum value StatusCodePartialData = "PartialData" )
const ( // ErrCodeDashboardInvalidInputError for service response error code // "InvalidParameterInput". // // Some part of the dashboard data is invalid. ErrCodeDashboardInvalidInputError = "InvalidParameterInput" // ErrCodeDashboardNotFoundError for service response error code // "ResourceNotFound". // // The specified dashboard does not exist. ErrCodeDashboardNotFoundError = "ResourceNotFound" // ErrCodeInternalServiceFault for service response error code // "InternalServiceError". // // Request processing has failed due to some unknown error, exception, or failure. ErrCodeInternalServiceFault = "InternalServiceError" // ErrCodeInvalidFormatFault for service response error code // "InvalidFormat". // // Data was not syntactically valid JSON. ErrCodeInvalidFormatFault = "InvalidFormat" // ErrCodeInvalidNextToken for service response error code // "InvalidNextToken". // // The next token specified is invalid. ErrCodeInvalidNextToken = "InvalidNextToken" // ErrCodeInvalidParameterCombinationException for service response error code // "InvalidParameterCombination". // // Parameters were used together that cannot be used together. ErrCodeInvalidParameterCombinationException = "InvalidParameterCombination" // ErrCodeInvalidParameterValueException for service response error code // "InvalidParameterValue". // // The value of an input parameter is bad or out-of-range. ErrCodeInvalidParameterValueException = "InvalidParameterValue" // 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" )
const ( ServiceName = "monitoring" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "CloudWatch" // ServiceID is a unique identifer of a specific service. )
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"` // contains filtered or unexported fields }
Represents the history of a specific alarm.
func (AlarmHistoryItem) GoString ¶ added in v0.6.5
func (s AlarmHistoryItem) GoString() string
GoString returns the string representation
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 ¶
CloudWatch provides the API operation methods for making requests to Amazon CloudWatch. See this package's package overview docs for details on the service.
CloudWatch methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudWatch
New creates a new instance of the CloudWatch client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarms
func (*CloudWatch) DeleteAlarmsRequest ¶
func (c *CloudWatch) DeleteAlarmsRequest(input *DeleteAlarmsInput) (req *request.Request, output *DeleteAlarmsOutput)
DeleteAlarmsRequest generates a "aws/request.Request" representing the client's request for the DeleteAlarms operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteAlarms for more information on using the DeleteAlarms API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteAlarmsRequest method. req, resp := client.DeleteAlarmsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarms
func (*CloudWatch) DeleteAlarmsWithContext ¶ added in v1.8.0
func (c *CloudWatch) DeleteAlarmsWithContext(ctx aws.Context, input *DeleteAlarmsInput, opts ...request.Option) (*DeleteAlarmsOutput, error)
DeleteAlarmsWithContext is the same as DeleteAlarms with the addition of the ability to pass a context and additional request options.
See DeleteAlarms for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) DeleteDashboards ¶ added in v1.10.7
func (c *CloudWatch) DeleteDashboards(input *DeleteDashboardsInput) (*DeleteDashboardsOutput, error)
DeleteDashboards API operation for Amazon CloudWatch.
Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation DeleteDashboards for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.
ErrCodeDashboardNotFoundError "ResourceNotFound" The specified dashboard does not exist.
ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboards
func (*CloudWatch) DeleteDashboardsRequest ¶ added in v1.10.7
func (c *CloudWatch) DeleteDashboardsRequest(input *DeleteDashboardsInput) (req *request.Request, output *DeleteDashboardsOutput)
DeleteDashboardsRequest generates a "aws/request.Request" representing the client's request for the DeleteDashboards operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDashboards for more information on using the DeleteDashboards API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteDashboardsRequest method. req, resp := client.DeleteDashboardsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboards
func (*CloudWatch) DeleteDashboardsWithContext ¶ added in v1.10.7
func (c *CloudWatch) DeleteDashboardsWithContext(ctx aws.Context, input *DeleteDashboardsInput, opts ...request.Option) (*DeleteDashboardsOutput, error)
DeleteDashboardsWithContext is the same as DeleteDashboards with the addition of the ability to pass a context and additional request options.
See DeleteDashboards for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) 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.
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.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistory
func (*CloudWatch) DescribeAlarmHistoryPages ¶
func (c *CloudWatch) DescribeAlarmHistoryPages(input *DescribeAlarmHistoryInput, fn func(*DescribeAlarmHistoryOutput, bool) bool) error
DescribeAlarmHistoryPages iterates over the pages of a DescribeAlarmHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeAlarmHistory method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeAlarmHistory operation. pageNum := 0 err := client.DescribeAlarmHistoryPages(params, func(page *DescribeAlarmHistoryOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudWatch) DescribeAlarmHistoryPagesWithContext ¶ added in v1.8.0
func (c *CloudWatch) DescribeAlarmHistoryPagesWithContext(ctx aws.Context, input *DescribeAlarmHistoryInput, fn func(*DescribeAlarmHistoryOutput, bool) bool, opts ...request.Option) error
DescribeAlarmHistoryPagesWithContext same as DescribeAlarmHistoryPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) DescribeAlarmHistoryRequest ¶
func (c *CloudWatch) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInput) (req *request.Request, output *DescribeAlarmHistoryOutput)
DescribeAlarmHistoryRequest generates a "aws/request.Request" representing the client's request for the DescribeAlarmHistory operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAlarmHistory for more information on using the DescribeAlarmHistory API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAlarmHistoryRequest method. req, resp := client.DescribeAlarmHistoryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistory
func (*CloudWatch) DescribeAlarmHistoryWithContext ¶ added in v1.8.0
func (c *CloudWatch) DescribeAlarmHistoryWithContext(ctx aws.Context, input *DescribeAlarmHistoryInput, opts ...request.Option) (*DescribeAlarmHistoryOutput, error)
DescribeAlarmHistoryWithContext is the same as DescribeAlarmHistory with the addition of the ability to pass a context and additional request options.
See DescribeAlarmHistory for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) DescribeAlarms ¶
func (c *CloudWatch) DescribeAlarms(input *DescribeAlarmsInput) (*DescribeAlarmsOutput, error)
DescribeAlarms API operation for Amazon CloudWatch.
Retrieves the specified alarms. 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms
func (*CloudWatch) DescribeAlarmsForMetric ¶
func (c *CloudWatch) DescribeAlarmsForMetric(input *DescribeAlarmsForMetricInput) (*DescribeAlarmsForMetricOutput, error)
DescribeAlarmsForMetric API operation for Amazon CloudWatch.
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation DescribeAlarmsForMetric for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric
func (*CloudWatch) DescribeAlarmsForMetricRequest ¶
func (c *CloudWatch) DescribeAlarmsForMetricRequest(input *DescribeAlarmsForMetricInput) (req *request.Request, output *DescribeAlarmsForMetricOutput)
DescribeAlarmsForMetricRequest generates a "aws/request.Request" representing the client's request for the DescribeAlarmsForMetric operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAlarmsForMetric for more information on using the DescribeAlarmsForMetric API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAlarmsForMetricRequest method. req, resp := client.DescribeAlarmsForMetricRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric
func (*CloudWatch) DescribeAlarmsForMetricWithContext ¶ added in v1.8.0
func (c *CloudWatch) DescribeAlarmsForMetricWithContext(ctx aws.Context, input *DescribeAlarmsForMetricInput, opts ...request.Option) (*DescribeAlarmsForMetricOutput, error)
DescribeAlarmsForMetricWithContext is the same as DescribeAlarmsForMetric with the addition of the ability to pass a context and additional request options.
See DescribeAlarmsForMetric for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) DescribeAlarmsPages ¶
func (c *CloudWatch) DescribeAlarmsPages(input *DescribeAlarmsInput, fn func(*DescribeAlarmsOutput, bool) bool) error
DescribeAlarmsPages iterates over the pages of a DescribeAlarms operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeAlarms method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeAlarms operation. pageNum := 0 err := client.DescribeAlarmsPages(params, func(page *DescribeAlarmsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudWatch) DescribeAlarmsPagesWithContext ¶ added in v1.8.0
func (c *CloudWatch) DescribeAlarmsPagesWithContext(ctx aws.Context, input *DescribeAlarmsInput, fn func(*DescribeAlarmsOutput, bool) bool, opts ...request.Option) error
DescribeAlarmsPagesWithContext same as DescribeAlarmsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) DescribeAlarmsRequest ¶
func (c *CloudWatch) DescribeAlarmsRequest(input *DescribeAlarmsInput) (req *request.Request, output *DescribeAlarmsOutput)
DescribeAlarmsRequest generates a "aws/request.Request" representing the client's request for the DescribeAlarms operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAlarms for more information on using the DescribeAlarms API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAlarmsRequest method. req, resp := client.DescribeAlarmsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms
func (*CloudWatch) DescribeAlarmsWithContext ¶ added in v1.8.0
func (c *CloudWatch) DescribeAlarmsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.Option) (*DescribeAlarmsOutput, error)
DescribeAlarmsWithContext is the same as DescribeAlarms with the addition of the ability to pass a context and additional request options.
See DescribeAlarms for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) DisableAlarmActions ¶
func (c *CloudWatch) DisableAlarmActions(input *DisableAlarmActionsInput) (*DisableAlarmActionsOutput, error)
DisableAlarmActions API operation for Amazon CloudWatch.
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation DisableAlarmActions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions
func (*CloudWatch) DisableAlarmActionsRequest ¶
func (c *CloudWatch) DisableAlarmActionsRequest(input *DisableAlarmActionsInput) (req *request.Request, output *DisableAlarmActionsOutput)
DisableAlarmActionsRequest generates a "aws/request.Request" representing the client's request for the DisableAlarmActions operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DisableAlarmActions for more information on using the DisableAlarmActions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DisableAlarmActionsRequest method. req, resp := client.DisableAlarmActionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions
func (*CloudWatch) DisableAlarmActionsWithContext ¶ added in v1.8.0
func (c *CloudWatch) DisableAlarmActionsWithContext(ctx aws.Context, input *DisableAlarmActionsInput, opts ...request.Option) (*DisableAlarmActionsOutput, error)
DisableAlarmActionsWithContext is the same as DisableAlarmActions with the addition of the ability to pass a context and additional request options.
See DisableAlarmActions for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) EnableAlarmActions ¶
func (c *CloudWatch) EnableAlarmActions(input *EnableAlarmActionsInput) (*EnableAlarmActionsOutput, error)
EnableAlarmActions API operation for Amazon CloudWatch.
Enables the actions for the specified alarms.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation EnableAlarmActions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions
func (*CloudWatch) EnableAlarmActionsRequest ¶
func (c *CloudWatch) EnableAlarmActionsRequest(input *EnableAlarmActionsInput) (req *request.Request, output *EnableAlarmActionsOutput)
EnableAlarmActionsRequest generates a "aws/request.Request" representing the client's request for the EnableAlarmActions operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See EnableAlarmActions for more information on using the EnableAlarmActions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the EnableAlarmActionsRequest method. req, resp := client.EnableAlarmActionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions
func (*CloudWatch) EnableAlarmActionsWithContext ¶ added in v1.8.0
func (c *CloudWatch) EnableAlarmActionsWithContext(ctx aws.Context, input *EnableAlarmActionsInput, opts ...request.Option) (*EnableAlarmActionsOutput, error)
EnableAlarmActionsWithContext is the same as EnableAlarmActions with the addition of the ability to pass a context and additional request options.
See EnableAlarmActions for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) GetDashboard ¶ added in v1.10.7
func (c *CloudWatch) GetDashboard(input *GetDashboardInput) (*GetDashboardOutput, error)
GetDashboard API operation for Amazon CloudWatch.
Displays the details of the dashboard that you specify.
To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation GetDashboard for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.
ErrCodeDashboardNotFoundError "ResourceNotFound" The specified dashboard does not exist.
ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboard
func (*CloudWatch) GetDashboardRequest ¶ added in v1.10.7
func (c *CloudWatch) GetDashboardRequest(input *GetDashboardInput) (req *request.Request, output *GetDashboardOutput)
GetDashboardRequest generates a "aws/request.Request" representing the client's request for the GetDashboard operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetDashboard for more information on using the GetDashboard API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetDashboardRequest method. req, resp := client.GetDashboardRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboard
func (*CloudWatch) GetDashboardWithContext ¶ added in v1.10.7
func (c *CloudWatch) GetDashboardWithContext(ctx aws.Context, input *GetDashboardInput, opts ...request.Option) (*GetDashboardOutput, error)
GetDashboardWithContext is the same as GetDashboard with the addition of the ability to pass a context and additional request options.
See GetDashboard for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) GetMetricData ¶ added in v1.13.28
func (c *CloudWatch) GetMetricData(input *GetMetricDataInput) (*GetMetricDataOutput, error)
GetMetricData API operation for Amazon CloudWatch.
You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide.
Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation GetMetricData for usage and error information.
Returned Error Codes:
- ErrCodeInvalidNextToken "InvalidNextToken" The next token specified is invalid.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricData
func (*CloudWatch) GetMetricDataRequest ¶ added in v1.13.28
func (c *CloudWatch) GetMetricDataRequest(input *GetMetricDataInput) (req *request.Request, output *GetMetricDataOutput)
GetMetricDataRequest generates a "aws/request.Request" representing the client's request for the GetMetricData operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetMetricData for more information on using the GetMetricData API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetMetricDataRequest method. req, resp := client.GetMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricData
func (*CloudWatch) GetMetricDataWithContext ¶ added in v1.13.28
func (c *CloudWatch) GetMetricDataWithContext(ctx aws.Context, input *GetMetricDataInput, opts ...request.Option) (*GetMetricDataOutput, error)
GetMetricDataWithContext is the same as GetMetricData with the addition of the ability to pass a context and additional request options.
See GetMetricData for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) GetMetricStatistics ¶
func (c *CloudWatch) GetMetricStatistics(input *GetMetricStatisticsInput) (*GetMetricStatisticsOutput, error)
GetMetricStatistics API operation for Amazon CloudWatch.
Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1.
The Min and the Max values of the statistic set are equal.
Percentile statistics are not available for metrics when any of the metric values are negative numbers.
Amazon CloudWatch retains metric data as follows:
Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.
Data points with a period of 60 seconds (1-minute) are available for 15 days.
Data points with a period of 300 seconds (5-minute) are available for 63 days.
Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by 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 were used together that cannot be used together.
ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatistics
func (*CloudWatch) GetMetricStatisticsRequest ¶
func (c *CloudWatch) GetMetricStatisticsRequest(input *GetMetricStatisticsInput) (req *request.Request, output *GetMetricStatisticsOutput)
GetMetricStatisticsRequest generates a "aws/request.Request" representing the client's request for the GetMetricStatistics operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetMetricStatistics for more information on using the GetMetricStatistics API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetMetricStatisticsRequest method. req, resp := client.GetMetricStatisticsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatistics
func (*CloudWatch) GetMetricStatisticsWithContext ¶ added in v1.8.0
func (c *CloudWatch) GetMetricStatisticsWithContext(ctx aws.Context, input *GetMetricStatisticsInput, opts ...request.Option) (*GetMetricStatisticsOutput, error)
GetMetricStatisticsWithContext is the same as GetMetricStatistics with the addition of the ability to pass a context and additional request options.
See GetMetricStatistics for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) GetMetricWidgetImage ¶ added in v1.15.38
func (c *CloudWatch) GetMetricWidgetImage(input *GetMetricWidgetImageInput) (*GetMetricWidgetImageOutput, error)
GetMetricWidgetImage API operation for Amazon CloudWatch.
You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.
The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.
There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:
As many as 100 metrics in the graph.
Up to 100 KB uncompressed payload.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation GetMetricWidgetImage for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImage
func (*CloudWatch) GetMetricWidgetImageRequest ¶ added in v1.15.38
func (c *CloudWatch) GetMetricWidgetImageRequest(input *GetMetricWidgetImageInput) (req *request.Request, output *GetMetricWidgetImageOutput)
GetMetricWidgetImageRequest generates a "aws/request.Request" representing the client's request for the GetMetricWidgetImage operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetMetricWidgetImage for more information on using the GetMetricWidgetImage API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetMetricWidgetImageRequest method. req, resp := client.GetMetricWidgetImageRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricWidgetImage
func (*CloudWatch) GetMetricWidgetImageWithContext ¶ added in v1.15.38
func (c *CloudWatch) GetMetricWidgetImageWithContext(ctx aws.Context, input *GetMetricWidgetImageInput, opts ...request.Option) (*GetMetricWidgetImageOutput, error)
GetMetricWidgetImageWithContext is the same as GetMetricWidgetImage with the addition of the ability to pass a context and additional request options.
See GetMetricWidgetImage for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) ListDashboards ¶ added in v1.10.7
func (c *CloudWatch) ListDashboards(input *ListDashboardsInput) (*ListDashboardsOutput, error)
ListDashboards API operation for Amazon CloudWatch.
Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation ListDashboards for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.
ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboards
func (*CloudWatch) ListDashboardsRequest ¶ added in v1.10.7
func (c *CloudWatch) ListDashboardsRequest(input *ListDashboardsInput) (req *request.Request, output *ListDashboardsOutput)
ListDashboardsRequest generates a "aws/request.Request" representing the client's request for the ListDashboards operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListDashboards for more information on using the ListDashboards API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListDashboardsRequest method. req, resp := client.ListDashboardsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboards
func (*CloudWatch) ListDashboardsWithContext ¶ added in v1.10.7
func (c *CloudWatch) ListDashboardsWithContext(ctx aws.Context, input *ListDashboardsInput, opts ...request.Option) (*ListDashboardsOutput, error)
ListDashboardsWithContext is the same as ListDashboards with the addition of the ability to pass a context and additional request options.
See ListDashboards for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) ListMetrics ¶
func (c *CloudWatch) ListMetrics(input *ListMetricsInput) (*ListMetricsOutput, error)
ListMetrics API operation for Amazon CloudWatch.
List the specified metrics. You can use the returned metrics with GetMetricData or 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 GetMetricData or 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics
func (*CloudWatch) ListMetricsPages ¶
func (c *CloudWatch) ListMetricsPages(input *ListMetricsInput, fn func(*ListMetricsOutput, bool) bool) error
ListMetricsPages iterates over the pages of a ListMetrics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListMetrics method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListMetrics operation. pageNum := 0 err := client.ListMetricsPages(params, func(page *ListMetricsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudWatch) ListMetricsPagesWithContext ¶ added in v1.8.0
func (c *CloudWatch) ListMetricsPagesWithContext(ctx aws.Context, input *ListMetricsInput, fn func(*ListMetricsOutput, bool) bool, opts ...request.Option) error
ListMetricsPagesWithContext same as ListMetricsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) ListMetricsRequest ¶
func (c *CloudWatch) ListMetricsRequest(input *ListMetricsInput) (req *request.Request, output *ListMetricsOutput)
ListMetricsRequest generates a "aws/request.Request" representing the client's request for the ListMetrics operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListMetrics for more information on using the ListMetrics API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListMetricsRequest method. req, resp := client.ListMetricsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics
func (*CloudWatch) ListMetricsWithContext ¶ added in v1.8.0
func (c *CloudWatch) ListMetricsWithContext(ctx aws.Context, input *ListMetricsInput, opts ...request.Option) (*ListMetricsOutput, error)
ListMetricsWithContext is the same as ListMetrics with the addition of the ability to pass a context and additional request options.
See ListMetrics for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) PutDashboard ¶ added in v1.10.7
func (c *CloudWatch) PutDashboard(input *PutDashboardInput) (*PutDashboardOutput, error)
PutDashboard API operation for Amazon CloudWatch.
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
There is no limit to the number of dashboards in your account. All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.
When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation PutDashboard for usage and error information.
Returned Error Codes:
ErrCodeDashboardInvalidInputError "InvalidParameterInput" Some part of the dashboard data is invalid.
ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboard
func (*CloudWatch) PutDashboardRequest ¶ added in v1.10.7
func (c *CloudWatch) PutDashboardRequest(input *PutDashboardInput) (req *request.Request, output *PutDashboardOutput)
PutDashboardRequest generates a "aws/request.Request" representing the client's request for the PutDashboard operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutDashboard for more information on using the PutDashboard API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutDashboardRequest method. req, resp := client.PutDashboardRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboard
func (*CloudWatch) PutDashboardWithContext ¶ added in v1.10.7
func (c *CloudWatch) PutDashboardWithContext(ctx aws.Context, input *PutDashboardInput, opts ...request.Option) (*PutDashboardOutput, error)
PutDashboardWithContext is the same as PutDashboard with the addition of the ability to pass a context and additional request options.
See PutDashboard for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) 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 IAM user, you must have Amazon EC2 permissions for some operations:
iam:CreateServiceLinkedRole for all alarms with EC2 actions
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 are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an 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 AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information about service-linked roles, see AWS service-linked role (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation PutMetricAlarm for usage and error information.
Returned Error Codes:
- ErrCodeLimitExceededFault "LimitExceeded" The quota for alarms for this customer has already been reached.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm
func (*CloudWatch) PutMetricAlarmRequest ¶
func (c *CloudWatch) PutMetricAlarmRequest(input *PutMetricAlarmInput) (req *request.Request, output *PutMetricAlarmOutput)
PutMetricAlarmRequest generates a "aws/request.Request" representing the client's request for the PutMetricAlarm operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutMetricAlarm for more information on using the PutMetricAlarm API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutMetricAlarmRequest method. req, resp := client.PutMetricAlarmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm
func (*CloudWatch) PutMetricAlarmWithContext ¶ added in v1.8.0
func (c *CloudWatch) PutMetricAlarmWithContext(ctx aws.Context, input *PutMetricAlarmInput, opts ...request.Option) (*PutMetricAlarmOutput, error)
PutMetricAlarmWithContext is the same as PutMetricAlarm with the addition of the ability to pass a context and additional request options.
See PutMetricAlarm for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) PutMetricData ¶
func (c *CloudWatch) PutMetricData(input *PutMetricDataInput) (*PutMetricDataOutput, error)
PutMetricData API operation for Amazon CloudWatch.
Publishes metric data to Amazon CloudWatch. CloudWatch associates the data with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.
Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 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.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about 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 GetMetricData or GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. These raw data points could be published individually or as part of Values and Counts arrays. If you publish data using statistic sets in the StatisticValues field instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.
The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon CloudWatch's API operation PutMetricData for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterValueException "InvalidParameterValue" The value of an input parameter is bad or out-of-range.
ErrCodeMissingRequiredParameterException "MissingParameter" An input parameter that is required is missing.
ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" Parameters were used together that cannot be used together.
ErrCodeInternalServiceFault "InternalServiceError" Request processing has failed due to some unknown error, exception, or failure.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricData
func (*CloudWatch) PutMetricDataRequest ¶
func (c *CloudWatch) PutMetricDataRequest(input *PutMetricDataInput) (req *request.Request, output *PutMetricDataOutput)
PutMetricDataRequest generates a "aws/request.Request" representing the client's request for the PutMetricData operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutMetricData for more information on using the PutMetricData API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutMetricDataRequest method. req, resp := client.PutMetricDataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricData
func (*CloudWatch) PutMetricDataWithContext ¶ added in v1.8.0
func (c *CloudWatch) PutMetricDataWithContext(ctx aws.Context, input *PutMetricDataInput, opts ...request.Option) (*PutMetricDataOutput, error)
PutMetricDataWithContext is the same as PutMetricData with the addition of the ability to pass a context and additional request options.
See PutMetricData for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) SetAlarmState ¶
func (c *CloudWatch) SetAlarmState(input *SetAlarmStateInput) (*SetAlarmStateOutput, error)
SetAlarmState API operation for Amazon CloudWatch.
Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmState
func (*CloudWatch) SetAlarmStateRequest ¶
func (c *CloudWatch) SetAlarmStateRequest(input *SetAlarmStateInput) (req *request.Request, output *SetAlarmStateOutput)
SetAlarmStateRequest generates a "aws/request.Request" representing the client's request for the SetAlarmState operation. The "output" return value will be populated with the request's response once the request completes successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See SetAlarmState for more information on using the SetAlarmState API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the SetAlarmStateRequest method. req, resp := client.SetAlarmStateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmState
func (*CloudWatch) SetAlarmStateWithContext ¶ added in v1.8.0
func (c *CloudWatch) SetAlarmStateWithContext(ctx aws.Context, input *SetAlarmStateInput, opts ...request.Option) (*SetAlarmStateOutput, error)
SetAlarmStateWithContext is the same as SetAlarmState with the addition of the ability to pass a context and additional request options.
See SetAlarmState for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudWatch) WaitUntilAlarmExists ¶ added in v1.1.33
func (c *CloudWatch) WaitUntilAlarmExists(input *DescribeAlarmsInput) error
WaitUntilAlarmExists uses the CloudWatch API operation DescribeAlarms to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
func (*CloudWatch) WaitUntilAlarmExistsWithContext ¶ added in v1.8.0
func (c *CloudWatch) WaitUntilAlarmExistsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...request.WaiterOption) error
WaitUntilAlarmExistsWithContext is an extended version of WaitUntilAlarmExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type DashboardEntry ¶ added in v1.10.7
type DashboardEntry struct { // The Amazon Resource Name (ARN) of the dashboard. DashboardArn *string `type:"string"` // The name of the dashboard. DashboardName *string `type:"string"` // The time stamp of when the dashboard was last modified, either by an API // call or through the console. This number is expressed as the number of milliseconds // since Jan 1, 1970 00:00:00 UTC. LastModified *time.Time `type:"timestamp"` // The size of the dashboard, in bytes. Size *int64 `type:"long"` // contains filtered or unexported fields }
Represents a specific dashboard.
func (DashboardEntry) GoString ¶ added in v1.10.7
func (s DashboardEntry) GoString() string
GoString returns the string representation
func (*DashboardEntry) SetDashboardArn ¶ added in v1.10.7
func (s *DashboardEntry) SetDashboardArn(v string) *DashboardEntry
SetDashboardArn sets the DashboardArn field's value.
func (*DashboardEntry) SetDashboardName ¶ added in v1.10.7
func (s *DashboardEntry) SetDashboardName(v string) *DashboardEntry
SetDashboardName sets the DashboardName field's value.
func (*DashboardEntry) SetLastModified ¶ added in v1.10.7
func (s *DashboardEntry) SetLastModified(v time.Time) *DashboardEntry
SetLastModified sets the LastModified field's value.
func (*DashboardEntry) SetSize ¶ added in v1.10.7
func (s *DashboardEntry) SetSize(v int64) *DashboardEntry
SetSize sets the Size field's value.
func (DashboardEntry) String ¶ added in v1.10.7
func (s DashboardEntry) String() string
String returns the string representation
type DashboardValidationMessage ¶ added in v1.10.7
type DashboardValidationMessage struct { // The data path related to the message. DataPath *string `type:"string"` // A message describing the error or warning. Message *string `type:"string"` // contains filtered or unexported fields }
An error or warning for the operation.
func (DashboardValidationMessage) GoString ¶ added in v1.10.7
func (s DashboardValidationMessage) GoString() string
GoString returns the string representation
func (*DashboardValidationMessage) SetDataPath ¶ added in v1.10.7
func (s *DashboardValidationMessage) SetDataPath(v string) *DashboardValidationMessage
SetDataPath sets the DataPath field's value.
func (*DashboardValidationMessage) SetMessage ¶ added in v1.10.7
func (s *DashboardValidationMessage) SetMessage(v string) *DashboardValidationMessage
SetMessage sets the Message field's value.
func (DashboardValidationMessage) String ¶ added in v1.10.7
func (s DashboardValidationMessage) String() string
String returns the string representation
type Datapoint ¶
type Datapoint struct { // The average of the metric values that correspond to the data point. Average *float64 `type:"double"` // The percentile statistic for the data point. ExtendedStatistics map[string]*float64 `type:"map"` // The maximum metric value for the data point. Maximum *float64 `type:"double"` // The minimum metric value for the data point. Minimum *float64 `type:"double"` // The number of metric values that contributed to the aggregate value of this // data point. SampleCount *float64 `type:"double"` // The sum of the metric values for the data point. Sum *float64 `type:"double"` // The time stamp used for the data point. Timestamp *time.Time `type:"timestamp"` // The standard unit for the data point. Unit *string `type:"string" enum:"StandardUnit"` // contains filtered or unexported fields }
Encapsulates the statistical data that CloudWatch computes from metric data.
func (*Datapoint) SetAverage ¶ added in v1.5.0
SetAverage sets the Average field's value.
func (*Datapoint) SetExtendedStatistics ¶ added in v1.5.7
SetExtendedStatistics sets the ExtendedStatistics field's value.
func (*Datapoint) SetMaximum ¶ added in v1.5.0
SetMaximum sets the Maximum field's value.
func (*Datapoint) SetMinimum ¶ added in v1.5.0
SetMinimum sets the Minimum field's value.
func (*Datapoint) SetSampleCount ¶ added in v1.5.0
SetSampleCount sets the SampleCount field's value.
func (*Datapoint) SetTimestamp ¶ added in v1.5.0
SetTimestamp sets the Timestamp field's value.
type DeleteAlarmsInput ¶
type DeleteAlarmsInput struct { // The alarms to be deleted. // // AlarmNames is a required field AlarmNames []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (DeleteAlarmsInput) GoString ¶ added in v0.6.5
func (s DeleteAlarmsInput) GoString() string
GoString returns the string representation
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
}
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 DeleteDashboardsInput ¶ added in v1.10.7
type DeleteDashboardsInput struct { // The dashboards to be deleted. This parameter is required. // // DashboardNames is a required field DashboardNames []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (DeleteDashboardsInput) GoString ¶ added in v1.10.7
func (s DeleteDashboardsInput) GoString() string
GoString returns the string representation
func (*DeleteDashboardsInput) SetDashboardNames ¶ added in v1.10.7
func (s *DeleteDashboardsInput) SetDashboardNames(v []*string) *DeleteDashboardsInput
SetDashboardNames sets the DashboardNames field's value.
func (DeleteDashboardsInput) String ¶ added in v1.10.7
func (s DeleteDashboardsInput) String() string
String returns the string representation
func (*DeleteDashboardsInput) Validate ¶ added in v1.12.44
func (s *DeleteDashboardsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDashboardsOutput ¶ added in v1.10.7
type DeleteDashboardsOutput struct {
// contains filtered or unexported fields
}
func (DeleteDashboardsOutput) GoString ¶ added in v1.10.7
func (s DeleteDashboardsOutput) GoString() string
GoString returns the string representation
func (DeleteDashboardsOutput) String ¶ added in v1.10.7
func (s DeleteDashboardsOutput) 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"` // 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"` // contains filtered or unexported fields }
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 }
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:"1" type:"integer"` // The statistic for the metric, other than percentiles. For percentile statistics, // use ExtendedStatistics. Statistic *string `type:"string" enum:"Statistic"` // The unit for the metric. Unit *string `type:"string" enum:"StandardUnit"` // contains filtered or unexported fields }
func (DescribeAlarmsForMetricInput) GoString ¶ added in v0.6.5
func (s DescribeAlarmsForMetricInput) GoString() string
GoString returns the string representation
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 }
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. If this parameter is specified, you cannot specify // AlarmNames. 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 }
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 }
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.
type DimensionFilter ¶
type DimensionFilter struct { // The dimension name to be matched. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The value of the dimension to be matched. Value *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents filters for a dimension.
func (DimensionFilter) GoString ¶ added in v0.6.5
func (s DimensionFilter) GoString() string
GoString returns the string representation
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 }
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
}
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 }
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
}
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 GetDashboardInput ¶ added in v1.10.7
type GetDashboardInput struct { // The name of the dashboard to be described. // // DashboardName is a required field DashboardName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (GetDashboardInput) GoString ¶ added in v1.10.7
func (s GetDashboardInput) GoString() string
GoString returns the string representation
func (*GetDashboardInput) SetDashboardName ¶ added in v1.10.7
func (s *GetDashboardInput) SetDashboardName(v string) *GetDashboardInput
SetDashboardName sets the DashboardName field's value.
func (GetDashboardInput) String ¶ added in v1.10.7
func (s GetDashboardInput) String() string
String returns the string representation
func (*GetDashboardInput) Validate ¶ added in v1.12.44
func (s *GetDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDashboardOutput ¶ added in v1.10.7
type GetDashboardOutput struct { // The Amazon Resource Name (ARN) of the dashboard. DashboardArn *string `type:"string"` // The detailed information about the dashboard, including what widgets are // included and their location on the dashboard. For more information about // the DashboardBody syntax, see CloudWatch-Dashboard-Body-Structure. DashboardBody *string `type:"string"` // The name of the dashboard. DashboardName *string `type:"string"` // contains filtered or unexported fields }
func (GetDashboardOutput) GoString ¶ added in v1.10.7
func (s GetDashboardOutput) GoString() string
GoString returns the string representation
func (*GetDashboardOutput) SetDashboardArn ¶ added in v1.10.7
func (s *GetDashboardOutput) SetDashboardArn(v string) *GetDashboardOutput
SetDashboardArn sets the DashboardArn field's value.
func (*GetDashboardOutput) SetDashboardBody ¶ added in v1.10.7
func (s *GetDashboardOutput) SetDashboardBody(v string) *GetDashboardOutput
SetDashboardBody sets the DashboardBody field's value.
func (*GetDashboardOutput) SetDashboardName ¶ added in v1.10.7
func (s *GetDashboardOutput) SetDashboardName(v string) *GetDashboardOutput
SetDashboardName sets the DashboardName field's value.
func (GetDashboardOutput) String ¶ added in v1.10.7
func (s GetDashboardOutput) String() string
String returns the string representation
type GetMetricDataInput ¶ added in v1.13.28
type GetMetricDataInput struct { // The time stamp indicating the latest data to be returned. // // For better performance, specify StartTime and EndTime values that align with // the value of the metric's Period and sync up with the beginning and end of // an hour. For example, if the Period of a metric is 5 minutes, specifying // 12:05 or 12:30 as EndTime can get a faster response from CloudWatch then // setting 12:07 or 12:29 as the EndTime. // // EndTime is a required field EndTime *time.Time `type:"timestamp" required:"true"` // The maximum number of data points the request should return before paginating. // If you omit this, the default of 100,800 is used. MaxDatapoints *int64 `type:"integer"` // The metric queries to be returned. A single GetMetricData call can include // as many as 100 MetricDataQuery structures. Each of these structures can specify // either a metric to retrieve, or a math expression to perform on retrieved // data. // // MetricDataQueries is a required field MetricDataQueries []*MetricDataQuery `type:"list" required:"true"` // Include this value, if it was returned by the previous call, to get the next // set of data points. NextToken *string `type:"string"` // The order in which data points should be returned. TimestampDescending returns // the newest data first and paginates when the MaxDatapoints limit is reached. // TimestampAscending returns the oldest data first and paginates when the MaxDatapoints // limit is reached. ScanBy *string `type:"string" enum:"ScanBy"` // The time stamp indicating the earliest data to be returned. // // For better performance, specify StartTime and EndTime values that align with // the value of the metric's Period and sync up with the beginning and end of // an hour. For example, if the Period of a metric is 5 minutes, specifying // 12:05 or 12:30 as StartTime can get a faster response from CloudWatch then // setting 12:07 or 12:29 as the StartTime. // // StartTime is a required field StartTime *time.Time `type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (GetMetricDataInput) GoString ¶ added in v1.13.28
func (s GetMetricDataInput) GoString() string
GoString returns the string representation
func (*GetMetricDataInput) SetEndTime ¶ added in v1.13.28
func (s *GetMetricDataInput) SetEndTime(v time.Time) *GetMetricDataInput
SetEndTime sets the EndTime field's value.
func (*GetMetricDataInput) SetMaxDatapoints ¶ added in v1.13.28
func (s *GetMetricDataInput) SetMaxDatapoints(v int64) *GetMetricDataInput
SetMaxDatapoints sets the MaxDatapoints field's value.
func (*GetMetricDataInput) SetMetricDataQueries ¶ added in v1.13.28
func (s *GetMetricDataInput) SetMetricDataQueries(v []*MetricDataQuery) *GetMetricDataInput
SetMetricDataQueries sets the MetricDataQueries field's value.
func (*GetMetricDataInput) SetNextToken ¶ added in v1.13.28
func (s *GetMetricDataInput) SetNextToken(v string) *GetMetricDataInput
SetNextToken sets the NextToken field's value.
func (*GetMetricDataInput) SetScanBy ¶ added in v1.13.28
func (s *GetMetricDataInput) SetScanBy(v string) *GetMetricDataInput
SetScanBy sets the ScanBy field's value.
func (*GetMetricDataInput) SetStartTime ¶ added in v1.13.28
func (s *GetMetricDataInput) SetStartTime(v time.Time) *GetMetricDataInput
SetStartTime sets the StartTime field's value.
func (GetMetricDataInput) String ¶ added in v1.13.28
func (s GetMetricDataInput) String() string
String returns the string representation
func (*GetMetricDataInput) Validate ¶ added in v1.13.28
func (s *GetMetricDataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMetricDataOutput ¶ added in v1.13.28
type GetMetricDataOutput struct { // The metrics that are returned, including the metric name, namespace, and // dimensions. MetricDataResults []*MetricDataResult `type:"list"` // A token that marks the next batch of returned results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (GetMetricDataOutput) GoString ¶ added in v1.13.28
func (s GetMetricDataOutput) GoString() string
GoString returns the string representation
func (*GetMetricDataOutput) SetMetricDataResults ¶ added in v1.13.28
func (s *GetMetricDataOutput) SetMetricDataResults(v []*MetricDataResult) *GetMetricDataOutput
SetMetricDataResults sets the MetricDataResults field's value.
func (*GetMetricDataOutput) SetNextToken ¶ added in v1.13.28
func (s *GetMetricDataOutput) SetNextToken(v string) *GetMetricDataOutput
SetNextToken sets the NextToken field's value.
func (GetMetricDataOutput) String ¶ added in v1.13.28
func (s GetMetricDataOutput) String() string
String returns the string representation
type GetMetricStatisticsInput ¶
type GetMetricStatisticsInput struct { // The dimensions. If the metric contains multiple dimensions, you must include // a value for each dimension. CloudWatch treats each unique combination of // dimensions as a separate metric. If a specific combination of dimensions // was not published, you can't retrieve statistics for it. You must specify // the same dimensions that were used when the metrics were created. For an // example, see Dimension Combinations (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations) // in the Amazon CloudWatch User Guide. For more information about specifying // dimensions, see Publishing Metrics (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 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" required:"true"` // The percentile statistics. Specify values between p0.0 and p100. When calling // GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, // but not both. Percentile statistics are not available for metrics when any // of the metric values are negative numbers. ExtendedStatistics []*string `min:"1" type:"list"` // The name of the metric, with or without spaces. // // MetricName is a required field MetricName *string `min:"1" type:"string" required:"true"` // The namespace of the metric, with or without spaces. // // Namespace is a required field Namespace *string `min:"1" type:"string" required:"true"` // The granularity, in seconds, of the returned data points. For metrics with // regular resolution, a period can be as short as one minute (60 seconds) and // must be a multiple of 60. For high-resolution metrics that are collected // at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, // or any multiple of 60. High-resolution metrics are those metrics stored by // a PutMetricData call that includes a StorageResolution of 1 second. // // If the StartTime parameter specifies a time stamp that is greater than 3 // hours ago, you must specify the period as follows or no data points in that // time range is returned: // // * Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds // (1 minute). // // * Start time between 15 and 63 days ago - Use a multiple of 300 seconds // (5 minutes). // // * Start time greater than 63 days ago - Use a multiple of 3600 seconds // (1 hour). // // Period is a required field Period *int64 `min:"1" type:"integer" required:"true"` // The time stamp that determines the first data point to return. Start times // are evaluated relative to the time that CloudWatch receives the request. // // The value specified is inclusive; results include data points with the specified // time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z). // // CloudWatch rounds the specified time stamp as follows: // // * Start time less than 15 days ago - Round down to the nearest whole minute. // For example, 12:32:34 is rounded down to 12:32:00. // // * Start time between 15 and 63 days ago - Round down to the nearest 5-minute // clock interval. For example, 12:32:34 is rounded down to 12:30:00. // // * Start time greater than 63 days ago - Round down to the nearest 1-hour // clock interval. For example, 12:32:34 is rounded down to 12:00:00. // // If you set Period to 5, 10, or 30, the start time of your request is rounded // down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions // of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for // the previous 10-second period, the start time of your request is rounded // down and you receive data from 01:05:10 to 01:05:20. If you make a query // at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, // you receive data timestamped between 15:02:15 and 15:07:15. // // StartTime is a required field StartTime *time.Time `type:"timestamp" required:"true"` // The metric statistics, other than percentile. For percentile statistics, // use ExtendedStatistics. When calling GetMetricStatistics, you must specify // either Statistics or ExtendedStatistics, but not both. Statistics []*string `min:"1" type:"list"` // The unit for a given metric. Metrics may be reported in multiple units. Not // supplying a unit results in all units being returned. If you specify only // a unit that the metric does not report, the results of the call are null. Unit *string `type:"string" enum:"StandardUnit"` // contains filtered or unexported fields }
func (GetMetricStatisticsInput) GoString ¶ added in v0.6.5
func (s GetMetricStatisticsInput) GoString() string
GoString returns the string representation
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 }
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 GetMetricWidgetImageInput ¶ added in v1.15.38
type GetMetricWidgetImageInput struct { // A JSON string that defines the bitmap graph to be retrieved. The string includes // the metrics to include in the graph, statistics, annotations, title, axis // limits, and so on. You can include only one MetricWidget parameter in each // GetMetricWidgetImage call. // // For more information about the syntax of MetricWidget see CloudWatch-Metric-Widget-Structure. // // If any metric on the graph could not load all the requested data points, // an orange triangle with an exclamation point appears next to the graph legend. // // MetricWidget is a required field MetricWidget *string `type:"string" required:"true"` // The format of the resulting image. Only PNG images are supported. // // The default is png. If you specify png, the API returns an HTTP response // with the content-type set to text/xml. The image data is in a MetricWidgetImage // field. For example: // // <GetMetricWidgetImageResponse xmlns="http://monitoring.amazonaws.com/doc/2010-08-01/"> // // <GetMetricWidgetImageResult> // // <MetricWidgetImage> // // iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip... // // </MetricWidgetImage> // // </GetMetricWidgetImageResult> // // <ResponseMetadata> // // <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId> // // </ResponseMetadata> // // </GetMetricWidgetImageResponse> // // The image/png setting is intended only for custom HTTP requests. For most // use cases, and all actions using an AWS SDK, you should use png. If you specify // image/png, the HTTP response has a content-type set to image/png, and the // body of the response is a PNG image. OutputFormat *string `type:"string"` // contains filtered or unexported fields }
func (GetMetricWidgetImageInput) GoString ¶ added in v1.15.38
func (s GetMetricWidgetImageInput) GoString() string
GoString returns the string representation
func (*GetMetricWidgetImageInput) SetMetricWidget ¶ added in v1.15.38
func (s *GetMetricWidgetImageInput) SetMetricWidget(v string) *GetMetricWidgetImageInput
SetMetricWidget sets the MetricWidget field's value.
func (*GetMetricWidgetImageInput) SetOutputFormat ¶ added in v1.15.38
func (s *GetMetricWidgetImageInput) SetOutputFormat(v string) *GetMetricWidgetImageInput
SetOutputFormat sets the OutputFormat field's value.
func (GetMetricWidgetImageInput) String ¶ added in v1.15.38
func (s GetMetricWidgetImageInput) String() string
String returns the string representation
func (*GetMetricWidgetImageInput) Validate ¶ added in v1.15.38
func (s *GetMetricWidgetImageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMetricWidgetImageOutput ¶ added in v1.15.38
type GetMetricWidgetImageOutput struct { // The image of the graph, in the output format specified. // // MetricWidgetImage is automatically base64 encoded/decoded by the SDK. MetricWidgetImage []byte `type:"blob"` // contains filtered or unexported fields }
func (GetMetricWidgetImageOutput) GoString ¶ added in v1.15.38
func (s GetMetricWidgetImageOutput) GoString() string
GoString returns the string representation
func (*GetMetricWidgetImageOutput) SetMetricWidgetImage ¶ added in v1.15.38
func (s *GetMetricWidgetImageOutput) SetMetricWidgetImage(v []byte) *GetMetricWidgetImageOutput
SetMetricWidgetImage sets the MetricWidgetImage field's value.
func (GetMetricWidgetImageOutput) String ¶ added in v1.15.38
func (s GetMetricWidgetImageOutput) String() string
String returns the string representation
type ListDashboardsInput ¶ added in v1.10.7
type ListDashboardsInput struct { // If you specify this parameter, only the dashboards with names starting with // the specified string are listed. The maximum length is 255, and valid characters // are A-Z, a-z, 0-9, ".", "-", and "_". DashboardNamePrefix *string `type:"string"` // The token returned by a previous call to indicate that there is more data // available. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListDashboardsInput) GoString ¶ added in v1.10.7
func (s ListDashboardsInput) GoString() string
GoString returns the string representation
func (*ListDashboardsInput) SetDashboardNamePrefix ¶ added in v1.10.7
func (s *ListDashboardsInput) SetDashboardNamePrefix(v string) *ListDashboardsInput
SetDashboardNamePrefix sets the DashboardNamePrefix field's value.
func (*ListDashboardsInput) SetNextToken ¶ added in v1.10.7
func (s *ListDashboardsInput) SetNextToken(v string) *ListDashboardsInput
SetNextToken sets the NextToken field's value.
func (ListDashboardsInput) String ¶ added in v1.10.7
func (s ListDashboardsInput) String() string
String returns the string representation
type ListDashboardsOutput ¶ added in v1.10.7
type ListDashboardsOutput struct { // The list of matching dashboards. DashboardEntries []*DashboardEntry `type:"list"` // The token that marks the start of the next batch of returned results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListDashboardsOutput) GoString ¶ added in v1.10.7
func (s ListDashboardsOutput) GoString() string
GoString returns the string representation
func (*ListDashboardsOutput) SetDashboardEntries ¶ added in v1.10.7
func (s *ListDashboardsOutput) SetDashboardEntries(v []*DashboardEntry) *ListDashboardsOutput
SetDashboardEntries sets the DashboardEntries field's value.
func (*ListDashboardsOutput) SetNextToken ¶ added in v1.10.7
func (s *ListDashboardsOutput) SetNextToken(v string) *ListDashboardsOutput
SetNextToken sets the NextToken field's value.
func (ListDashboardsOutput) String ¶ added in v1.10.7
func (s ListDashboardsOutput) String() string
String returns the string representation
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 }
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 }
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 MessageData ¶ added in v1.13.28
type MessageData struct { // The error code or status code associated with the message. Code *string `type:"string"` // The message text. Value *string `type:"string"` // contains filtered or unexported fields }
A message returned by the GetMetricDataAPI, including a code and a description.
func (MessageData) GoString ¶ added in v1.13.28
func (s MessageData) GoString() string
GoString returns the string representation
func (*MessageData) SetCode ¶ added in v1.13.28
func (s *MessageData) SetCode(v string) *MessageData
SetCode sets the Code field's value.
func (*MessageData) SetValue ¶ added in v1.13.28
func (s *MessageData) SetValue(v string) *MessageData
SetValue sets the Value field's value.
func (MessageData) String ¶ added in v1.13.28
func (s MessageData) String() string
String returns the string representation
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.
func (*Metric) SetDimensions ¶ added in v1.5.0
SetDimensions sets the Dimensions field's value.
func (*Metric) SetMetricName ¶ added in v1.5.0
SetMetricName sets the MetricName field's value.
func (*Metric) SetNamespace ¶ added in v1.5.0
SetNamespace sets the Namespace field's value.
type MetricAlarm ¶
type MetricAlarm struct { // Indicates whether actions should be executed during any changes to the alarm // state. ActionsEnabled *bool `type:"boolean"` // The actions to execute when this alarm transitions to the ALARM state from // any other state. Each action is specified as an Amazon Resource Name (ARN). AlarmActions []*string `type:"list"` // The Amazon Resource Name (ARN) of the alarm. AlarmArn *string `min:"1" type:"string"` // The time stamp of the last update to the alarm configuration. AlarmConfigurationUpdatedTimestamp *time.Time `type:"timestamp"` // The description of the alarm. AlarmDescription *string `type:"string"` // The name of the alarm. AlarmName *string `min:"1" type:"string"` // The arithmetic operation to use when comparing the specified statistic and // threshold. The specified statistic value is used as the first operand. ComparisonOperator *string `type:"string" enum:"ComparisonOperator"` // The number of datapoints that must be breaching to trigger the alarm. DatapointsToAlarm *int64 `min:"1" type:"integer"` // The dimensions for the metric associated with the alarm. Dimensions []*Dimension `type:"list"` // Used only for alarms based on percentiles. If ignore, the alarm state does // not change during periods with too few data points to be statistically significant. // If evaluate or this parameter is not used, the alarm is always evaluated // and possibly changes state no matter how many data points are available. EvaluateLowSampleCountPercentile *string `min:"1" type:"string"` // The number of periods over which data is compared to the specified threshold. EvaluationPeriods *int64 `min:"1" type:"integer"` // The percentile statistic for the metric associated with the alarm. Specify // a value between p0.0 and p100. ExtendedStatistic *string `type:"string"` // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource // Name (ARN). InsufficientDataActions []*string `type:"list"` // The name of the metric associated with the alarm. 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:"1" type:"integer"` // An explanation for the alarm state, in text format. StateReason *string `type:"string"` // An explanation for the alarm state, in JSON format. StateReasonData *string `type:"string"` // The time stamp of the last update to the alarm state. StateUpdatedTimestamp *time.Time `type:"timestamp"` // The state value for the alarm. StateValue *string `type:"string" enum:"StateValue"` // The statistic for the metric associated with the alarm, other than percentile. // For percentile statistics, use ExtendedStatistic. Statistic *string `type:"string" enum:"Statistic"` // The value to compare with the specified statistic. Threshold *float64 `type:"double"` // Sets how this alarm is to handle missing data points. If this parameter is // omitted, the default behavior of missing is used. TreatMissingData *string `min:"1" type:"string"` // The unit of the metric associated with the alarm. Unit *string `type:"string" enum:"StandardUnit"` // contains filtered or unexported fields }
Represents an alarm.
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) SetDatapointsToAlarm ¶ added in v1.12.44
func (s *MetricAlarm) SetDatapointsToAlarm(v int64) *MetricAlarm
SetDatapointsToAlarm sets the DatapointsToAlarm field's value.
func (*MetricAlarm) SetDimensions ¶ added in v1.5.0
func (s *MetricAlarm) SetDimensions(v []*Dimension) *MetricAlarm
SetDimensions sets the Dimensions field's value.
func (*MetricAlarm) SetEvaluateLowSampleCountPercentile ¶ added in v1.8.8
func (s *MetricAlarm) SetEvaluateLowSampleCountPercentile(v string) *MetricAlarm
SetEvaluateLowSampleCountPercentile sets the EvaluateLowSampleCountPercentile field's value.
func (*MetricAlarm) SetEvaluationPeriods ¶ added in v1.5.0
func (s *MetricAlarm) SetEvaluationPeriods(v int64) *MetricAlarm
SetEvaluationPeriods sets the EvaluationPeriods field's value.
func (*MetricAlarm) SetExtendedStatistic ¶ added in v1.5.7
func (s *MetricAlarm) SetExtendedStatistic(v string) *MetricAlarm
SetExtendedStatistic sets the ExtendedStatistic field's value.
func (*MetricAlarm) SetInsufficientDataActions ¶ added in v1.5.0
func (s *MetricAlarm) SetInsufficientDataActions(v []*string) *MetricAlarm
SetInsufficientDataActions sets the InsufficientDataActions field's value.
func (*MetricAlarm) SetMetricName ¶ added in v1.5.0
func (s *MetricAlarm) SetMetricName(v string) *MetricAlarm
SetMetricName sets the MetricName field's value.
func (*MetricAlarm) 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 MetricDataQuery ¶ added in v1.13.28
type MetricDataQuery struct { // The math expression to be performed on the returned data, if this structure // is performing a math expression. For more information about metric math expressions, // see Metric Math Syntax and Functions (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) // in the Amazon CloudWatch User Guide. // // Within one MetricDataQuery structure, you must specify either Expression // or MetricStat but not both. Expression *string `min:"1" type:"string"` // A short name used to tie this structure to the results in the response. This // name must be unique within a single call to GetMetricData. If you are performing // math expressions on this set of data, this name represents that data and // can serve as a variable in the mathematical expression. The valid characters // are letters, numbers, and underscore. The first character must be a lowercase // letter. // // Id is a required field Id *string `min:"1" type:"string" required:"true"` // A human-readable label for this metric or expression. This is especially // useful if this is an expression, so that you know what the value represents. // If the metric or expression is shown in a CloudWatch dashboard widget, the // label is shown. If Label is omitted, CloudWatch generates a default. Label *string `type:"string"` // The metric to be returned, along with statistics, period, and units. Use // this parameter only if this structure is performing a data retrieval and // not performing a math expression on the returned data. // // Within one MetricDataQuery structure, you must specify either Expression // or MetricStat but not both. MetricStat *MetricStat `type:"structure"` // Indicates whether to return the time stamps and raw data values of this metric. // If you are performing this call just to do math expressions and do not also // need the raw data returned, you can specify False. If you omit this, the // default of True is used. ReturnData *bool `type:"boolean"` // contains filtered or unexported fields }
This structure indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 100 MetricDataQuery structures.
func (MetricDataQuery) GoString ¶ added in v1.13.28
func (s MetricDataQuery) GoString() string
GoString returns the string representation
func (*MetricDataQuery) SetExpression ¶ added in v1.13.28
func (s *MetricDataQuery) SetExpression(v string) *MetricDataQuery
SetExpression sets the Expression field's value.
func (*MetricDataQuery) SetId ¶ added in v1.13.28
func (s *MetricDataQuery) SetId(v string) *MetricDataQuery
SetId sets the Id field's value.
func (*MetricDataQuery) SetLabel ¶ added in v1.13.28
func (s *MetricDataQuery) SetLabel(v string) *MetricDataQuery
SetLabel sets the Label field's value.
func (*MetricDataQuery) SetMetricStat ¶ added in v1.13.28
func (s *MetricDataQuery) SetMetricStat(v *MetricStat) *MetricDataQuery
SetMetricStat sets the MetricStat field's value.
func (*MetricDataQuery) SetReturnData ¶ added in v1.13.28
func (s *MetricDataQuery) SetReturnData(v bool) *MetricDataQuery
SetReturnData sets the ReturnData field's value.
func (MetricDataQuery) String ¶ added in v1.13.28
func (s MetricDataQuery) String() string
String returns the string representation
func (*MetricDataQuery) Validate ¶ added in v1.13.28
func (s *MetricDataQuery) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MetricDataResult ¶ added in v1.13.28
type MetricDataResult struct { // The short name you specified to represent this metric. Id *string `min:"1" type:"string"` // The human-readable label associated with the data. Label *string `type:"string"` // A list of messages with additional information about the data returned. Messages []*MessageData `type:"list"` // The status of the returned data. Complete indicates that all data points // in the requested time range were returned. PartialData means that an incomplete // set of data points were returned. You can use the NextToken value that was // returned and repeat your request to get more data points. NextToken is not // returned if you are performing a math expression. InternalError indicates // that an error occurred. Retry your request using NextToken, if present. StatusCode *string `type:"string" enum:"StatusCode"` // The time stamps for the data points, formatted in Unix timestamp format. // The number of time stamps always matches the number of values and the value // for Timestamps[x] is Values[x]. Timestamps []*time.Time `type:"list"` // The data points for the metric corresponding to Timestamps. The number of // values always matches the number of time stamps and the time stamp for Values[x] // is Timestamps[x]. Values []*float64 `type:"list"` // contains filtered or unexported fields }
A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the time stamps of those data points and other identifying information.
func (MetricDataResult) GoString ¶ added in v1.13.28
func (s MetricDataResult) GoString() string
GoString returns the string representation
func (*MetricDataResult) SetId ¶ added in v1.13.28
func (s *MetricDataResult) SetId(v string) *MetricDataResult
SetId sets the Id field's value.
func (*MetricDataResult) SetLabel ¶ added in v1.13.28
func (s *MetricDataResult) SetLabel(v string) *MetricDataResult
SetLabel sets the Label field's value.
func (*MetricDataResult) SetMessages ¶ added in v1.13.28
func (s *MetricDataResult) SetMessages(v []*MessageData) *MetricDataResult
SetMessages sets the Messages field's value.
func (*MetricDataResult) SetStatusCode ¶ added in v1.13.28
func (s *MetricDataResult) SetStatusCode(v string) *MetricDataResult
SetStatusCode sets the StatusCode field's value.
func (*MetricDataResult) SetTimestamps ¶ added in v1.13.28
func (s *MetricDataResult) SetTimestamps(v []*time.Time) *MetricDataResult
SetTimestamps sets the Timestamps field's value.
func (*MetricDataResult) SetValues ¶ added in v1.13.28
func (s *MetricDataResult) SetValues(v []*float64) *MetricDataResult
SetValues sets the Values field's value.
func (MetricDataResult) String ¶ added in v1.13.28
func (s MetricDataResult) String() string
String returns the string representation
type MetricDatum ¶
type MetricDatum struct { // Array of numbers that is used along with the Values array. Each number in // the Count array is the number of times the corresponding value in the Values // array occurred during the period. // // If you omit the Counts array, the default of 1 is used as the value for each // count. If you include a Counts array, it must include the same amount of // values as the Values array. Counts []*float64 `type:"list"` // The dimensions associated with the metric. Dimensions []*Dimension `type:"list"` // The name of the metric. // // MetricName is a required field MetricName *string `min:"1" type:"string" required:"true"` // The statistical values for the metric. StatisticValues *StatisticSet `type:"structure"` // Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution // metric, so that CloudWatch stores the metric with sub-minute resolution down // to one second. Setting this to 60 specifies this metric as a regular-resolution // metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution // is available only for custom metrics. For more information about high-resolution // metrics, see High-Resolution Metrics (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) // in the Amazon CloudWatch User Guide. // // This field is optional, if you do not specify it the default of 60 is used. StorageResolution *int64 `min:"1" type:"integer"` // The time the metric data was received, expressed as the number of milliseconds // since Jan 1, 1970 00:00:00 UTC. Timestamp *time.Time `type:"timestamp"` // The unit of the metric. Unit *string `type:"string" enum:"StandardUnit"` // The value for the metric. // // Although the parameter accepts numbers of type Double, CloudWatch rejects // values that are either too small or too large. Values must be in the range // of 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"` // Array of numbers representing the values for the metric during the period. // Each unique value is listed just once in this array, and the corresponding // number in the Counts array specifies the number of times that value occurred // during the period. You can include up to 150 unique values in each PutMetricData // action that specifies a Values array. // // Although the Values array accepts numbers of type Double, CloudWatch rejects // values that are either too small or too large. Values must be in the range // of 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. Values []*float64 `type:"list"` // contains filtered or unexported fields }
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
func (MetricDatum) GoString ¶ added in v0.6.5
func (s MetricDatum) GoString() string
GoString returns the string representation
func (*MetricDatum) SetCounts ¶ added in v1.15.36
func (s *MetricDatum) SetCounts(v []*float64) *MetricDatum
SetCounts sets the Counts field's value.
func (*MetricDatum) SetDimensions ¶ added in v1.5.0
func (s *MetricDatum) SetDimensions(v []*Dimension) *MetricDatum
SetDimensions sets the Dimensions field's value.
func (*MetricDatum) SetMetricName ¶ added in v1.5.0
func (s *MetricDatum) SetMetricName(v string) *MetricDatum
SetMetricName sets the MetricName field's value.
func (*MetricDatum) SetStatisticValues ¶ added in v1.5.0
func (s *MetricDatum) SetStatisticValues(v *StatisticSet) *MetricDatum
SetStatisticValues sets the StatisticValues field's value.
func (*MetricDatum) SetStorageResolution ¶ added in v1.10.7
func (s *MetricDatum) SetStorageResolution(v int64) *MetricDatum
SetStorageResolution sets the StorageResolution field's value.
func (*MetricDatum) SetTimestamp ¶ added in v1.5.0
func (s *MetricDatum) SetTimestamp(v time.Time) *MetricDatum
SetTimestamp sets the Timestamp field's value.
func (*MetricDatum) SetUnit ¶ added in v1.5.0
func (s *MetricDatum) SetUnit(v string) *MetricDatum
SetUnit sets the Unit field's value.
func (*MetricDatum) SetValue ¶ added in v1.5.0
func (s *MetricDatum) SetValue(v float64) *MetricDatum
SetValue sets the Value field's value.
func (*MetricDatum) SetValues ¶ added in v1.15.36
func (s *MetricDatum) SetValues(v []*float64) *MetricDatum
SetValues sets the Values field's value.
func (MetricDatum) String ¶ added in v0.6.5
func (s MetricDatum) String() string
String returns the string representation
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 MetricStat ¶ added in v1.13.28
type MetricStat struct { // The metric to return, including the metric name, namespace, and dimensions. // // Metric is a required field Metric *Metric `type:"structure" required:"true"` // The period to use when retrieving the metric. // // Period is a required field Period *int64 `min:"1" type:"integer" required:"true"` // The statistic to return. It can include any CloudWatch statistic or extended // statistic. // // Stat is a required field Stat *string `type:"string" required:"true"` // The unit to use for the returned data points. Unit *string `type:"string" enum:"StandardUnit"` // contains filtered or unexported fields }
This structure defines the metric to be returned, along with the statistics, period, and units.
func (MetricStat) GoString ¶ added in v1.13.28
func (s MetricStat) GoString() string
GoString returns the string representation
func (*MetricStat) SetMetric ¶ added in v1.13.28
func (s *MetricStat) SetMetric(v *Metric) *MetricStat
SetMetric sets the Metric field's value.
func (*MetricStat) SetPeriod ¶ added in v1.13.28
func (s *MetricStat) SetPeriod(v int64) *MetricStat
SetPeriod sets the Period field's value.
func (*MetricStat) SetStat ¶ added in v1.13.28
func (s *MetricStat) SetStat(v string) *MetricStat
SetStat sets the Stat field's value.
func (*MetricStat) SetUnit ¶ added in v1.13.28
func (s *MetricStat) SetUnit(v string) *MetricStat
SetUnit sets the Unit field's value.
func (MetricStat) String ¶ added in v1.13.28
func (s MetricStat) String() string
String returns the string representation
func (*MetricStat) Validate ¶ added in v1.13.28
func (s *MetricStat) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutDashboardInput ¶ added in v1.10.7
type PutDashboardInput struct { // The detailed information about the dashboard in JSON format, including the // widgets to include and their location on the dashboard. This parameter is // required. // // For more information about the syntax, see CloudWatch-Dashboard-Body-Structure. // // DashboardBody is a required field DashboardBody *string `type:"string" required:"true"` // The name of the dashboard. If a dashboard with this name already exists, // this call modifies that dashboard, replacing its current contents. Otherwise, // a new dashboard is created. The maximum length is 255, and valid characters // are A-Z, a-z, 0-9, "-", and "_". This parameter is required. // // DashboardName is a required field DashboardName *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (PutDashboardInput) GoString ¶ added in v1.10.7
func (s PutDashboardInput) GoString() string
GoString returns the string representation
func (*PutDashboardInput) SetDashboardBody ¶ added in v1.10.7
func (s *PutDashboardInput) SetDashboardBody(v string) *PutDashboardInput
SetDashboardBody sets the DashboardBody field's value.
func (*PutDashboardInput) SetDashboardName ¶ added in v1.10.7
func (s *PutDashboardInput) SetDashboardName(v string) *PutDashboardInput
SetDashboardName sets the DashboardName field's value.
func (PutDashboardInput) String ¶ added in v1.10.7
func (s PutDashboardInput) String() string
String returns the string representation
func (*PutDashboardInput) Validate ¶ added in v1.12.44
func (s *PutDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutDashboardOutput ¶ added in v1.10.7
type PutDashboardOutput struct { // If the input for PutDashboard was correct and the dashboard was successfully // created or modified, this result is empty. // // If this result includes only warning messages, then the input was valid enough // for the dashboard to be created or modified, but some elements of the dashboard // may not render. // // If this result includes error messages, the input was not valid and the operation // failed. DashboardValidationMessages []*DashboardValidationMessage `type:"list"` // contains filtered or unexported fields }
func (PutDashboardOutput) GoString ¶ added in v1.10.7
func (s PutDashboardOutput) GoString() string
GoString returns the string representation
func (*PutDashboardOutput) SetDashboardValidationMessages ¶ added in v1.10.7
func (s *PutDashboardOutput) SetDashboardValidationMessages(v []*DashboardValidationMessage) *PutDashboardOutput
SetDashboardValidationMessages sets the DashboardValidationMessages field's value.
func (PutDashboardOutput) String ¶ added in v1.10.7
func (s PutDashboardOutput) String() string
String returns the string representation
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 | arn:aws:sns:region:account-id:sns-topic-name // | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 // | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 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 number of datapoints that must be breaching to trigger the alarm. This // is used only if you are setting an "M out of N" alarm. In that case, this // value is the M. For more information, see Evaluating an Alarm (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) // in the Amazon CloudWatch User Guide. DatapointsToAlarm *int64 `min:"1" type:"integer"` // The dimensions for the metric associated with the alarm. Dimensions []*Dimension `type:"list"` // Used only for alarms based on percentiles. If you specify ignore, the alarm // state does not change during periods with too few data points to be statistically // significant. If you specify evaluate or omit this parameter, the alarm is // always evaluated and possibly changes state no matter how many data points // are available. For more information, see Percentile-Based CloudWatch Alarms // and Low Data Samples (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. // If you are setting an alarm which requires that a number of consecutive data // points be breaching to trigger the alarm, this value specifies that number. // If you are setting an "M out of N" alarm, this value is the N. // // An alarm's total current evaluation period can be no longer than one day, // so this number multiplied by Period cannot be more than 86,400 seconds. // // EvaluationPeriods is a required field EvaluationPeriods *int64 `min:"1" type:"integer" required:"true"` // The percentile statistic for the metric associated with the alarm. Specify // a value between p0.0 and p100. When you call PutMetricAlarm, you must specify // either Statistic or ExtendedStatistic, but not both. ExtendedStatistic *string `type:"string"` // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA // state from any other state. Each action is specified as an Amazon Resource // Name (ARN). // // Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate // | arn:aws:automate:region:ec2:recover | arn:aws:sns:region:account-id:sns-topic-name // | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 // | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 InsufficientDataActions []*string `type:"list"` // The name for the metric associated with the alarm. // // 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 | arn:aws:sns:region:account-id:sns-topic-name // | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 // | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0 OKActions []*string `type:"list"` // The period, in seconds, over which the specified statistic is applied. Valid // values are 10, 30, and any multiple of 60. // // Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData // call with a StorageResolution of 1. If you specify a period of 10 or 30 for // a metric that does not have sub-minute resolution, the alarm still attempts // to gather data at the period rate that you specify. In this case, it does // not receive data for the attempts that do not correspond to a one-minute // data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. // Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which // has a higher charge than other alarms. For more information about pricing, // see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/). // // An alarm's total current evaluation period can be no longer than one day, // so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds. // // Period is a required field Period *int64 `min:"1" type:"integer" required:"true"` // The statistic for the metric associated with the alarm, other than percentile. // For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm, // you must specify either Statistic or ExtendedStatistic, but not both. 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 CloudWatch alarm can get stuck in the INSUFFICIENT DATA state. Unit *string `type:"string" enum:"StandardUnit"` // contains filtered or unexported fields }
func (PutMetricAlarmInput) GoString ¶ added in v0.6.5
func (s PutMetricAlarmInput) GoString() string
GoString returns the string representation
func (*PutMetricAlarmInput) SetActionsEnabled ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetActionsEnabled(v bool) *PutMetricAlarmInput
SetActionsEnabled sets the ActionsEnabled field's value.
func (*PutMetricAlarmInput) SetAlarmActions ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetAlarmActions(v []*string) *PutMetricAlarmInput
SetAlarmActions sets the AlarmActions field's value.
func (*PutMetricAlarmInput) SetAlarmDescription ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetAlarmDescription(v string) *PutMetricAlarmInput
SetAlarmDescription sets the AlarmDescription field's value.
func (*PutMetricAlarmInput) SetAlarmName ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetAlarmName(v string) *PutMetricAlarmInput
SetAlarmName sets the AlarmName field's value.
func (*PutMetricAlarmInput) SetComparisonOperator ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetComparisonOperator(v string) *PutMetricAlarmInput
SetComparisonOperator sets the ComparisonOperator field's value.
func (*PutMetricAlarmInput) SetDatapointsToAlarm ¶ added in v1.12.44
func (s *PutMetricAlarmInput) SetDatapointsToAlarm(v int64) *PutMetricAlarmInput
SetDatapointsToAlarm sets the DatapointsToAlarm field's value.
func (*PutMetricAlarmInput) SetDimensions ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetDimensions(v []*Dimension) *PutMetricAlarmInput
SetDimensions sets the Dimensions field's value.
func (*PutMetricAlarmInput) SetEvaluateLowSampleCountPercentile ¶ added in v1.8.8
func (s *PutMetricAlarmInput) SetEvaluateLowSampleCountPercentile(v string) *PutMetricAlarmInput
SetEvaluateLowSampleCountPercentile sets the EvaluateLowSampleCountPercentile field's value.
func (*PutMetricAlarmInput) SetEvaluationPeriods ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetEvaluationPeriods(v int64) *PutMetricAlarmInput
SetEvaluationPeriods sets the EvaluationPeriods field's value.
func (*PutMetricAlarmInput) SetExtendedStatistic ¶ added in v1.5.7
func (s *PutMetricAlarmInput) SetExtendedStatistic(v string) *PutMetricAlarmInput
SetExtendedStatistic sets the ExtendedStatistic field's value.
func (*PutMetricAlarmInput) SetInsufficientDataActions ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetInsufficientDataActions(v []*string) *PutMetricAlarmInput
SetInsufficientDataActions sets the InsufficientDataActions field's value.
func (*PutMetricAlarmInput) SetMetricName ¶ added in v1.5.0
func (s *PutMetricAlarmInput) SetMetricName(v string) *PutMetricAlarmInput
SetMetricName sets the MetricName field's value.
func (*PutMetricAlarmInput) 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
}
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. The array can include no more than 20 metrics per // call. // // 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 }
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
}
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 }
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
}
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.
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.
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. |