aws-sdk-go-v2: github.com/aws/aws-sdk-go-v2/service/cloudwatch Index | Files | Directories

package cloudwatch

import "github.com/aws/aws-sdk-go-v2/service/cloudwatch"

Package cloudwatch provides the API client, operations, and parameter types for 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.

Index

Package Files

api_client.go api_op_DeleteAlarms.go api_op_DeleteAnomalyDetector.go api_op_DeleteDashboards.go api_op_DeleteInsightRules.go api_op_DescribeAlarmHistory.go api_op_DescribeAlarms.go api_op_DescribeAlarmsForMetric.go api_op_DescribeAnomalyDetectors.go api_op_DescribeInsightRules.go api_op_DisableAlarmActions.go api_op_DisableInsightRules.go api_op_EnableAlarmActions.go api_op_EnableInsightRules.go api_op_GetDashboard.go api_op_GetInsightRuleReport.go api_op_GetMetricData.go api_op_GetMetricStatistics.go api_op_GetMetricWidgetImage.go api_op_ListDashboards.go api_op_ListMetrics.go api_op_ListTagsForResource.go api_op_PutAnomalyDetector.go api_op_PutCompositeAlarm.go api_op_PutDashboard.go api_op_PutInsightRule.go api_op_PutMetricAlarm.go api_op_PutMetricData.go api_op_SetAlarmState.go api_op_TagResource.go api_op_UntagResource.go deserializers.go doc.go endpoints.go serializers.go validators.go

Constants

const ServiceAPIVersion = "2010-08-01"
const ServiceID = "CloudWatch"

func NewDefaultEndpointResolver Uses

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

type Client Uses

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

Client provides the API client to make operations call for Amazon CloudWatch.

func New Uses

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

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

func NewFromConfig Uses

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

NewFromConfig returns a new client from the provided config.

func (*Client) DeleteAlarms Uses

func (c *Client) DeleteAlarms(ctx context.Context, params *DeleteAlarmsInput, optFns ...func(*Options)) (*DeleteAlarmsOutput, error)

Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation. In the event of an error, no alarms are deleted. It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete. To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False. Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

func (*Client) DeleteAnomalyDetector Uses

func (c *Client) DeleteAnomalyDetector(ctx context.Context, params *DeleteAnomalyDetectorInput, optFns ...func(*Options)) (*DeleteAnomalyDetectorOutput, error)

Deletes the specified anomaly detection model from your account.

func (*Client) DeleteDashboards Uses

func (c *Client) DeleteDashboards(ctx context.Context, params *DeleteDashboardsInput, optFns ...func(*Options)) (*DeleteDashboardsOutput, error)

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

func (*Client) DeleteInsightRules Uses

func (c *Client) DeleteInsightRules(ctx context.Context, params *DeleteInsightRulesInput, optFns ...func(*Options)) (*DeleteInsightRulesOutput, error)

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

func (*Client) DescribeAlarmHistory Uses

func (c *Client) DescribeAlarmHistory(ctx context.Context, params *DescribeAlarmHistoryInput, optFns ...func(*Options)) (*DescribeAlarmHistoryOutput, error)

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

func (*Client) DescribeAlarms Uses

func (c *Client) DescribeAlarms(ctx context.Context, params *DescribeAlarmsInput, optFns ...func(*Options)) (*DescribeAlarmsOutput, error)

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

func (*Client) DescribeAlarmsForMetric Uses

func (c *Client) DescribeAlarmsForMetric(ctx context.Context, params *DescribeAlarmsForMetricInput, optFns ...func(*Options)) (*DescribeAlarmsForMetricOutput, error)

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit. This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

func (*Client) DescribeAnomalyDetectors Uses

func (c *Client) DescribeAnomalyDetectors(ctx context.Context, params *DescribeAnomalyDetectorsInput, optFns ...func(*Options)) (*DescribeAnomalyDetectorsOutput, error)

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

func (*Client) DescribeInsightRules Uses

func (c *Client) DescribeInsightRules(ctx context.Context, params *DescribeInsightRulesInput, optFns ...func(*Options)) (*DescribeInsightRulesOutput, error)

Returns a list of all the Contributor Insights rules in your account. For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html).

func (*Client) DisableAlarmActions Uses

func (c *Client) DisableAlarmActions(ctx context.Context, params *DisableAlarmActionsInput, optFns ...func(*Options)) (*DisableAlarmActionsOutput, error)

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.

func (*Client) DisableInsightRules Uses

func (c *Client) DisableInsightRules(ctx context.Context, params *DisableInsightRulesInput, optFns ...func(*Options)) (*DisableInsightRulesOutput, error)

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

func (*Client) EnableAlarmActions Uses

func (c *Client) EnableAlarmActions(ctx context.Context, params *EnableAlarmActionsInput, optFns ...func(*Options)) (*EnableAlarmActionsOutput, error)

Enables the actions for the specified alarms.

func (*Client) EnableInsightRules Uses

func (c *Client) EnableInsightRules(ctx context.Context, params *EnableInsightRulesInput, optFns ...func(*Options)) (*EnableInsightRulesOutput, error)

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

func (*Client) GetDashboard Uses

func (c *Client) GetDashboard(ctx context.Context, params *GetDashboardInput, optFns ...func(*Options)) (*GetDashboardOutput, error)

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.

func (*Client) GetInsightRuleReport Uses

func (c *Client) GetInsightRuleReport(ctx context.Context, params *GetInsightRuleReportInput, optFns ...func(*Options)) (*GetInsightRuleReportOutput, error)

This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group. You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

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

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

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

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

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

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

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

func (*Client) GetMetricData Uses

func (c *Client) GetMetricData(ctx context.Context, params *GetMetricDataInput, optFns ...func(*Options)) (*GetMetricDataOutput, error)

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

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

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

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

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

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

func (*Client) GetMetricStatistics Uses

func (c *Client) GetMetricStatistics(ctx context.Context, params *GetMetricStatisticsInput, optFns ...func(*Options)) (*GetMetricStatisticsOutput, error)

Gets statistics for the specified metric. The maximum number of data points returned from a single call is 1,440. If

you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order. CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned. CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

* The SampleCount value of the statistic set is 1.

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

Percentile statistics are not available for metrics when any of the metric values are negative numbers. Amazon CloudWatch retains metric data as follows:

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

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

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

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

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour. CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016. For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html) in the Amazon CloudWatch User Guide.

func (*Client) GetMetricWidgetImage Uses

func (c *Client) GetMetricWidgetImage(ctx context.Context, params *GetMetricWidgetImageInput, optFns ...func(*Options)) (*GetMetricWidgetImageOutput, error)

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard. The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations. There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

* As many as 100 metrics in the graph.

* Up to 100 KB uncompressed payload.

func (*Client) ListDashboards Uses

func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

func (*Client) ListMetrics Uses

func (c *Client) ListMetrics(ctx context.Context, params *ListMetricsInput, optFns ...func(*Options)) (*ListMetricsOutput, error)

List the specified metrics. You can use the returned metrics with GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) to obtain statistical data. Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls. After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html). ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html).

func (*Client) ListTagsForResource Uses

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

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

func (*Client) PutAnomalyDetector Uses

func (c *Client) PutAnomalyDetector(ctx context.Context, params *PutAnomalyDetectorInput, optFns ...func(*Options)) (*PutAnomalyDetectorOutput, error)

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed. For more information, see CloudWatch Anomaly Detection (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html).

func (*Client) PutCompositeAlarm Uses

func (c *Client) PutCompositeAlarm(ctx context.Context, params *PutCompositeAlarmInput, optFns ...func(*Options)) (*PutCompositeAlarmOutput, error)

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met. The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms. Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state. Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics. It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete. To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False. Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

func (*Client) PutDashboard Uses

func (c *Client) PutDashboard(ctx context.Context, params *PutDashboardInput, optFns ...func(*Options)) (*PutDashboardOutput, error)

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here. All dashboards in your account are global, not region-specific. A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard. When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

func (*Client) PutInsightRule Uses

func (c *Client) PutInsightRule(ctx context.Context, params *PutInsightRuleInput, optFns ...func(*Options)) (*PutInsightRuleOutput, error)

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html). If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

func (*Client) PutMetricAlarm Uses

func (c *Client) PutMetricAlarm(ctx context.Context, params *PutMetricAlarmInput, optFns ...func(*Options)) (*PutMetricAlarmOutput, error)

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model. Alarms based on anomaly detection models cannot have Auto Scaling actions. When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

* 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

* No specific permissions are needed for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed. If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies. If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions. The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role).

func (*Client) PutMetricData Uses

func (c *Client) PutMetricData(ctx context.Context, params *PutMetricDataInput, optFns ...func(*Options)) (*PutMetricDataOutput, error)

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html). You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data. Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics. Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. 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. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html) in the Amazon CloudWatch User Guide. You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time. Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html) from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html) or GetMetricStatistics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html). CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

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

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

func (*Client) SetAlarmState Uses

func (c *Client) SetAlarmState(ctx context.Context, params *SetAlarmStateInput, optFns ...func(*Options)) (*SetAlarmStateOutput, error)

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html). If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration. If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

func (*Client) TagResource Uses

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms and Contributor Insights rules. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a CloudWatch resource.

func (*Client) UntagResource Uses

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes one or more tags from the specified resource.

type DeleteAlarmsInput Uses

type DeleteAlarmsInput struct {

    // The alarms to be deleted.
    //
    // This member is required.
    AlarmNames []string
}

type DeleteAlarmsOutput Uses

type DeleteAlarmsOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DeleteAnomalyDetectorInput Uses

type DeleteAnomalyDetectorInput struct {

    // The metric name associated with the anomaly detection model to delete.
    //
    // This member is required.
    MetricName *string

    // The namespace associated with the anomaly detection model to delete.
    //
    // This member is required.
    Namespace *string

    // The statistic associated with the anomaly detection model to delete.
    //
    // This member is required.
    Stat *string

    // The metric dimensions associated with the anomaly detection model to delete.
    Dimensions []types.Dimension
}

type DeleteAnomalyDetectorOutput Uses

type DeleteAnomalyDetectorOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DeleteDashboardsInput Uses

type DeleteDashboardsInput struct {

    // The dashboards to be deleted. This parameter is required.
    //
    // This member is required.
    DashboardNames []string
}

type DeleteDashboardsOutput Uses

type DeleteDashboardsOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DeleteInsightRulesInput Uses

type DeleteInsightRulesInput struct {

    // An array of the rule names to delete. If you need to find out the names of your
    // rules, use DescribeInsightRules
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html).
    //
    // This member is required.
    RuleNames []string
}

type DeleteInsightRulesOutput Uses

type DeleteInsightRulesOutput struct {

    // An array listing the rules that could not be deleted. You cannot delete built-in
    // rules.
    Failures []types.PartialFailure

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DescribeAlarmHistoryAPIClient Uses

type DescribeAlarmHistoryAPIClient interface {
    DescribeAlarmHistory(context.Context, *DescribeAlarmHistoryInput, ...func(*Options)) (*DescribeAlarmHistoryOutput, error)
}

DescribeAlarmHistoryAPIClient is a client that implements the DescribeAlarmHistory operation.

type DescribeAlarmHistoryInput Uses

type DescribeAlarmHistoryInput struct {

    // The name of the alarm.
    AlarmName *string

    // Use this parameter to specify whether you want the operation to return metric
    // alarms or composite alarms. If you omit this parameter, only metric alarms are
    // returned.
    AlarmTypes []types.AlarmType

    // The ending date to retrieve alarm history.
    EndDate *time.Time

    // The type of alarm histories to retrieve.
    HistoryItemType types.HistoryItemType

    // The maximum number of alarm history records to retrieve.
    MaxRecords *int32

    // The token returned by a previous call to indicate that there is more data
    // available.
    NextToken *string

    // Specified whether to return the newest or oldest alarm history first. Specify
    // TimestampDescending to have the newest event history returned first, and specify
    // TimestampAscending to have the oldest history returned first.
    ScanBy types.ScanBy

    // The starting date to retrieve alarm history.
    StartDate *time.Time
}

type DescribeAlarmHistoryOutput Uses

type DescribeAlarmHistoryOutput struct {

    // The alarm histories, in JSON format.
    AlarmHistoryItems []types.AlarmHistoryItem

    // The token that marks the start of the next batch of returned results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DescribeAlarmHistoryPaginator Uses

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

DescribeAlarmHistoryPaginator is a paginator for DescribeAlarmHistory

func NewDescribeAlarmHistoryPaginator Uses

func NewDescribeAlarmHistoryPaginator(client DescribeAlarmHistoryAPIClient, params *DescribeAlarmHistoryInput, optFns ...func(*DescribeAlarmHistoryPaginatorOptions)) *DescribeAlarmHistoryPaginator

NewDescribeAlarmHistoryPaginator returns a new DescribeAlarmHistoryPaginator

func (*DescribeAlarmHistoryPaginator) HasMorePages Uses

func (p *DescribeAlarmHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeAlarmHistoryPaginator) NextPage Uses

func (p *DescribeAlarmHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAlarmHistoryOutput, error)

NextPage retrieves the next DescribeAlarmHistory page.

type DescribeAlarmHistoryPaginatorOptions Uses

type DescribeAlarmHistoryPaginatorOptions struct {
    // The maximum number of alarm history records to retrieve.
    Limit int32

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

DescribeAlarmHistoryPaginatorOptions is the paginator options for DescribeAlarmHistory

type DescribeAlarmsAPIClient Uses

type DescribeAlarmsAPIClient interface {
    DescribeAlarms(context.Context, *DescribeAlarmsInput, ...func(*Options)) (*DescribeAlarmsOutput, error)
}

DescribeAlarmsAPIClient is a client that implements the DescribeAlarms operation.

type DescribeAlarmsForMetricInput Uses

type DescribeAlarmsForMetricInput struct {

    // The name of the metric.
    //
    // This member is required.
    MetricName *string

    // The namespace of the metric.
    //
    // This member is required.
    Namespace *string

    // 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 []types.Dimension

    // The percentile statistic for the metric. Specify a value between p0.0 and p100.
    ExtendedStatistic *string

    // The period, in seconds, over which the statistic is applied.
    Period *int32

    // The statistic for the metric, other than percentiles. For percentile statistics,
    // use ExtendedStatistics.
    Statistic types.Statistic

    // The unit for the metric.
    Unit types.StandardUnit
}

type DescribeAlarmsForMetricOutput Uses

type DescribeAlarmsForMetricOutput struct {

    // The information for each alarm with the specified metric.
    MetricAlarms []types.MetricAlarm

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DescribeAlarmsInput Uses

type DescribeAlarmsInput struct {

    // Use this parameter to filter the results of the operation to only those alarms
    // that use a certain alarm action. For example, you could specify the ARN of an
    // SNS topic to find all alarms that send notifications to that topic.
    ActionPrefix *string

    // An alarm name prefix. If you specify this parameter, you receive information
    // about all alarms that have names that start with this prefix. If this parameter
    // is specified, you cannot specify AlarmNames.
    AlarmNamePrefix *string

    // The names of the alarms to retrieve information about.
    AlarmNames []string

    // Use this parameter to specify whether you want the operation to return metric
    // alarms or composite alarms. If you omit this parameter, only metric alarms are
    // returned.
    AlarmTypes []types.AlarmType

    // If you use this parameter and specify the name of a composite alarm, the
    // operation returns information about the "children" alarms of the alarm you
    // specify. These are the metric alarms and composite alarms referenced in the
    // AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName.
    // Information about the composite alarm that you name in ChildrenOfAlarmName is
    // not returned. If you specify ChildrenOfAlarmName, you cannot specify any other
    // parameters in the request except for MaxRecords and NextToken. If you do so, you
    // receive a validation error. Only the Alarm Name, ARN, StateValue
    // (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned
    // by this operation when you use this parameter. To get complete information about
    // these alarms, perform another DescribeAlarms operation and specify the parent
    // alarm names in the AlarmNames parameter.
    ChildrenOfAlarmName *string

    // The maximum number of alarm descriptions to retrieve.
    MaxRecords *int32

    // The token returned by a previous call to indicate that there is more data
    // available.
    NextToken *string

    // If you use this parameter and specify the name of a metric or composite alarm,
    // the operation returns information about the "parent" alarms of the alarm you
    // specify. These are the composite alarms that have AlarmRule parameters that
    // reference the alarm named in ParentsOfAlarmName. Information about the alarm
    // that you specify in ParentsOfAlarmName is not returned. If you specify
    // ParentsOfAlarmName, you cannot specify any other parameters in the request
    // except for MaxRecords and NextToken. If you do so, you receive a validation
    // error. Only the Alarm Name and ARN are returned by this operation when you use
    // this parameter. To get complete information about these alarms, perform another
    // DescribeAlarms operation and specify the parent alarm names in the AlarmNames
    // parameter.
    ParentsOfAlarmName *string

    // Specify this parameter to receive information only about alarms that are
    // currently in the state that you specify.
    StateValue types.StateValue
}

type DescribeAlarmsOutput Uses

type DescribeAlarmsOutput struct {

    // The information about any composite alarms returned by the operation.
    CompositeAlarms []types.CompositeAlarm

    // The information about any metric alarms returned by the operation.
    MetricAlarms []types.MetricAlarm

    // The token that marks the start of the next batch of returned results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DescribeAlarmsPaginator Uses

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

DescribeAlarmsPaginator is a paginator for DescribeAlarms

func NewDescribeAlarmsPaginator Uses

func NewDescribeAlarmsPaginator(client DescribeAlarmsAPIClient, params *DescribeAlarmsInput, optFns ...func(*DescribeAlarmsPaginatorOptions)) *DescribeAlarmsPaginator

NewDescribeAlarmsPaginator returns a new DescribeAlarmsPaginator

func (*DescribeAlarmsPaginator) HasMorePages Uses

func (p *DescribeAlarmsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeAlarmsPaginator) NextPage Uses

func (p *DescribeAlarmsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeAlarmsOutput, error)

NextPage retrieves the next DescribeAlarms page.

type DescribeAlarmsPaginatorOptions Uses

type DescribeAlarmsPaginatorOptions struct {
    // The maximum number of alarm descriptions to retrieve.
    Limit int32

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

DescribeAlarmsPaginatorOptions is the paginator options for DescribeAlarms

type DescribeAnomalyDetectorsInput Uses

type DescribeAnomalyDetectorsInput struct {

    // Limits the results to only the anomaly detection models that are associated with
    // the specified metric dimensions. If there are multiple metrics that have these
    // dimensions and have anomaly detection models associated, they're all returned.
    Dimensions []types.Dimension

    // The maximum number of results to return in one operation. The maximum value that
    // you can specify is 100. To retrieve the remaining results, make another call
    // with the returned NextToken value.
    MaxResults *int32

    // Limits the results to only the anomaly detection models that are associated with
    // the specified metric name. If there are multiple metrics with this name in
    // different namespaces that have anomaly detection models, they're all returned.
    MetricName *string

    // Limits the results to only the anomaly detection models that are associated with
    // the specified namespace.
    Namespace *string

    // Use the token returned by the previous operation to request the next page of
    // results.
    NextToken *string
}

type DescribeAnomalyDetectorsOutput Uses

type DescribeAnomalyDetectorsOutput struct {

    // The list of anomaly detection models returned by the operation.
    AnomalyDetectors []types.AnomalyDetector

    // A token that you can use in a subsequent operation to retrieve the next set of
    // results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DescribeInsightRulesAPIClient Uses

type DescribeInsightRulesAPIClient interface {
    DescribeInsightRules(context.Context, *DescribeInsightRulesInput, ...func(*Options)) (*DescribeInsightRulesOutput, error)
}

DescribeInsightRulesAPIClient is a client that implements the DescribeInsightRules operation.

type DescribeInsightRulesInput Uses

type DescribeInsightRulesInput struct {

    // The maximum number of results to return in one operation. If you omit this
    // parameter, the default of 500 is used.
    MaxResults *int32

    // Include this value, if it was returned by the previous operation, to get the
    // next set of rules.
    NextToken *string
}

type DescribeInsightRulesOutput Uses

type DescribeInsightRulesOutput struct {

    // The rules returned by the operation.
    InsightRules []types.InsightRule

    // If this parameter is present, it is a token that marks the start of the next
    // batch of returned results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DescribeInsightRulesPaginator Uses

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

DescribeInsightRulesPaginator is a paginator for DescribeInsightRules

func NewDescribeInsightRulesPaginator Uses

func NewDescribeInsightRulesPaginator(client DescribeInsightRulesAPIClient, params *DescribeInsightRulesInput, optFns ...func(*DescribeInsightRulesPaginatorOptions)) *DescribeInsightRulesPaginator

NewDescribeInsightRulesPaginator returns a new DescribeInsightRulesPaginator

func (*DescribeInsightRulesPaginator) HasMorePages Uses

func (p *DescribeInsightRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeInsightRulesPaginator) NextPage Uses

func (p *DescribeInsightRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInsightRulesOutput, error)

NextPage retrieves the next DescribeInsightRules page.

type DescribeInsightRulesPaginatorOptions Uses

type DescribeInsightRulesPaginatorOptions struct {
    // The maximum number of results to return in one operation. If you omit this
    // parameter, the default of 500 is used.
    Limit int32

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

DescribeInsightRulesPaginatorOptions is the paginator options for DescribeInsightRules

type DisableAlarmActionsInput Uses

type DisableAlarmActionsInput struct {

    // The names of the alarms.
    //
    // This member is required.
    AlarmNames []string
}

type DisableAlarmActionsOutput Uses

type DisableAlarmActionsOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type DisableInsightRulesInput Uses

type DisableInsightRulesInput struct {

    // An array of the rule names to disable. If you need to find out the names of your
    // rules, use DescribeInsightRules
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html).
    //
    // This member is required.
    RuleNames []string
}

type DisableInsightRulesOutput Uses

type DisableInsightRulesOutput struct {

    // An array listing the rules that could not be disabled. You cannot disable
    // built-in rules.
    Failures []types.PartialFailure

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type EnableAlarmActionsInput Uses

type EnableAlarmActionsInput struct {

    // The names of the alarms.
    //
    // This member is required.
    AlarmNames []string
}

type EnableAlarmActionsOutput Uses

type EnableAlarmActionsOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type EnableInsightRulesInput Uses

type EnableInsightRulesInput struct {

    // An array of the rule names to enable. If you need to find out the names of your
    // rules, use DescribeInsightRules
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html).
    //
    // This member is required.
    RuleNames []string
}

type EnableInsightRulesOutput Uses

type EnableInsightRulesOutput struct {

    // An array listing the rules that could not be enabled. You cannot disable or
    // enable built-in rules.
    Failures []types.PartialFailure

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type EndpointResolver Uses

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver Uses

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc Uses

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

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

func (EndpointResolverFunc) ResolveEndpoint Uses

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

type EndpointResolverOptions Uses

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetDashboardInput Uses

type GetDashboardInput struct {

    // The name of the dashboard to be described.
    //
    // This member is required.
    DashboardName *string
}

type GetDashboardOutput Uses

type GetDashboardOutput struct {

    // The Amazon Resource Name (ARN) of the dashboard.
    DashboardArn *string

    // The detailed information about the dashboard, including what widgets are
    // included and their location on the dashboard. For more information about the
    // DashboardBody syntax, see Dashboard Body Structure and Syntax
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html).
    DashboardBody *string

    // The name of the dashboard.
    DashboardName *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type GetInsightRuleReportInput Uses

type GetInsightRuleReportInput struct {

    // The end time of the data to use in the report. When used in a raw HTTP Query
    // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
    //
    // This member is required.
    EndTime *time.Time

    // The period, in seconds, to use for the statistics in the
    // InsightRuleMetricDatapoint results.
    //
    // This member is required.
    Period *int32

    // The name of the rule that you want to see data from.
    //
    // This member is required.
    RuleName *string

    // The start time of the data to use in the report. When used in a raw HTTP Query
    // API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
    //
    // This member is required.
    StartTime *time.Time

    // The maximum number of contributors to include in the report. The range is 1 to
    // 100. If you omit this, the default of 10 is used.
    MaxContributorCount *int32

    // Specifies which metrics to use for aggregation of contributor values for the
    // report. You can specify one or more of the following metrics:
    //
    // *
    // UniqueContributors -- the number of unique contributors for each data point.
    //
    // *
    // MaxContributorValue -- the value of the top contributor for each data point. The
    // identity of the contributor might change for each data point in the graph. If
    // this rule aggregates by COUNT, the top contributor for each data point is the
    // contributor with the most occurrences in that period. If the rule aggregates by
    // SUM, the top contributor is the contributor with the highest sum in the log
    // field specified by the rule's Value, during that period.
    //
    // * SampleCount -- the
    // number of data points matched by the rule.
    //
    // * Sum -- the sum of the values from
    // all contributors during the time period represented by that data point.
    //
    // *
    // Minimum -- the minimum value from a single observation during the time period
    // represented by that data point.
    //
    // * Maximum -- the maximum value from a single
    // observation during the time period represented by that data point.
    //
    // * Average --
    // the average value from all contributors during the time period represented by
    // that data point.
    Metrics []string

    // Determines what statistic to use to rank the contributors. Valid values are SUM
    // and MAXIMUM.
    OrderBy *string
}

type GetInsightRuleReportOutput Uses

type GetInsightRuleReportOutput struct {

    // The sum of the values from all individual contributors that match the rule.
    AggregateValue *float64

    // Specifies whether this rule aggregates contributor data by COUNT or SUM.
    AggregationStatistic *string

    // An approximate count of the unique contributors found by this rule in this time
    // period.
    ApproximateUniqueCount *int64

    // An array of the unique contributors found by this rule in this time period. If
    // the rule contains multiple keys, each combination of values for the keys counts
    // as a unique contributor.
    Contributors []types.InsightRuleContributor

    // An array of the strings used as the keys for this rule. The keys are the
    // dimensions used to classify contributors. If the rule contains more than one
    // key, then each unique combination of values for the keys is counted as a unique
    // contributor.
    KeyLabels []string

    // A time series of metric data points that matches the time period in the rule
    // request.
    MetricDatapoints []types.InsightRuleMetricDatapoint

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type GetMetricDataAPIClient Uses

type GetMetricDataAPIClient interface {
    GetMetricData(context.Context, *GetMetricDataInput, ...func(*Options)) (*GetMetricDataOutput, error)
}

GetMetricDataAPIClient is a client that implements the GetMetricData operation.

type GetMetricDataInput Uses

type GetMetricDataInput struct {

    // The time stamp indicating the latest data to be returned. The value specified is
    // exclusive; results include data points up to the specified time stamp. For
    // better performance, specify StartTime and EndTime values that align with the
    // value of the metric's Period and sync up with the beginning and end of an hour.
    // For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30
    // as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29
    // as the EndTime.
    //
    // This member is required.
    EndTime *time.Time

    // The metric queries to be returned. A single GetMetricData call can include as
    // many as 500 MetricDataQuery structures. Each of these structures can specify
    // either a metric to retrieve, or a math expression to perform on retrieved data.
    //
    // This member is required.
    MetricDataQueries []types.MetricDataQuery

    // The time stamp indicating the earliest data to be returned. The value specified
    // is inclusive; results include data points with the specified time stamp.
    // CloudWatch rounds the specified time stamp as follows:
    //
    // * Start time less than
    // 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is
    // rounded down to 12:32:00.
    //
    // * Start time between 15 and 63 days ago - Round down
    // to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to
    // 12:30:00.
    //
    // * Start time greater than 63 days ago - Round down to the nearest
    // 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
    //
    // If
    // you set Period to 5, 10, or 30, the start time of your request is rounded down
    // to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of
    // a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the
    // previous 10-second period, the start time of your request is rounded down and
    // you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for
    // the previous 5 minutes of data, using a period of 5 seconds, you receive data
    // timestamped between 15:02:15 and 15:07:15. For better performance, specify
    // StartTime and EndTime values that align with the value of the metric's Period
    // and sync up with the beginning and end of an hour. For example, if the Period of
    // a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster
    // response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
    //
    // This member is required.
    StartTime *time.Time

    // The maximum number of data points the request should return before paginating.
    // If you omit this, the default of 100,800 is used.
    MaxDatapoints *int32

    // Include this value, if it was returned by the previous GetMetricData operation,
    // to get the next set of data points.
    NextToken *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 types.ScanBy
}

type GetMetricDataOutput Uses

type GetMetricDataOutput struct {

    // Contains a message about this GetMetricData operation, if the operation results
    // in such a message. An example of a message that might be returned is Maximum
    // number of allowed metrics exceeded. If there is a message, as much of the
    // operation as possible is still executed. A message appears here only if it is
    // related to the global GetMetricData operation. Any message about a specific
    // metric returned by the operation appears in the MetricDataResult object returned
    // for that metric.
    Messages []types.MessageData

    // The metrics that are returned, including the metric name, namespace, and
    // dimensions.
    MetricDataResults []types.MetricDataResult

    // A token that marks the next batch of returned results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type GetMetricDataPaginator Uses

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

GetMetricDataPaginator is a paginator for GetMetricData

func NewGetMetricDataPaginator Uses

func NewGetMetricDataPaginator(client GetMetricDataAPIClient, params *GetMetricDataInput, optFns ...func(*GetMetricDataPaginatorOptions)) *GetMetricDataPaginator

NewGetMetricDataPaginator returns a new GetMetricDataPaginator

func (*GetMetricDataPaginator) HasMorePages Uses

func (p *GetMetricDataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetMetricDataPaginator) NextPage Uses

func (p *GetMetricDataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetMetricDataOutput, error)

NextPage retrieves the next GetMetricData page.

type GetMetricDataPaginatorOptions Uses

type GetMetricDataPaginatorOptions struct {
    // The maximum number of data points the request should return before paginating.
    // If you omit this, the default of 100,800 is used.
    Limit int32

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

GetMetricDataPaginatorOptions is the paginator options for GetMetricData

type GetMetricStatisticsInput Uses

type GetMetricStatisticsInput struct {

    // The time stamp that determines the last data point to return. The value
    // specified is exclusive; results include data points up to the specified time
    // stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for
    // example, 2016-10-10T23:00:00Z).
    //
    // This member is required.
    EndTime *time.Time

    // The name of the metric, with or without spaces.
    //
    // This member is required.
    MetricName *string

    // The namespace of the metric, with or without spaces.
    //
    // This member is required.
    Namespace *string

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

    // The time stamp that determines the first data point to return. Start times are
    // evaluated relative to the time that CloudWatch receives the request. The value
    // specified is inclusive; results include data points with the specified time
    // stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for
    // example, 2016-10-03T23:00:00Z). CloudWatch rounds the specified time stamp as
    // follows:
    //
    // * Start time less than 15 days ago - Round down to the nearest whole
    // minute. For example, 12:32:34 is rounded down to 12:32:00.
    //
    // * Start time between
    // 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For
    // example, 12:32:34 is rounded down to 12:30:00.
    //
    // * Start time greater than 63
    // days ago - Round down to the nearest 1-hour clock interval. For example,
    // 12:32:34 is rounded down to 12:00:00.
    //
    // If you set Period to 5, 10, or 30, the
    // start time of your request is rounded down to the nearest time that corresponds
    // to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a
    // query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time
    // of your request is rounded down and you receive data from 01:05:10 to 01:05:20.
    // If you make a query at 15:07:17 for the previous 5 minutes of data, using a
    // period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
    //
    // This member is required.
    StartTime *time.Time

    // The dimensions. If the metric contains multiple dimensions, you must include a
    // value for each dimension. CloudWatch treats each unique combination of
    // dimensions as a separate metric. If a specific combination of dimensions was not
    // published, you can't retrieve statistics for it. You must specify the same
    // dimensions that were used when the metrics were created. For an example, see
    // Dimension Combinations
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations)
    // in the Amazon CloudWatch User Guide. For more information about specifying
    // dimensions, see Publishing Metrics
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)
    // in the Amazon CloudWatch User Guide.
    Dimensions []types.Dimension

    // The percentile statistics. Specify values between p0.0 and p100. When calling
    // GetMetricStatistics, you must specify either Statistics or ExtendedStatistics,
    // but not both. Percentile statistics are not available for metrics when any of
    // the metric values are negative numbers.
    ExtendedStatistics []string

    // 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 []types.Statistic

    // The unit for a given metric. If you omit Unit, all data that was collected with
    // any unit is returned, along with the corresponding units that were specified
    // when the data was reported to CloudWatch. If you specify a unit, the operation
    // returns only data that was collected with that unit specified. If you specify a
    // unit that does not match the data collected, the results of the operation are
    // null. CloudWatch does not perform unit conversions.
    Unit types.StandardUnit
}

type GetMetricStatisticsOutput Uses

type GetMetricStatisticsOutput struct {

    // The data points for the specified metric.
    Datapoints []types.Datapoint

    // A label for the specified metric.
    Label *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type GetMetricWidgetImageInput Uses

type GetMetricWidgetImageInput struct {

    // A JSON string that defines the bitmap graph to be retrieved. The string includes
    // the metrics to include in the graph, statistics, annotations, title, axis
    // limits, and so on. You can include only one MetricWidget parameter in each
    // GetMetricWidgetImage call. For more information about the syntax of MetricWidget
    // see GetMetricWidgetImage: Metric Widget Structure and Syntax
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html).
    // If any metric on the graph could not load all the requested data points, an
    // orange triangle with an exclamation point appears next to the graph legend.
    //
    // This member is required.
    MetricWidget *string

    // The format of the resulting image. Only PNG images are supported. The default is
    // png. If you specify png, the API returns an HTTP response with the content-type
    // set to text/xml. The image data is in a MetricWidgetImage field. For example:
    // <GetMetricWidgetImageResponse xmlns=>
    //
    //
    // iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
    //
    //
    // 6f0d4192-4d42-11e8-82c1-f539a07e0e3b
    //
    // The image/png setting is intended only for
    // custom HTTP requests. For most use cases, and all actions using an AWS SDK, you
    // should use png. If you specify image/png, the HTTP response has a content-type
    // set to image/png, and the body of the response is a PNG image.
    OutputFormat *string
}

type GetMetricWidgetImageOutput Uses

type GetMetricWidgetImageOutput struct {

    // The image of the graph, in the output format specified. The output is
    // base64-encoded.
    MetricWidgetImage []byte

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type HTTPClient Uses

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

type HTTPSignerV4 Uses

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

type ListDashboardsAPIClient Uses

type ListDashboardsAPIClient interface {
    ListDashboards(context.Context, *ListDashboardsInput, ...func(*Options)) (*ListDashboardsOutput, error)
}

ListDashboardsAPIClient is a client that implements the ListDashboards operation.

type ListDashboardsInput Uses

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

    // The token returned by a previous call to indicate that there is more data
    // available.
    NextToken *string
}

type ListDashboardsOutput Uses

type ListDashboardsOutput struct {

    // The list of matching dashboards.
    DashboardEntries []types.DashboardEntry

    // The token that marks the start of the next batch of returned results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type ListDashboardsPaginator Uses

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

ListDashboardsPaginator is a paginator for ListDashboards

func NewListDashboardsPaginator Uses

func NewListDashboardsPaginator(client ListDashboardsAPIClient, params *ListDashboardsInput, optFns ...func(*ListDashboardsPaginatorOptions)) *ListDashboardsPaginator

NewListDashboardsPaginator returns a new ListDashboardsPaginator

func (*ListDashboardsPaginator) HasMorePages Uses

func (p *ListDashboardsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDashboardsPaginator) NextPage Uses

func (p *ListDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDashboardsOutput, error)

NextPage retrieves the next ListDashboards page.

type ListDashboardsPaginatorOptions Uses

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

ListDashboardsPaginatorOptions is the paginator options for ListDashboards

type ListMetricsAPIClient Uses

type ListMetricsAPIClient interface {
    ListMetrics(context.Context, *ListMetricsInput, ...func(*Options)) (*ListMetricsOutput, error)
}

ListMetricsAPIClient is a client that implements the ListMetrics operation.

type ListMetricsInput Uses

type ListMetricsInput struct {

    // The dimensions to filter against. Only the dimensions that match exactly will be
    // returned.
    Dimensions []types.DimensionFilter

    // The name of the metric to filter against. Only the metrics with names that match
    // exactly will be returned.
    MetricName *string

    // The metric namespace to filter against. Only the namespace that matches exactly
    // will be returned.
    Namespace *string

    // The token returned by a previous call to indicate that there is more data
    // available.
    NextToken *string

    // To filter the results to show only metrics that have had data points published
    // in the past three hours, specify this parameter with a value of PT3H. This is
    // the only valid value for this parameter. The results that are returned are an
    // approximation of the value you specify. There is a low probability that the
    // returned results include metrics with last published data as much as 40 minutes
    // more than the specified time interval.
    RecentlyActive types.RecentlyActive
}

type ListMetricsOutput Uses

type ListMetricsOutput struct {

    // The metrics that match your request.
    Metrics []types.Metric

    // The token that marks the start of the next batch of returned results.
    NextToken *string

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type ListMetricsPaginator Uses

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

ListMetricsPaginator is a paginator for ListMetrics

func NewListMetricsPaginator Uses

func NewListMetricsPaginator(client ListMetricsAPIClient, params *ListMetricsInput, optFns ...func(*ListMetricsPaginatorOptions)) *ListMetricsPaginator

NewListMetricsPaginator returns a new ListMetricsPaginator

func (*ListMetricsPaginator) HasMorePages Uses

func (p *ListMetricsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMetricsPaginator) NextPage Uses

func (p *ListMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMetricsOutput, error)

NextPage retrieves the next ListMetrics page.

type ListMetricsPaginatorOptions Uses

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

ListMetricsPaginatorOptions is the paginator options for ListMetrics

type ListTagsForResourceInput Uses

type ListTagsForResourceInput struct {

    // The ARN of the CloudWatch resource that you want to view tags for. The ARN
    // format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name  The
    // ARN format of a Contributor Insights rule is
    // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name  For more
    // information about ARN format, see  Resource Types Defined by Amazon CloudWatch
    // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
    // in the Amazon Web Services General Reference.
    //
    // This member is required.
    ResourceARN *string
}

type ListTagsForResourceOutput Uses

type ListTagsForResourceOutput struct {

    // The list of tag keys and values associated with the resource you specified.
    Tags []types.Tag

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type Options Uses

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

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

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

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

    // The service endpoint resolver.
    EndpointResolver EndpointResolver

    // Signature Version 4 (SigV4) Signer
    HTTPSignerV4 HTTPSignerV4

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

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

    // Retryer guides how HTTP requests should be retried in case of recoverable
    // failures. When nil the API client will use a default retryer.
    Retryer retry.Retryer

    // The HTTP client to invoke API calls with. Defaults to client's default HTTP
    // implementation if nil.
    HTTPClient HTTPClient
}

func (Options) Copy Uses

func (o Options) Copy() Options

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

type PutAnomalyDetectorInput Uses

type PutAnomalyDetectorInput struct {

    // The name of the metric to create the anomaly detection model for.
    //
    // This member is required.
    MetricName *string

    // The namespace of the metric to create the anomaly detection model for.
    //
    // This member is required.
    Namespace *string

    // The statistic to use for the metric and the anomaly detection model.
    //
    // This member is required.
    Stat *string

    // The configuration specifies details about how the anomaly detection model is to
    // be trained, including time ranges to exclude when training and updating the
    // model. You can specify as many as 10 time ranges. The configuration can also
    // include the time zone to use for the metric.
    Configuration *types.AnomalyDetectorConfiguration

    // The metric dimensions to create the anomaly detection model for.
    Dimensions []types.Dimension
}

type PutAnomalyDetectorOutput Uses

type PutAnomalyDetectorOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type PutCompositeAlarmInput Uses

type PutCompositeAlarmInput struct {

    // The name for the composite alarm. This name must be unique within the Region.
    //
    // This member is required.
    AlarmName *string

    // An expression that specifies which other alarms are to be evaluated to determine
    // this composite alarm's state. For each alarm that you reference, you designate a
    // function that specifies whether that alarm needs to be in ALARM state, OK state,
    // or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine
    // multiple functions in a single expression. You can use parenthesis to logically
    // group the functions in your expression. You can use either alarm names or ARNs
    // to reference the other alarms that are to be evaluated. Functions can include
    // the following:
    //
    // * ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is
    // in ALARM state.
    //
    // * OK("alarm-name or alarm-ARN") is TRUE if the named alarm is
    // in OK state.
    //
    // * INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the
    // named alarm is in INSUFFICIENT_DATA state.
    //
    // * TRUE always evaluates to TRUE.
    //
    // *
    // FALSE always evaluates to FALSE.
    //
    // TRUE and FALSE are useful for testing a
    // complex AlarmRule structure, and for testing your alarm actions. Alarm names
    // specified in AlarmRule can be surrounded with double-quotes ("), but do not have
    // to be. The following are some examples of AlarmRule:
    //
    // *
    // ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh) specifies that the
    // composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and
    // DiskReadOpsTooHigh alarms are in ALARM state.
    //
    // * ALARM(CPUUtilizationTooHigh)
    // AND NOT ALARM(DeploymentInProgress) specifies that the alarm goes to ALARM state
    // if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in
    // ALARM state. This example reduces alarm noise during a known deployment
    // window.
    //
    // * (ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND
    // OK(NetworkOutTooHigh) goes into ALARM state if CPUUtilizationTooHigh OR
    // DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state.
    // This provides another example of using a composite alarm to prevent noise. This
    // rule ensures that you are not notified with an alarm action on high CPU or disk
    // usage if a known network problem is also occurring.
    //
    // The AlarmRule can specify
    // as many as 100 "children" alarms. The AlarmRule expression can have as many as
    // 500 elements. Elements are child alarms, TRUE or FALSE statements, and
    // parentheses.
    //
    // This member is required.
    AlarmRule *string

    // Indicates whether actions should be executed during any changes to the alarm
    // state of the composite alarm. The default is TRUE.
    ActionsEnabled *bool

    // The actions to execute when this alarm transitions to the ALARM state from any
    // other state. Each action is specified as an Amazon Resource Name (ARN). Valid
    // Values: arn:aws:sns:region:account-id:sns-topic-name
    AlarmActions []string

    // The description for the composite alarm.
    AlarmDescription *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:sns:region:account-id:sns-topic-name
    InsufficientDataActions []string

    // The actions to execute when this alarm transitions to an OK state from any other
    // state. Each action is specified as an Amazon Resource Name (ARN). Valid Values:
    // arn:aws:sns:region:account-id:sns-topic-name
    OKActions []string

    // A list of key-value pairs to associate with the composite alarm. You can
    // associate as many as 50 tags with an alarm. Tags can help you organize and
    // categorize your resources. You can also use them to scope user permissions, by
    // granting a user permission to access or change only resources with certain tag
    // values.
    Tags []types.Tag
}

type PutCompositeAlarmOutput Uses

type PutCompositeAlarmOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type PutDashboardInput Uses

type PutDashboardInput struct {

    // The detailed information about the dashboard in JSON format, including the
    // widgets to include and their location on the dashboard. This parameter is
    // required. For more information about the syntax, see Dashboard Body Structure
    // and Syntax
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html).
    //
    // This member is required.
    DashboardBody *string

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

type PutDashboardOutput Uses

type PutDashboardOutput struct {

    // If the input for PutDashboard was correct and the dashboard was successfully
    // created or modified, this result is empty. If this result includes only warning
    // messages, then the input was valid enough for the dashboard to be created or
    // modified, but some elements of the dashboard might not render. If this result
    // includes error messages, the input was not valid and the operation failed.
    DashboardValidationMessages []types.DashboardValidationMessage

    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type PutInsightRuleInput Uses

type PutInsightRuleInput struct {

    // The definition of the rule, as a JSON object. For details on the valid syntax,
    // see Contributor Insights Rule Syntax
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html).
    //
    // This member is required.
    RuleDefinition *string

    // A unique name for the rule.
    //
    // This member is required.
    RuleName *string

    // The state of the rule. Valid values are ENABLED and DISABLED.
    RuleState *string

    // A list of key-value pairs to associate with the Contributor Insights rule. You
    // can associate as many as 50 tags with a rule. Tags can help you organize and
    // categorize your resources. You can also use them to scope user permissions, by
    // granting a user permission to access or change only the resources that have
    // certain tag values. To be able to associate tags with a rule, you must have the
    // cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule
    // permission. If you are using this operation to update an existing Contributor
    // Insights rule, any tags you specify in this parameter are ignored. To change the
    // tags of an existing rule, use TagResource
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html).
    Tags []types.Tag
}

type PutInsightRuleOutput Uses

type PutInsightRuleOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type PutMetricAlarmInput Uses

type PutMetricAlarmInput struct {

    // The name for the alarm. This name must be unique within the Region.
    //
    // This member is required.
    AlarmName *string

    // The arithmetic operation to use when comparing the specified statistic and
    // threshold. The specified statistic value is used as the first operand. The
    // values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and
    // GreaterThanUpperThreshold are used only for alarms based on anomaly detection
    // models.
    //
    // This member is required.
    ComparisonOperator types.ComparisonOperator

    // The number of periods over which data is compared to the specified threshold. If
    // you are setting an alarm that requires that a number of consecutive data points
    // be breaching to trigger the alarm, this value specifies that number. If you are
    // setting an "M out of N" alarm, this value is the N. An alarm's total current
    // evaluation period can be no longer than one day, so this number multiplied by
    // Period cannot be more than 86,400 seconds.
    //
    // This member is required.
    EvaluationPeriods *int32

    // Indicates whether actions should be executed during any changes to the alarm
    // state. The default is TRUE.
    ActionsEnabled *bool

    // The actions to execute when this alarm transitions to the ALARM state from any
    // other state. Each action is specified as an Amazon Resource Name (ARN). Valid
    // Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate
    // | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot |
    // arn:aws:sns:region:account-id:sns-topic-name  |
    // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
    // 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

    // The description for the alarm.
    AlarmDescription *string

    // The number of data points that must be breaching to trigger the alarm. This is
    // used only if you are setting an "M out of N" alarm. In that case, this value is
    // the M. For more information, see Evaluating an Alarm
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation)
    // in the Amazon CloudWatch User Guide.
    DatapointsToAlarm *int32

    // The dimensions for the metric specified in MetricName.
    Dimensions []types.Dimension

    // Used only for alarms based on percentiles. If you specify ignore, the alarm
    // state does not change during periods with too few data points to be
    // statistically significant. If you specify evaluate or omit this parameter, the
    // alarm is always evaluated and possibly changes state no matter how many data
    // points are available. For more information, see Percentile-Based CloudWatch
    // Alarms and Low Data Samples
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples).
    // Valid Values: evaluate | ignore
    EvaluateLowSampleCountPercentile *string

    // The percentile statistic for the metric specified in MetricName. Specify a value
    // between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName,
    // you must specify either Statistic or ExtendedStatistic, but not both.
    ExtendedStatistic *string

    // The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
    // state from any other state. Each action is specified as an Amazon Resource Name
    // (ARN). Valid Values: arn:aws:automate:region:ec2:stop |
    // arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover |
    // arn:aws:automate:region:ec2:reboot |
    // arn:aws:sns:region:account-id:sns-topic-name  |
    // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
    // Valid Values (for use with IAM roles):
    // >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |
    // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |
    // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
    InsufficientDataActions []string

    // The name for the metric associated with the alarm. For each PutMetricAlarm
    // operation, you must specify either MetricName or a Metrics array. If you are
    // creating an alarm based on a math expression, you cannot specify this parameter,
    // or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic
    // parameters. Instead, you specify all this information in the Metrics array.
    MetricName *string

    // An array of MetricDataQuery structures that enable you to create an alarm based
    // on the result of a metric math expression. For each PutMetricAlarm operation,
    // you must specify either MetricName or a Metrics array. Each item in the Metrics
    // array either retrieves a metric or performs a math expression. One item in the
    // Metrics array is the expression that the alarm watches. You designate this
    // expression by setting ReturnData to true for this object in the array. For more
    // information, see MetricDataQuery
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html).
    // If you use the Metrics parameter, you cannot include the MetricName, Dimensions,
    // Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm
    // in the same operation. Instead, you retrieve the metrics you are using in your
    // math expression as part of the Metrics array.
    Metrics []types.MetricDataQuery

    // The namespace for the metric associated specified in MetricName.
    Namespace *string

    // The actions to execute when this alarm transitions to an OK state from any other
    // state. Each action is specified as an Amazon Resource Name (ARN). Valid Values:
    // arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate |
    // arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot |
    // arn:aws:sns:region:account-id:sns-topic-name  |
    // arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
    // Valid Values (for use with IAM roles):
    // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |
    // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |
    // arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
    OKActions []string

    // The length, in seconds, used each time the metric specified in MetricName is
    // evaluated. Valid values are 10, 30, and any multiple of 60. Period is required
    // for alarms based on static thresholds. If you are creating an alarm based on a
    // metric math expression, you specify the period for each metric within the
    // objects in the Metrics array. Be sure to specify 10 or 30 only for metrics that
    // are stored by a PutMetricData call with a StorageResolution of 1. If you specify
    // a period of 10 or 30 for a metric that does not have sub-minute resolution, the
    // alarm still attempts to gather data at the period rate that you specify. In this
    // case, it does not receive data for the attempts that do not correspond to a
    // one-minute data resolution, and the alarm might often lapse into
    // INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a
    // high-resolution alarm, which has a higher charge than other alarms. For more
    // information about pricing, see Amazon CloudWatch Pricing
    // (https://aws.amazon.com/cloudwatch/pricing/). An alarm's total current
    // evaluation period can be no longer than one day, so Period multiplied by
    // EvaluationPeriods cannot be more than 86,400 seconds.
    Period *int32

    // The statistic for the metric specified in MetricName, other than percentile. For
    // percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and
    // specify a MetricName, you must specify either Statistic or ExtendedStatistic,
    // but not both.
    Statistic types.Statistic

    // A list of key-value pairs to associate with the alarm. You can associate as many
    // as 50 tags with an alarm. Tags can help you organize and categorize your
    // resources. You can also use them to scope user permissions by granting a user
    // permission to access or change only resources with certain tag values.
    Tags []types.Tag

    // The value against which the specified statistic is compared. This parameter is
    // required for alarms based on static thresholds, but should not be used for
    // alarms based on anomaly detection models.
    Threshold *float64

    // If this is an alarm based on an anomaly detection model, make this value match
    // the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use this
    // parameter, see the Anomaly Detection Model Alarm example on this page. If your
    // alarm uses this parameter, it cannot have Auto Scaling actions.
    ThresholdMetricId *string

    // Sets how this alarm is to handle missing data points. If TreatMissingData is
    // omitted, the default behavior of missing is used. For more information, see
    // Configuring How CloudWatch Alarms Treats Missing Data
    // (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).
    // Valid Values: breaching | notBreaching | ignore | missing
    TreatMissingData *string

    // The unit of measure for the statistic. For example, the units for the Amazon EC2
    // NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an
    // instance receives on all network interfaces. You can also specify a unit when
    // you create a custom metric. Units help provide conceptual meaning to your data.
    // Metric data points that specify a unit of measure, such as Percent, are
    // aggregated separately. If you don't specify Unit, CloudWatch retrieves all unit
    // types that have been published for the metric and attempts to evaluate the
    // alarm. Usually, metrics are published with only one unit, so the alarm works as
    // intended. However, if the metric is published with multiple types of units and
    // you don't specify a unit, the alarm's behavior is not defined and it behaves
    // predictably. We recommend omitting Unit so that you don't inadvertently specify
    // an incorrect unit that is not published for this metric. Doing so causes the
    // alarm to be stuck in the INSUFFICIENT DATA state.
    Unit types.StandardUnit
}

type PutMetricAlarmOutput Uses

type PutMetricAlarmOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type PutMetricDataInput Uses

type PutMetricDataInput struct {

    // The data for the metric. The array can include no more than 20 metrics per call.
    //
    // This member is required.
    MetricData []types.MetricDatum

    // The namespace for the metric data. To avoid conflicts with AWS service
    // namespaces, you should not specify a namespace that begins with AWS/
    //
    // This member is required.
    Namespace *string
}

type PutMetricDataOutput Uses

type PutMetricDataOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type ResolveEndpoint Uses

type ResolveEndpoint struct {
    Resolver EndpointResolver
    Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize Uses

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

func (*ResolveEndpoint) ID Uses

func (*ResolveEndpoint) ID() string

type SetAlarmStateInput Uses

type SetAlarmStateInput struct {

    // The name of the alarm.
    //
    // This member is required.
    AlarmName *string

    // The reason that this alarm is set to this specific state, in text format.
    //
    // This member is required.
    StateReason *string

    // The value of the state.
    //
    // This member is required.
    StateValue types.StateValue

    // The reason that this alarm is set to this specific state, in JSON format. For
    // SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling
    // or application Auto Scaling alarm actions, the Auto Scaling policy uses the
    // information in this field to take the correct action.
    StateReasonData *string
}

type SetAlarmStateOutput Uses

type SetAlarmStateOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type TagResourceInput Uses

type TagResourceInput struct {

    // The ARN of the CloudWatch resource that you're adding tags to. The ARN format of
    // an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name  The ARN
    // format of a Contributor Insights rule is
    // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name  For more
    // information about ARN format, see  Resource Types Defined by Amazon CloudWatch
    // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
    // in the Amazon Web Services General Reference.
    //
    // This member is required.
    ResourceARN *string

    // The list of key-value pairs to associate with the alarm.
    //
    // This member is required.
    Tags []types.Tag
}

type TagResourceOutput Uses

type TagResourceOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

type UntagResourceInput Uses

type UntagResourceInput struct {

    // The ARN of the CloudWatch resource that you're removing tags from. The ARN
    // format of an alarm is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name  The
    // ARN format of a Contributor Insights rule is
    // arn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name  For more
    // information about ARN format, see  Resource Types Defined by Amazon CloudWatch
    // (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
    // in the Amazon Web Services General Reference.
    //
    // This member is required.
    ResourceARN *string

    // The list of tag keys to remove from the resource.
    //
    // This member is required.
    TagKeys []string
}

type UntagResourceOutput Uses

type UntagResourceOutput struct {
    // Metadata pertaining to the operation's result.
    ResultMetadata middleware.Metadata
}

Directories

PathSynopsis
internal/endpoints
types

Package cloudwatch imports 30 packages (graph) and is imported by 34 packages. Updated 2020-11-27. Refresh now. Tools for package owners.