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 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
- type CloudWatch
- func (c *CloudWatch) DeleteAlarmsRequest(input *DeleteAlarmsInput) DeleteAlarmsRequest
- func (c *CloudWatch) DeleteDashboardsRequest(input *DeleteDashboardsInput) DeleteDashboardsRequest
- func (c *CloudWatch) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInput) DescribeAlarmHistoryRequest
- func (c *CloudWatch) DescribeAlarmsForMetricRequest(input *DescribeAlarmsForMetricInput) DescribeAlarmsForMetricRequest
- func (c *CloudWatch) DescribeAlarmsRequest(input *DescribeAlarmsInput) DescribeAlarmsRequest
- func (c *CloudWatch) DisableAlarmActionsRequest(input *DisableAlarmActionsInput) DisableAlarmActionsRequest
- func (c *CloudWatch) EnableAlarmActionsRequest(input *EnableAlarmActionsInput) EnableAlarmActionsRequest
- func (c *CloudWatch) GetDashboardRequest(input *GetDashboardInput) GetDashboardRequest
- func (c *CloudWatch) GetMetricDataRequest(input *GetMetricDataInput) GetMetricDataRequest
- func (c *CloudWatch) GetMetricStatisticsRequest(input *GetMetricStatisticsInput) GetMetricStatisticsRequest
- func (c *CloudWatch) ListDashboardsRequest(input *ListDashboardsInput) ListDashboardsRequest
- func (c *CloudWatch) ListMetricsRequest(input *ListMetricsInput) ListMetricsRequest
- func (c *CloudWatch) PutDashboardRequest(input *PutDashboardInput) PutDashboardRequest
- func (c *CloudWatch) PutMetricAlarmRequest(input *PutMetricAlarmInput) PutMetricAlarmRequest
- func (c *CloudWatch) PutMetricDataRequest(input *PutMetricDataInput) PutMetricDataRequest
- func (c *CloudWatch) SetAlarmStateRequest(input *SetAlarmStateInput) SetAlarmStateRequest
- func (c *CloudWatch) WaitUntilAlarmExists(input *DescribeAlarmsInput) error
- func (c *CloudWatch) WaitUntilAlarmExistsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...aws.WaiterOption) error
- type ComparisonOperator
- type DashboardEntry
- type DashboardValidationMessage
- type Datapoint
- type DeleteAlarmsInput
- type DeleteAlarmsOutput
- type DeleteAlarmsRequest
- type DeleteDashboardsInput
- type DeleteDashboardsOutput
- type DeleteDashboardsRequest
- type DescribeAlarmHistoryInput
- type DescribeAlarmHistoryOutput
- type DescribeAlarmHistoryPager
- type DescribeAlarmHistoryRequest
- type DescribeAlarmsForMetricInput
- type DescribeAlarmsForMetricOutput
- type DescribeAlarmsForMetricRequest
- type DescribeAlarmsInput
- type DescribeAlarmsOutput
- type DescribeAlarmsPager
- type DescribeAlarmsRequest
- type Dimension
- type DimensionFilter
- type DisableAlarmActionsInput
- type DisableAlarmActionsOutput
- type DisableAlarmActionsRequest
- type EnableAlarmActionsInput
- type EnableAlarmActionsOutput
- type EnableAlarmActionsRequest
- type GetDashboardInput
- type GetDashboardOutput
- type GetDashboardRequest
- type GetMetricDataInput
- type GetMetricDataOutput
- type GetMetricDataRequest
- type GetMetricStatisticsInput
- type GetMetricStatisticsOutput
- type GetMetricStatisticsRequest
- type HistoryItemType
- type ListDashboardsInput
- type ListDashboardsOutput
- type ListDashboardsRequest
- type ListMetricsInput
- type ListMetricsOutput
- type ListMetricsPager
- type ListMetricsRequest
- type MessageData
- type Metric
- type MetricAlarm
- type MetricDataQuery
- type MetricDataResult
- type MetricDatum
- type MetricStat
- type PutDashboardInput
- type PutDashboardOutput
- type PutDashboardRequest
- type PutMetricAlarmInput
- type PutMetricAlarmOutput
- type PutMetricAlarmRequest
- type PutMetricDataInput
- type PutMetricDataOutput
- type PutMetricDataRequest
- type ScanBy
- type SetAlarmStateInput
- type SetAlarmStateOutput
- type SetAlarmStateRequest
- type StandardUnit
- type StateValue
- type Statistic
- type StatisticSet
- type StatusCode
Constants ¶
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" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlarmHistoryItem ¶
type AlarmHistoryItem struct { // The descriptive name for the alarm. AlarmName *string `min:"1" type:"string"` // Data about the alarm, in JSON format. HistoryData *string `min:"1" type:"string"` // The type of alarm history item. HistoryItemType HistoryItemType `type:"string" enum:"true"` // A summary of the alarm history, in text format. HistorySummary *string `min:"1" type:"string"` // The time stamp for the alarm history item. Timestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // contains filtered or unexported fields }
Represents the history of a specific alarm. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/AlarmHistoryItem
func (AlarmHistoryItem) GoString ¶
func (s AlarmHistoryItem) GoString() string
GoString returns the string representation
func (AlarmHistoryItem) String ¶
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(config aws.Config) *CloudWatch
New creates a new instance of the CloudWatch client with a config.
Example:
// Create a CloudWatch client from just a config. svc := cloudwatch.New(myConfig)
func (*CloudWatch) DeleteAlarmsRequest ¶
func (c *CloudWatch) DeleteAlarmsRequest(input *DeleteAlarmsInput) DeleteAlarmsRequest
DeleteAlarmsRequest returns a request value for making API operation for Amazon CloudWatch.
Deletes the specified alarms. In the event of an error, no alarms are deleted.
// Example sending a request using the DeleteAlarmsRequest method. req := client.DeleteAlarmsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarms
func (*CloudWatch) DeleteDashboardsRequest ¶
func (c *CloudWatch) DeleteDashboardsRequest(input *DeleteDashboardsInput) DeleteDashboardsRequest
DeleteDashboardsRequest returns a request value for making 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.
// Example sending a request using the DeleteDashboardsRequest method. req := client.DeleteDashboardsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboards
func (*CloudWatch) DescribeAlarmHistoryRequest ¶
func (c *CloudWatch) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInput) DescribeAlarmHistoryRequest
DescribeAlarmHistoryRequest returns a request value for making 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.
// Example sending a request using the DescribeAlarmHistoryRequest method. req := client.DescribeAlarmHistoryRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistory
func (*CloudWatch) DescribeAlarmsForMetricRequest ¶
func (c *CloudWatch) DescribeAlarmsForMetricRequest(input *DescribeAlarmsForMetricInput) DescribeAlarmsForMetricRequest
DescribeAlarmsForMetricRequest returns a request value for making API operation for Amazon CloudWatch.
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
// Example sending a request using the DescribeAlarmsForMetricRequest method. req := client.DescribeAlarmsForMetricRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetric
func (*CloudWatch) DescribeAlarmsRequest ¶
func (c *CloudWatch) DescribeAlarmsRequest(input *DescribeAlarmsInput) DescribeAlarmsRequest
DescribeAlarmsRequest returns a request value for making 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.
// Example sending a request using the DescribeAlarmsRequest method. req := client.DescribeAlarmsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarms
func (*CloudWatch) DisableAlarmActionsRequest ¶
func (c *CloudWatch) DisableAlarmActionsRequest(input *DisableAlarmActionsInput) DisableAlarmActionsRequest
DisableAlarmActionsRequest returns a request value for making 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.
// Example sending a request using the DisableAlarmActionsRequest method. req := client.DisableAlarmActionsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActions
func (*CloudWatch) EnableAlarmActionsRequest ¶
func (c *CloudWatch) EnableAlarmActionsRequest(input *EnableAlarmActionsInput) EnableAlarmActionsRequest
EnableAlarmActionsRequest returns a request value for making API operation for Amazon CloudWatch.
Enables the actions for the specified alarms.
// Example sending a request using the EnableAlarmActionsRequest method. req := client.EnableAlarmActionsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActions
func (*CloudWatch) GetDashboardRequest ¶
func (c *CloudWatch) GetDashboardRequest(input *GetDashboardInput) GetDashboardRequest
GetDashboardRequest returns a request value for making 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.
// Example sending a request using the GetDashboardRequest method. req := client.GetDashboardRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboard
func (*CloudWatch) GetMetricDataRequest ¶ added in v0.4.0
func (c *CloudWatch) GetMetricDataRequest(input *GetMetricDataInput) GetMetricDataRequest
GetMetricDataRequest returns a request value for making 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/).
// Example sending a request using the GetMetricDataRequest method. req := client.GetMetricDataRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricData
func (*CloudWatch) GetMetricStatisticsRequest ¶
func (c *CloudWatch) GetMetricStatisticsRequest(input *GetMetricStatisticsInput) GetMetricStatisticsRequest
GetMetricStatisticsRequest returns a request value for making 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.
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.
// Example sending a request using the GetMetricStatisticsRequest method. req := client.GetMetricStatisticsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatistics
func (*CloudWatch) ListDashboardsRequest ¶
func (c *CloudWatch) ListDashboardsRequest(input *ListDashboardsInput) ListDashboardsRequest
ListDashboardsRequest returns a request value for making 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.
// Example sending a request using the ListDashboardsRequest method. req := client.ListDashboardsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboards
func (*CloudWatch) ListMetricsRequest ¶
func (c *CloudWatch) ListMetricsRequest(input *ListMetricsInput) ListMetricsRequest
ListMetricsRequest returns a request value for making API operation for Amazon CloudWatch.
List the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.
// Example sending a request using the ListMetricsRequest method. req := client.ListMetricsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetrics
func (*CloudWatch) PutDashboardRequest ¶
func (c *CloudWatch) PutDashboardRequest(input *PutDashboardInput) PutDashboardRequest
PutDashboardRequest returns a request value for making 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.
You can have up to 500 dashboards per 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.
// Example sending a request using the PutDashboardRequest method. req := client.PutDashboardRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboard
func (*CloudWatch) PutMetricAlarmRequest ¶
func (c *CloudWatch) PutMetricAlarmRequest(input *PutMetricAlarmInput) PutMetricAlarmRequest
PutMetricAlarmRequest returns a request value for making 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.
You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.
// Example sending a request using the PutMetricAlarmRequest method. req := client.PutMetricAlarmRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarm
func (*CloudWatch) PutMetricDataRequest ¶
func (c *CloudWatch) PutMetricDataRequest(input *PutMetricDataInput) PutMetricDataRequest
PutMetricDataRequest returns a request value for making API operation for Amazon CloudWatch.
Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests.
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 GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you 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
// Example sending a request using the PutMetricDataRequest method. req := client.PutMetricDataRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricData
func (*CloudWatch) SetAlarmStateRequest ¶
func (c *CloudWatch) SetAlarmStateRequest(input *SetAlarmStateInput) SetAlarmStateRequest
SetAlarmStateRequest returns a request value for making 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.
// Example sending a request using the SetAlarmStateRequest method. req := client.SetAlarmStateRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmState
func (*CloudWatch) WaitUntilAlarmExists ¶
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 ¶
func (c *CloudWatch) WaitUntilAlarmExistsWithContext(ctx aws.Context, input *DescribeAlarmsInput, opts ...aws.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 ComparisonOperator ¶
type ComparisonOperator string
const ( ComparisonOperatorGreaterThanOrEqualToThreshold ComparisonOperator = "GreaterThanOrEqualToThreshold" ComparisonOperatorGreaterThanThreshold ComparisonOperator = "GreaterThanThreshold" ComparisonOperatorLessThanThreshold ComparisonOperator = "LessThanThreshold" ComparisonOperatorLessThanOrEqualToThreshold ComparisonOperator = "LessThanOrEqualToThreshold" )
Enum values for ComparisonOperator
func (ComparisonOperator) MarshalValue ¶ added in v0.3.0
func (enum ComparisonOperator) MarshalValue() (string, error)
func (ComparisonOperator) MarshalValueBuf ¶ added in v0.3.0
func (enum ComparisonOperator) MarshalValueBuf(b []byte) ([]byte, error)
type DashboardEntry ¶
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" timestampFormat:"iso8601"` // The size of the dashboard, in bytes. Size *int64 `type:"long"` // contains filtered or unexported fields }
Represents a specific dashboard. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DashboardEntry
func (DashboardEntry) GoString ¶
func (s DashboardEntry) GoString() string
GoString returns the string representation
func (DashboardEntry) String ¶
func (s DashboardEntry) String() string
String returns the string representation
type DashboardValidationMessage ¶
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DashboardValidationMessage
func (DashboardValidationMessage) GoString ¶
func (s DashboardValidationMessage) GoString() string
GoString returns the string representation
func (DashboardValidationMessage) String ¶
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" timestampFormat:"iso8601"` // The standard unit for the data point. Unit StandardUnit `type:"string" enum:"true"` // contains filtered or unexported fields }
Encapsulates the statistical data that CloudWatch computes from metric data. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Datapoint
type DeleteAlarmsInput ¶
type DeleteAlarmsInput struct { // The alarms to be deleted. // // AlarmNames is a required field AlarmNames []string `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarmsInput
func (DeleteAlarmsInput) GoString ¶
func (s DeleteAlarmsInput) GoString() string
GoString returns the string representation
func (DeleteAlarmsInput) String ¶
func (s DeleteAlarmsInput) String() string
String returns the string representation
func (*DeleteAlarmsInput) Validate ¶
func (s *DeleteAlarmsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAlarmsOutput ¶
type DeleteAlarmsOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAlarmsOutput
func (DeleteAlarmsOutput) GoString ¶
func (s DeleteAlarmsOutput) GoString() string
GoString returns the string representation
func (DeleteAlarmsOutput) SDKResponseMetadata ¶
func (s DeleteAlarmsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteAlarmsOutput) String ¶
func (s DeleteAlarmsOutput) String() string
String returns the string representation
type DeleteAlarmsRequest ¶
type DeleteAlarmsRequest struct { *aws.Request Input *DeleteAlarmsInput Copy func(*DeleteAlarmsInput) DeleteAlarmsRequest }
DeleteAlarmsRequest is a API request type for the DeleteAlarms API operation.
func (DeleteAlarmsRequest) Send ¶
func (r DeleteAlarmsRequest) Send() (*DeleteAlarmsOutput, error)
Send marshals and sends the DeleteAlarms API request.
type DeleteDashboardsInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboardsInput
func (DeleteDashboardsInput) GoString ¶
func (s DeleteDashboardsInput) GoString() string
GoString returns the string representation
func (DeleteDashboardsInput) String ¶
func (s DeleteDashboardsInput) String() string
String returns the string representation
func (*DeleteDashboardsInput) Validate ¶ added in v0.2.0
func (s *DeleteDashboardsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDashboardsOutput ¶
type DeleteDashboardsOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteDashboardsOutput
func (DeleteDashboardsOutput) GoString ¶
func (s DeleteDashboardsOutput) GoString() string
GoString returns the string representation
func (DeleteDashboardsOutput) SDKResponseMetadata ¶
func (s DeleteDashboardsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteDashboardsOutput) String ¶
func (s DeleteDashboardsOutput) String() string
String returns the string representation
type DeleteDashboardsRequest ¶
type DeleteDashboardsRequest struct { *aws.Request Input *DeleteDashboardsInput Copy func(*DeleteDashboardsInput) DeleteDashboardsRequest }
DeleteDashboardsRequest is a API request type for the DeleteDashboards API operation.
func (DeleteDashboardsRequest) Send ¶
func (r DeleteDashboardsRequest) Send() (*DeleteDashboardsOutput, error)
Send marshals and sends the DeleteDashboards API request.
type DescribeAlarmHistoryInput ¶
type DescribeAlarmHistoryInput struct { // The name of the alarm. AlarmName *string `min:"1" type:"string"` // The ending date to retrieve alarm history. EndDate *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The type of alarm histories to retrieve. HistoryItemType HistoryItemType `type:"string" enum:"true"` // The maximum number of alarm history records to retrieve. MaxRecords *int64 `min:"1" type:"integer"` // The token returned by a previous call to indicate that there is more data // available. NextToken *string `type:"string"` // The starting date to retrieve alarm history. StartDate *time.Time `type:"timestamp" timestampFormat:"iso8601"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryInput
func (DescribeAlarmHistoryInput) GoString ¶
func (s DescribeAlarmHistoryInput) GoString() string
GoString returns the string representation
func (DescribeAlarmHistoryInput) String ¶
func (s DescribeAlarmHistoryInput) String() string
String returns the string representation
func (*DescribeAlarmHistoryInput) Validate ¶
func (s *DescribeAlarmHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAlarmHistoryOutput ¶
type DescribeAlarmHistoryOutput struct { // The alarm histories, in JSON format. AlarmHistoryItems []AlarmHistoryItem `type:"list"` // The token that marks the start of the next batch of returned results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmHistoryOutput
func (DescribeAlarmHistoryOutput) GoString ¶
func (s DescribeAlarmHistoryOutput) GoString() string
GoString returns the string representation
func (DescribeAlarmHistoryOutput) SDKResponseMetadata ¶
func (s DescribeAlarmHistoryOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeAlarmHistoryOutput) String ¶
func (s DescribeAlarmHistoryOutput) String() string
String returns the string representation
type DescribeAlarmHistoryPager ¶ added in v0.3.0
DescribeAlarmHistoryPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*DescribeAlarmHistoryPager) CurrentPage ¶ added in v0.3.0
func (p *DescribeAlarmHistoryPager) CurrentPage() *DescribeAlarmHistoryOutput
type DescribeAlarmHistoryRequest ¶
type DescribeAlarmHistoryRequest struct { *aws.Request Input *DescribeAlarmHistoryInput Copy func(*DescribeAlarmHistoryInput) DescribeAlarmHistoryRequest }
DescribeAlarmHistoryRequest is a API request type for the DescribeAlarmHistory API operation.
func (*DescribeAlarmHistoryRequest) Paginate ¶ added in v0.3.0
func (p *DescribeAlarmHistoryRequest) Paginate(opts ...aws.Option) DescribeAlarmHistoryPager
Paginate pages iterates over the pages of a DescribeAlarmHistoryRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeAlarmHistory operation. req := client.DescribeAlarmHistoryRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (DescribeAlarmHistoryRequest) Send ¶
func (r DescribeAlarmHistoryRequest) Send() (*DescribeAlarmHistoryOutput, error)
Send marshals and sends the DescribeAlarmHistory API request.
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 Statistic `type:"string" enum:"true"` // The unit for the metric. Unit StandardUnit `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetricInput
func (DescribeAlarmsForMetricInput) GoString ¶
func (s DescribeAlarmsForMetricInput) GoString() string
GoString returns the string representation
func (DescribeAlarmsForMetricInput) String ¶
func (s DescribeAlarmsForMetricInput) String() string
String returns the string representation
func (*DescribeAlarmsForMetricInput) Validate ¶
func (s *DescribeAlarmsForMetricInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAlarmsForMetricOutput ¶
type DescribeAlarmsForMetricOutput struct { // The information for each alarm with the specified metric. MetricAlarms []MetricAlarm `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsForMetricOutput
func (DescribeAlarmsForMetricOutput) GoString ¶
func (s DescribeAlarmsForMetricOutput) GoString() string
GoString returns the string representation
func (DescribeAlarmsForMetricOutput) SDKResponseMetadata ¶
func (s DescribeAlarmsForMetricOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeAlarmsForMetricOutput) String ¶
func (s DescribeAlarmsForMetricOutput) String() string
String returns the string representation
type DescribeAlarmsForMetricRequest ¶
type DescribeAlarmsForMetricRequest struct { *aws.Request Input *DescribeAlarmsForMetricInput Copy func(*DescribeAlarmsForMetricInput) DescribeAlarmsForMetricRequest }
DescribeAlarmsForMetricRequest is a API request type for the DescribeAlarmsForMetric API operation.
func (DescribeAlarmsForMetricRequest) Send ¶
func (r DescribeAlarmsForMetricRequest) Send() (*DescribeAlarmsForMetricOutput, error)
Send marshals and sends the DescribeAlarmsForMetric API request.
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 StateValue `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsInput
func (DescribeAlarmsInput) GoString ¶
func (s DescribeAlarmsInput) GoString() string
GoString returns the string representation
func (DescribeAlarmsInput) String ¶
func (s DescribeAlarmsInput) String() string
String returns the string representation
func (*DescribeAlarmsInput) Validate ¶
func (s *DescribeAlarmsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAlarmsOutput ¶
type DescribeAlarmsOutput struct { // The information for the specified alarms. MetricAlarms []MetricAlarm `type:"list"` // The token that marks the start of the next batch of returned results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAlarmsOutput
func (DescribeAlarmsOutput) GoString ¶
func (s DescribeAlarmsOutput) GoString() string
GoString returns the string representation
func (DescribeAlarmsOutput) SDKResponseMetadata ¶
func (s DescribeAlarmsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeAlarmsOutput) String ¶
func (s DescribeAlarmsOutput) String() string
String returns the string representation
type DescribeAlarmsPager ¶ added in v0.3.0
DescribeAlarmsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*DescribeAlarmsPager) CurrentPage ¶ added in v0.3.0
func (p *DescribeAlarmsPager) CurrentPage() *DescribeAlarmsOutput
type DescribeAlarmsRequest ¶
type DescribeAlarmsRequest struct { *aws.Request Input *DescribeAlarmsInput Copy func(*DescribeAlarmsInput) DescribeAlarmsRequest }
DescribeAlarmsRequest is a API request type for the DescribeAlarms API operation.
func (*DescribeAlarmsRequest) Paginate ¶ added in v0.3.0
func (p *DescribeAlarmsRequest) Paginate(opts ...aws.Option) DescribeAlarmsPager
Paginate pages iterates over the pages of a DescribeAlarmsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeAlarms operation. req := client.DescribeAlarmsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (DescribeAlarmsRequest) Send ¶
func (r DescribeAlarmsRequest) Send() (*DescribeAlarmsOutput, error)
Send marshals and sends the DescribeAlarms API request.
type Dimension ¶
type Dimension struct { // The name of the dimension. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The value representing the dimension measurement. // // Value is a required field Value *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Expands the identity of a metric. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Dimension
type DimensionFilter ¶
type DimensionFilter struct { // The dimension name to be matched. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The value of the dimension to be matched. Value *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents filters for a dimension. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DimensionFilter
func (DimensionFilter) GoString ¶
func (s DimensionFilter) GoString() string
GoString returns the string representation
func (DimensionFilter) String ¶
func (s DimensionFilter) String() string
String returns the string representation
func (*DimensionFilter) Validate ¶
func (s *DimensionFilter) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableAlarmActionsInput ¶
type DisableAlarmActionsInput struct { // The names of the alarms. // // AlarmNames is a required field AlarmNames []string `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActionsInput
func (DisableAlarmActionsInput) GoString ¶
func (s DisableAlarmActionsInput) GoString() string
GoString returns the string representation
func (DisableAlarmActionsInput) String ¶
func (s DisableAlarmActionsInput) String() string
String returns the string representation
func (*DisableAlarmActionsInput) Validate ¶
func (s *DisableAlarmActionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableAlarmActionsOutput ¶
type DisableAlarmActionsOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisableAlarmActionsOutput
func (DisableAlarmActionsOutput) GoString ¶
func (s DisableAlarmActionsOutput) GoString() string
GoString returns the string representation
func (DisableAlarmActionsOutput) SDKResponseMetadata ¶
func (s DisableAlarmActionsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DisableAlarmActionsOutput) String ¶
func (s DisableAlarmActionsOutput) String() string
String returns the string representation
type DisableAlarmActionsRequest ¶
type DisableAlarmActionsRequest struct { *aws.Request Input *DisableAlarmActionsInput Copy func(*DisableAlarmActionsInput) DisableAlarmActionsRequest }
DisableAlarmActionsRequest is a API request type for the DisableAlarmActions API operation.
func (DisableAlarmActionsRequest) Send ¶
func (r DisableAlarmActionsRequest) Send() (*DisableAlarmActionsOutput, error)
Send marshals and sends the DisableAlarmActions API request.
type EnableAlarmActionsInput ¶
type EnableAlarmActionsInput struct { // The names of the alarms. // // AlarmNames is a required field AlarmNames []string `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActionsInput
func (EnableAlarmActionsInput) GoString ¶
func (s EnableAlarmActionsInput) GoString() string
GoString returns the string representation
func (EnableAlarmActionsInput) String ¶
func (s EnableAlarmActionsInput) String() string
String returns the string representation
func (*EnableAlarmActionsInput) Validate ¶
func (s *EnableAlarmActionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableAlarmActionsOutput ¶
type EnableAlarmActionsOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/EnableAlarmActionsOutput
func (EnableAlarmActionsOutput) GoString ¶
func (s EnableAlarmActionsOutput) GoString() string
GoString returns the string representation
func (EnableAlarmActionsOutput) SDKResponseMetadata ¶
func (s EnableAlarmActionsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (EnableAlarmActionsOutput) String ¶
func (s EnableAlarmActionsOutput) String() string
String returns the string representation
type EnableAlarmActionsRequest ¶
type EnableAlarmActionsRequest struct { *aws.Request Input *EnableAlarmActionsInput Copy func(*EnableAlarmActionsInput) EnableAlarmActionsRequest }
EnableAlarmActionsRequest is a API request type for the EnableAlarmActions API operation.
func (EnableAlarmActionsRequest) Send ¶
func (r EnableAlarmActionsRequest) Send() (*EnableAlarmActionsOutput, error)
Send marshals and sends the EnableAlarmActions API request.
type GetDashboardInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboardInput
func (GetDashboardInput) GoString ¶
func (s GetDashboardInput) GoString() string
GoString returns the string representation
func (GetDashboardInput) String ¶
func (s GetDashboardInput) String() string
String returns the string representation
func (*GetDashboardInput) Validate ¶ added in v0.2.0
func (s *GetDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDashboardOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboardOutput
func (GetDashboardOutput) GoString ¶
func (s GetDashboardOutput) GoString() string
GoString returns the string representation
func (GetDashboardOutput) SDKResponseMetadata ¶
func (s GetDashboardOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetDashboardOutput) String ¶
func (s GetDashboardOutput) String() string
String returns the string representation
type GetDashboardRequest ¶
type GetDashboardRequest struct { *aws.Request Input *GetDashboardInput Copy func(*GetDashboardInput) GetDashboardRequest }
GetDashboardRequest is a API request type for the GetDashboard API operation.
func (GetDashboardRequest) Send ¶
func (r GetDashboardRequest) Send() (*GetDashboardOutput, error)
Send marshals and sends the GetDashboard API request.
type GetMetricDataInput ¶ added in v0.4.0
type GetMetricDataInput struct { // The time stamp indicating the latest data to be returned. // // EndTime is a required field EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" 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 ScanBy `type:"string" enum:"true"` // The time stamp indicating the earliest data to be returned. // // StartTime is a required field StartTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricDataInput
func (GetMetricDataInput) GoString ¶ added in v0.4.0
func (s GetMetricDataInput) GoString() string
GoString returns the string representation
func (GetMetricDataInput) String ¶ added in v0.4.0
func (s GetMetricDataInput) String() string
String returns the string representation
func (*GetMetricDataInput) Validate ¶ added in v0.4.0
func (s *GetMetricDataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMetricDataOutput ¶ added in v0.4.0
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricDataOutput
func (GetMetricDataOutput) GoString ¶ added in v0.4.0
func (s GetMetricDataOutput) GoString() string
GoString returns the string representation
func (GetMetricDataOutput) SDKResponseMetadata ¶ added in v0.4.0
func (s GetMetricDataOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetMetricDataOutput) String ¶ added in v0.4.0
func (s GetMetricDataOutput) String() string
String returns the string representation
type GetMetricDataRequest ¶ added in v0.4.0
type GetMetricDataRequest struct { *aws.Request Input *GetMetricDataInput Copy func(*GetMetricDataInput) GetMetricDataRequest }
GetMetricDataRequest is a API request type for the GetMetricData API operation.
func (GetMetricDataRequest) Send ¶ added in v0.4.0
func (r GetMetricDataRequest) Send() (*GetMetricDataOutput, error)
Send marshals and sends the GetMetricData API request.
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" timestampFormat:"iso8601" 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. 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" timestampFormat:"iso8601" 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 []Statistic `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 StandardUnit `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsInput
func (GetMetricStatisticsInput) GoString ¶
func (s GetMetricStatisticsInput) GoString() string
GoString returns the string representation
func (GetMetricStatisticsInput) String ¶
func (s GetMetricStatisticsInput) String() string
String returns the string representation
func (*GetMetricStatisticsInput) Validate ¶
func (s *GetMetricStatisticsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetMetricStatisticsOutput ¶
type GetMetricStatisticsOutput struct { // The data points for the specified metric. Datapoints []Datapoint `type:"list"` // A label for the specified metric. Label *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetMetricStatisticsOutput
func (GetMetricStatisticsOutput) GoString ¶
func (s GetMetricStatisticsOutput) GoString() string
GoString returns the string representation
func (GetMetricStatisticsOutput) SDKResponseMetadata ¶
func (s GetMetricStatisticsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetMetricStatisticsOutput) String ¶
func (s GetMetricStatisticsOutput) String() string
String returns the string representation
type GetMetricStatisticsRequest ¶
type GetMetricStatisticsRequest struct { *aws.Request Input *GetMetricStatisticsInput Copy func(*GetMetricStatisticsInput) GetMetricStatisticsRequest }
GetMetricStatisticsRequest is a API request type for the GetMetricStatistics API operation.
func (GetMetricStatisticsRequest) Send ¶
func (r GetMetricStatisticsRequest) Send() (*GetMetricStatisticsOutput, error)
Send marshals and sends the GetMetricStatistics API request.
type HistoryItemType ¶
type HistoryItemType string
const ( HistoryItemTypeConfigurationUpdate HistoryItemType = "ConfigurationUpdate" HistoryItemTypeStateUpdate HistoryItemType = "StateUpdate" HistoryItemTypeAction HistoryItemType = "Action" )
Enum values for HistoryItemType
func (HistoryItemType) MarshalValue ¶ added in v0.3.0
func (enum HistoryItemType) MarshalValue() (string, error)
func (HistoryItemType) MarshalValueBuf ¶ added in v0.3.0
func (enum HistoryItemType) MarshalValueBuf(b []byte) ([]byte, error)
type ListDashboardsInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboardsInput
func (ListDashboardsInput) GoString ¶
func (s ListDashboardsInput) GoString() string
GoString returns the string representation
func (ListDashboardsInput) String ¶
func (s ListDashboardsInput) String() string
String returns the string representation
type ListDashboardsOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListDashboardsOutput
func (ListDashboardsOutput) GoString ¶
func (s ListDashboardsOutput) GoString() string
GoString returns the string representation
func (ListDashboardsOutput) SDKResponseMetadata ¶
func (s ListDashboardsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListDashboardsOutput) String ¶
func (s ListDashboardsOutput) String() string
String returns the string representation
type ListDashboardsRequest ¶
type ListDashboardsRequest struct { *aws.Request Input *ListDashboardsInput Copy func(*ListDashboardsInput) ListDashboardsRequest }
ListDashboardsRequest is a API request type for the ListDashboards API operation.
func (ListDashboardsRequest) Send ¶
func (r ListDashboardsRequest) Send() (*ListDashboardsOutput, error)
Send marshals and sends the ListDashboards API request.
type ListMetricsInput ¶
type ListMetricsInput struct { // The dimensions to filter against. Dimensions []DimensionFilter `type:"list"` // The name of the metric to filter against. MetricName *string `min:"1" type:"string"` // The namespace to filter against. Namespace *string `min:"1" type:"string"` // The token returned by a previous call to indicate that there is more data // available. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsInput
func (ListMetricsInput) GoString ¶
func (s ListMetricsInput) GoString() string
GoString returns the string representation
func (ListMetricsInput) String ¶
func (s ListMetricsInput) String() string
String returns the string representation
func (*ListMetricsInput) Validate ¶
func (s *ListMetricsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListMetricsOutput ¶
type ListMetricsOutput struct { // The metrics. Metrics []Metric `type:"list"` // The token that marks the start of the next batch of returned results. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ListMetricsOutput
func (ListMetricsOutput) GoString ¶
func (s ListMetricsOutput) GoString() string
GoString returns the string representation
func (ListMetricsOutput) SDKResponseMetadata ¶
func (s ListMetricsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListMetricsOutput) String ¶
func (s ListMetricsOutput) String() string
String returns the string representation
type ListMetricsPager ¶ added in v0.3.0
ListMetricsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListMetricsPager) CurrentPage ¶ added in v0.3.0
func (p *ListMetricsPager) CurrentPage() *ListMetricsOutput
type ListMetricsRequest ¶
type ListMetricsRequest struct { *aws.Request Input *ListMetricsInput Copy func(*ListMetricsInput) ListMetricsRequest }
ListMetricsRequest is a API request type for the ListMetrics API operation.
func (*ListMetricsRequest) Paginate ¶ added in v0.3.0
func (p *ListMetricsRequest) Paginate(opts ...aws.Option) ListMetricsPager
Paginate pages iterates over the pages of a ListMetricsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListMetrics operation. req := client.ListMetricsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListMetricsRequest) Send ¶
func (r ListMetricsRequest) Send() (*ListMetricsOutput, error)
Send marshals and sends the ListMetrics API request.
type MessageData ¶ added in v0.4.0
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MessageData
func (MessageData) GoString ¶ added in v0.4.0
func (s MessageData) GoString() string
GoString returns the string representation
func (MessageData) String ¶ added in v0.4.0
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/Metric
type MetricAlarm ¶
type MetricAlarm struct { // Indicates whether actions should be executed during any changes to the alarm // state. ActionsEnabled *bool `type:"boolean"` // The actions to execute when this alarm transitions to the ALARM state from // any other state. Each action is specified as an Amazon Resource Name (ARN). AlarmActions []string `type:"list"` // The Amazon Resource Name (ARN) of the alarm. AlarmArn *string `min:"1" type:"string"` // The time stamp of the last update to the alarm configuration. AlarmConfigurationUpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The description of the alarm. AlarmDescription *string `type:"string"` // The name of the alarm. AlarmName *string `min:"1" type:"string"` // The arithmetic operation to use when comparing the specified statistic and // threshold. The specified statistic value is used as the first operand. ComparisonOperator ComparisonOperator `type:"string" enum:"true"` // 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" timestampFormat:"iso8601"` // The state value for the alarm. StateValue StateValue `type:"string" enum:"true"` // The statistic for the metric associated with the alarm, other than percentile. // For percentile statistics, use ExtendedStatistic. Statistic Statistic `type:"string" enum:"true"` // 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 StandardUnit `type:"string" enum:"true"` // contains filtered or unexported fields }
Represents an alarm. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricAlarm
func (MetricAlarm) GoString ¶
func (s MetricAlarm) GoString() string
GoString returns the string representation
func (MetricAlarm) String ¶
func (s MetricAlarm) String() string
String returns the string representation
type MetricDataQuery ¶ added in v0.4.0
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataQuery
func (MetricDataQuery) GoString ¶ added in v0.4.0
func (s MetricDataQuery) GoString() string
GoString returns the string representation
func (MetricDataQuery) String ¶ added in v0.4.0
func (s MetricDataQuery) String() string
String returns the string representation
func (*MetricDataQuery) Validate ¶ added in v0.4.0
func (s *MetricDataQuery) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MetricDataResult ¶ added in v0.4.0
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 StatusCode `type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDataResult
func (MetricDataResult) GoString ¶ added in v0.4.0
func (s MetricDataResult) GoString() string
GoString returns the string representation
func (MetricDataResult) String ¶ added in v0.4.0
func (s MetricDataResult) String() string
String returns the string representation
type MetricDatum ¶
type MetricDatum struct { // The dimensions associated with the metric. Dimensions []Dimension `type:"list"` // The name of the metric. // // MetricName is a required field MetricName *string `min:"1" type:"string" required:"true"` // The statistical values for the metric. StatisticValues *StatisticSet `type:"structure"` // 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" timestampFormat:"iso8601"` // The unit of the metric. Unit StandardUnit `type:"string" enum:"true"` // 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"` // contains filtered or unexported fields }
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricDatum
func (MetricDatum) GoString ¶
func (s MetricDatum) GoString() string
GoString returns the string representation
func (MetricDatum) String ¶
func (s MetricDatum) String() string
String returns the string representation
func (*MetricDatum) Validate ¶
func (s *MetricDatum) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MetricStat ¶ added in v0.4.0
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 StandardUnit `type:"string" enum:"true"` // contains filtered or unexported fields }
This structure defines the metric to be returned, along with the statistics, period, and units. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/MetricStat
func (MetricStat) GoString ¶ added in v0.4.0
func (s MetricStat) GoString() string
GoString returns the string representation
func (MetricStat) String ¶ added in v0.4.0
func (s MetricStat) String() string
String returns the string representation
func (*MetricStat) Validate ¶ added in v0.4.0
func (s *MetricStat) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutDashboardInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboardInput
func (PutDashboardInput) GoString ¶
func (s PutDashboardInput) GoString() string
GoString returns the string representation
func (PutDashboardInput) String ¶
func (s PutDashboardInput) String() string
String returns the string representation
func (*PutDashboardInput) Validate ¶ added in v0.2.0
func (s *PutDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutDashboardOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutDashboardOutput
func (PutDashboardOutput) GoString ¶
func (s PutDashboardOutput) GoString() string
GoString returns the string representation
func (PutDashboardOutput) SDKResponseMetadata ¶
func (s PutDashboardOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (PutDashboardOutput) String ¶
func (s PutDashboardOutput) String() string
String returns the string representation
type PutDashboardRequest ¶
type PutDashboardRequest struct { *aws.Request Input *PutDashboardInput Copy func(*PutDashboardInput) PutDashboardRequest }
PutDashboardRequest is a API request type for the PutDashboard API operation.
func (PutDashboardRequest) Send ¶
func (r PutDashboardRequest) Send() (*PutDashboardOutput, error)
Send marshals and sends the PutDashboard API request.
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-id autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // Valid Values (for use with IAM roles): arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Stop/1.0 // | arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // | arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Reboot/1.0 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 ComparisonOperator `type:"string" required:"true" enum:"true"` // 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-id autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // Valid Values (for use with IAM roles): arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Stop/1.0 // | arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // | arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Reboot/1.0 InsufficientDataActions []string `type:"list"` // The name for the metric associated with the alarm. // // 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-id autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name // // Valid Values (for use with IAM roles): arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Stop/1.0 // | arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 // | arn:aws:swf:region:{account-id}:action/actions/AWS_EC2.InstanceId.Reboot/1.0 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 Statistic `type:"string" enum:"true"` // 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 StandardUnit `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmInput
func (PutMetricAlarmInput) GoString ¶
func (s PutMetricAlarmInput) GoString() string
GoString returns the string representation
func (PutMetricAlarmInput) String ¶
func (s PutMetricAlarmInput) String() string
String returns the string representation
func (*PutMetricAlarmInput) Validate ¶
func (s *PutMetricAlarmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMetricAlarmOutput ¶
type PutMetricAlarmOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricAlarmOutput
func (PutMetricAlarmOutput) GoString ¶
func (s PutMetricAlarmOutput) GoString() string
GoString returns the string representation
func (PutMetricAlarmOutput) SDKResponseMetadata ¶
func (s PutMetricAlarmOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (PutMetricAlarmOutput) String ¶
func (s PutMetricAlarmOutput) String() string
String returns the string representation
type PutMetricAlarmRequest ¶
type PutMetricAlarmRequest struct { *aws.Request Input *PutMetricAlarmInput Copy func(*PutMetricAlarmInput) PutMetricAlarmRequest }
PutMetricAlarmRequest is a API request type for the PutMetricAlarm API operation.
func (PutMetricAlarmRequest) Send ¶
func (r PutMetricAlarmRequest) Send() (*PutMetricAlarmOutput, error)
Send marshals and sends the PutMetricAlarm API request.
type PutMetricDataInput ¶
type PutMetricDataInput struct { // The data for the metric. // // MetricData is a required field MetricData []MetricDatum `type:"list" required:"true"` // The namespace for the metric data. // // You cannot specify a namespace that begins with "AWS/". Namespaces that begin // with "AWS/" are reserved for use by Amazon Web Services products. // // Namespace is a required field Namespace *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricDataInput
func (PutMetricDataInput) GoString ¶
func (s PutMetricDataInput) GoString() string
GoString returns the string representation
func (PutMetricDataInput) String ¶
func (s PutMetricDataInput) String() string
String returns the string representation
func (*PutMetricDataInput) Validate ¶
func (s *PutMetricDataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutMetricDataOutput ¶
type PutMetricDataOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutMetricDataOutput
func (PutMetricDataOutput) GoString ¶
func (s PutMetricDataOutput) GoString() string
GoString returns the string representation
func (PutMetricDataOutput) SDKResponseMetadata ¶
func (s PutMetricDataOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (PutMetricDataOutput) String ¶
func (s PutMetricDataOutput) String() string
String returns the string representation
type PutMetricDataRequest ¶
type PutMetricDataRequest struct { *aws.Request Input *PutMetricDataInput Copy func(*PutMetricDataInput) PutMetricDataRequest }
PutMetricDataRequest is a API request type for the PutMetricData API operation.
func (PutMetricDataRequest) Send ¶
func (r PutMetricDataRequest) Send() (*PutMetricDataOutput, error)
Send marshals and sends the PutMetricData API request.
type ScanBy ¶ added in v0.4.0
type ScanBy string
const ( ScanByTimestampDescending ScanBy = "TimestampDescending" ScanByTimestampAscending ScanBy = "TimestampAscending" )
Enum values for ScanBy
func (ScanBy) MarshalValue ¶ added in v0.4.0
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 StateValue `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmStateInput
func (SetAlarmStateInput) GoString ¶
func (s SetAlarmStateInput) GoString() string
GoString returns the string representation
func (SetAlarmStateInput) String ¶
func (s SetAlarmStateInput) String() string
String returns the string representation
func (*SetAlarmStateInput) Validate ¶
func (s *SetAlarmStateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetAlarmStateOutput ¶
type SetAlarmStateOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/SetAlarmStateOutput
func (SetAlarmStateOutput) GoString ¶
func (s SetAlarmStateOutput) GoString() string
GoString returns the string representation
func (SetAlarmStateOutput) SDKResponseMetadata ¶
func (s SetAlarmStateOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SetAlarmStateOutput) String ¶
func (s SetAlarmStateOutput) String() string
String returns the string representation
type SetAlarmStateRequest ¶
type SetAlarmStateRequest struct { *aws.Request Input *SetAlarmStateInput Copy func(*SetAlarmStateInput) SetAlarmStateRequest }
SetAlarmStateRequest is a API request type for the SetAlarmState API operation.
func (SetAlarmStateRequest) Send ¶
func (r SetAlarmStateRequest) Send() (*SetAlarmStateOutput, error)
Send marshals and sends the SetAlarmState API request.
type StandardUnit ¶
type StandardUnit string
const ( StandardUnitSeconds StandardUnit = "Seconds" StandardUnitMicroseconds StandardUnit = "Microseconds" StandardUnitMilliseconds StandardUnit = "Milliseconds" StandardUnitBytes StandardUnit = "Bytes" StandardUnitKilobytes StandardUnit = "Kilobytes" StandardUnitMegabytes StandardUnit = "Megabytes" StandardUnitGigabytes StandardUnit = "Gigabytes" StandardUnitTerabytes StandardUnit = "Terabytes" StandardUnitBits StandardUnit = "Bits" StandardUnitKilobits StandardUnit = "Kilobits" StandardUnitMegabits StandardUnit = "Megabits" StandardUnitGigabits StandardUnit = "Gigabits" StandardUnitTerabits StandardUnit = "Terabits" StandardUnitPercent StandardUnit = "Percent" StandardUnitCount StandardUnit = "Count" StandardUnitBytesSecond StandardUnit = "Bytes/Second" StandardUnitKilobytesSecond StandardUnit = "Kilobytes/Second" StandardUnitMegabytesSecond StandardUnit = "Megabytes/Second" StandardUnitGigabytesSecond StandardUnit = "Gigabytes/Second" StandardUnitTerabytesSecond StandardUnit = "Terabytes/Second" StandardUnitBitsSecond StandardUnit = "Bits/Second" StandardUnitKilobitsSecond StandardUnit = "Kilobits/Second" StandardUnitMegabitsSecond StandardUnit = "Megabits/Second" StandardUnitGigabitsSecond StandardUnit = "Gigabits/Second" StandardUnitTerabitsSecond StandardUnit = "Terabits/Second" StandardUnitCountSecond StandardUnit = "Count/Second" StandardUnitNone StandardUnit = "None" )
Enum values for StandardUnit
func (StandardUnit) MarshalValue ¶ added in v0.3.0
func (enum StandardUnit) MarshalValue() (string, error)
func (StandardUnit) MarshalValueBuf ¶ added in v0.3.0
func (enum StandardUnit) MarshalValueBuf(b []byte) ([]byte, error)
type StateValue ¶
type StateValue string
const ( StateValueOk StateValue = "OK" StateValueAlarm StateValue = "ALARM" StateValueInsufficientData StateValue = "INSUFFICIENT_DATA" )
Enum values for StateValue
func (StateValue) MarshalValue ¶ added in v0.3.0
func (enum StateValue) MarshalValue() (string, error)
func (StateValue) MarshalValueBuf ¶ added in v0.3.0
func (enum StateValue) MarshalValueBuf(b []byte) ([]byte, error)
type Statistic ¶
type Statistic string
const ( StatisticSampleCount Statistic = "SampleCount" StatisticAverage Statistic = "Average" StatisticSum Statistic = "Sum" StatisticMinimum Statistic = "Minimum" StatisticMaximum Statistic = "Maximum" )
Enum values for Statistic
func (Statistic) MarshalValue ¶ added in v0.3.0
type StatisticSet ¶
type StatisticSet struct { // The maximum value of the sample set. // // Maximum is a required field Maximum *float64 `type:"double" required:"true"` // The minimum value of the sample set. // // Minimum is a required field Minimum *float64 `type:"double" required:"true"` // The number of samples used for the statistic set. // // SampleCount is a required field SampleCount *float64 `type:"double" required:"true"` // The sum of values for the sample set. // // Sum is a required field Sum *float64 `type:"double" required:"true"` // contains filtered or unexported fields }
Represents a set of statistics that describes a specific metric. Please also see https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/StatisticSet
func (StatisticSet) GoString ¶
func (s StatisticSet) GoString() string
GoString returns the string representation
func (StatisticSet) String ¶
func (s StatisticSet) String() string
String returns the string representation
func (*StatisticSet) Validate ¶
func (s *StatisticSet) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StatusCode ¶ added in v0.4.0
type StatusCode string
const ( StatusCodeComplete StatusCode = "Complete" StatusCodeInternalError StatusCode = "InternalError" StatusCodePartialData StatusCode = "PartialData" )
Enum values for StatusCode
func (StatusCode) MarshalValue ¶ added in v0.4.0
func (enum StatusCode) MarshalValue() (string, error)
func (StatusCode) MarshalValueBuf ¶ added in v0.4.0
func (enum StatusCode) MarshalValueBuf(b []byte) ([]byte, error)
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. |