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 client and types for making API requests to CloudWatch.

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

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

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

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

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

Using the Client

To use CloudWatch with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the CloudWatch client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatch/#New

Index

Package Files

api_client.go api_doc.go api_enums.go api_errors.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 api_types.go api_waiters.go

Constants

const (
    ServiceName = "CloudWatch" // Service's name
    ServiceID   = "CloudWatch" // Service's identifier
    EndpointsID = "monitoring" // Service's Endpoint identifier
)
const (

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

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

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

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

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

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

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

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

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

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

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

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

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // The named resource does not exist.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

type AlarmHistoryItem Uses

type AlarmHistoryItem struct {

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

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

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

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

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

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

Represents the history of a specific alarm.

func (AlarmHistoryItem) String Uses

func (s AlarmHistoryItem) String() string

String returns the string representation

type AlarmType Uses

type AlarmType string
const (
    AlarmTypeCompositeAlarm AlarmType = "CompositeAlarm"
    AlarmTypeMetricAlarm    AlarmType = "MetricAlarm"
)

Enum values for AlarmType

func (AlarmType) MarshalValue Uses

func (enum AlarmType) MarshalValue() (string, error)

func (AlarmType) MarshalValueBuf Uses

func (enum AlarmType) MarshalValueBuf(b []byte) ([]byte, error)

type AnomalyDetector Uses

type AnomalyDetector struct {

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

    // The metric dimensions associated with the anomaly detection model.
    Dimensions []Dimension `type:"list"`

    // The name of the metric associated with the anomaly detection model.
    MetricName *string `min:"1" type:"string"`

    // The namespace of the metric associated with the anomaly detection model.
    Namespace *string `min:"1" type:"string"`

    // The statistic associated with the anomaly detection model.
    Stat *string `type:"string"`

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

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

func (AnomalyDetector) String Uses

func (s AnomalyDetector) String() string

String returns the string representation

type AnomalyDetectorConfiguration Uses

type AnomalyDetectorConfiguration struct {

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

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

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

func (AnomalyDetectorConfiguration) String Uses

func (s AnomalyDetectorConfiguration) String() string

String returns the string representation

func (*AnomalyDetectorConfiguration) Validate Uses

func (s *AnomalyDetectorConfiguration) Validate() error

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

type AnomalyDetectorStateValue Uses

type AnomalyDetectorStateValue string
const (
    AnomalyDetectorStateValuePendingTraining         AnomalyDetectorStateValue = "PENDING_TRAINING"
    AnomalyDetectorStateValueTrainedInsufficientData AnomalyDetectorStateValue = "TRAINED_INSUFFICIENT_DATA"
    AnomalyDetectorStateValueTrained                 AnomalyDetectorStateValue = "TRAINED"
)

Enum values for AnomalyDetectorStateValue

func (AnomalyDetectorStateValue) MarshalValue Uses

func (enum AnomalyDetectorStateValue) MarshalValue() (string, error)

func (AnomalyDetectorStateValue) MarshalValueBuf Uses

func (enum AnomalyDetectorStateValue) MarshalValueBuf(b []byte) ([]byte, error)

type Client Uses

type Client struct {
    *aws.Client
}

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

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := cloudwatch.New(myConfig)

func (*Client) DeleteAlarmsRequest Uses

func (c *Client) DeleteAlarmsRequest(input *DeleteAlarmsInput) DeleteAlarmsRequest

DeleteAlarmsRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

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

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

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

// Example sending a request using DeleteAlarmsRequest.
req := client.DeleteAlarmsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteAnomalyDetectorRequest Uses

func (c *Client) DeleteAnomalyDetectorRequest(input *DeleteAnomalyDetectorInput) DeleteAnomalyDetectorRequest

DeleteAnomalyDetectorRequest returns a request value for making API operation for Amazon CloudWatch.

Deletes the specified anomaly detection model from your account.

// Example sending a request using DeleteAnomalyDetectorRequest.
req := client.DeleteAnomalyDetectorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteDashboardsRequest Uses

func (c *Client) DeleteDashboardsRequest(input *DeleteDashboardsInput) DeleteDashboardsRequest

DeleteDashboardsRequest returns a request value for making API operation for Amazon CloudWatch.

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

// Example sending a request using DeleteDashboardsRequest.
req := client.DeleteDashboardsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteInsightRulesRequest Uses

func (c *Client) DeleteInsightRulesRequest(input *DeleteInsightRulesInput) DeleteInsightRulesRequest

DeleteInsightRulesRequest returns a request value for making API operation for Amazon CloudWatch.

Permanently deletes the specified Contributor Insights rules.

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

// Example sending a request using DeleteInsightRulesRequest.
req := client.DeleteInsightRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeAlarmHistoryRequest Uses

func (c *Client) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInput) DescribeAlarmHistoryRequest

DescribeAlarmHistoryRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

// Example sending a request using DescribeAlarmHistoryRequest.
req := client.DescribeAlarmHistoryRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeAlarmsForMetricRequest Uses

func (c *Client) DescribeAlarmsForMetricRequest(input *DescribeAlarmsForMetricInput) DescribeAlarmsForMetricRequest

DescribeAlarmsForMetricRequest returns a request value for making API operation for Amazon CloudWatch.

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

// Example sending a request using DescribeAlarmsForMetricRequest.
req := client.DescribeAlarmsForMetricRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeAlarmsRequest Uses

func (c *Client) DescribeAlarmsRequest(input *DescribeAlarmsInput) DescribeAlarmsRequest

DescribeAlarmsRequest returns a request value for making API operation for Amazon CloudWatch.

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.

// Example sending a request using DescribeAlarmsRequest.
req := client.DescribeAlarmsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeAnomalyDetectorsRequest Uses

func (c *Client) DescribeAnomalyDetectorsRequest(input *DescribeAnomalyDetectorsInput) DescribeAnomalyDetectorsRequest

DescribeAnomalyDetectorsRequest returns a request value for making API operation for Amazon CloudWatch.

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.

// Example sending a request using DescribeAnomalyDetectorsRequest.
req := client.DescribeAnomalyDetectorsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeInsightRulesRequest Uses

func (c *Client) DescribeInsightRulesRequest(input *DescribeInsightRulesInput) DescribeInsightRulesRequest

DescribeInsightRulesRequest returns a request value for making API operation for Amazon CloudWatch.

Returns a list of all the Contributor Insights rules in your account. All rules in your account are returned with a single operation.

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

// Example sending a request using DescribeInsightRulesRequest.
req := client.DescribeInsightRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DisableAlarmActionsRequest Uses

func (c *Client) DisableAlarmActionsRequest(input *DisableAlarmActionsInput) DisableAlarmActionsRequest

DisableAlarmActionsRequest returns a request value for making API operation for Amazon CloudWatch.

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

// Example sending a request using DisableAlarmActionsRequest.
req := client.DisableAlarmActionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DisableInsightRulesRequest Uses

func (c *Client) DisableInsightRulesRequest(input *DisableInsightRulesInput) DisableInsightRulesRequest

DisableInsightRulesRequest returns a request value for making API operation for Amazon CloudWatch.

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

// Example sending a request using DisableInsightRulesRequest.
req := client.DisableInsightRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) EnableAlarmActionsRequest Uses

func (c *Client) EnableAlarmActionsRequest(input *EnableAlarmActionsInput) EnableAlarmActionsRequest

EnableAlarmActionsRequest returns a request value for making API operation for Amazon CloudWatch.

Enables the actions for the specified alarms.

// Example sending a request using EnableAlarmActionsRequest.
req := client.EnableAlarmActionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) EnableInsightRulesRequest Uses

func (c *Client) EnableInsightRulesRequest(input *EnableInsightRulesInput) EnableInsightRulesRequest

EnableInsightRulesRequest returns a request value for making API operation for Amazon CloudWatch.

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

// Example sending a request using EnableInsightRulesRequest.
req := client.EnableInsightRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetDashboardRequest Uses

func (c *Client) GetDashboardRequest(input *GetDashboardInput) GetDashboardRequest

GetDashboardRequest returns a request value for making API operation for Amazon CloudWatch.

Displays the details of the dashboard that you specify.

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

// Example sending a request using GetDashboardRequest.
req := client.GetDashboardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetInsightRuleReportRequest Uses

func (c *Client) GetInsightRuleReportRequest(input *GetInsightRuleReportInput) GetInsightRuleReportRequest

GetInsightRuleReportRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

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

* MaxContributorValue -- the value of the top contributor for each data
point. The identity of the contributor may 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.

// Example sending a request using GetInsightRuleReportRequest.
req := client.GetInsightRuleReportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetMetricDataRequest Uses

func (c *Client) GetMetricDataRequest(input *GetMetricDataInput) GetMetricDataRequest

GetMetricDataRequest returns a request value for making API operation for Amazon CloudWatch.

You can use the GetMetricData API to retrieve as many as 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 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.

// Example sending a request using GetMetricDataRequest.
req := client.GetMetricDataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetMetricStatisticsRequest Uses

func (c *Client) GetMetricStatisticsRequest(input *GetMetricStatisticsInput) GetMetricStatisticsRequest

GetMetricStatisticsRequest returns a request value for making API operation for Amazon CloudWatch.

Gets statistics for the specified metric.

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

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

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

* The SampleCount value of the statistic set is 1.

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

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.

// Example sending a request using GetMetricStatisticsRequest.
req := client.GetMetricStatisticsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) GetMetricWidgetImageRequest Uses

func (c *Client) GetMetricWidgetImageRequest(input *GetMetricWidgetImageInput) GetMetricWidgetImageRequest

GetMetricWidgetImageRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

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

* As many as 100 metrics in the graph.

* Up to 100 KB uncompressed payload.

// Example sending a request using GetMetricWidgetImageRequest.
req := client.GetMetricWidgetImageRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListDashboardsRequest Uses

func (c *Client) ListDashboardsRequest(input *ListDashboardsInput) ListDashboardsRequest

ListDashboardsRequest returns a request value for making API operation for Amazon CloudWatch.

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

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.

// Example sending a request using ListDashboardsRequest.
req := client.ListDashboardsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListMetricsRequest Uses

func (c *Client) ListMetricsRequest(input *ListMetricsInput) ListMetricsRequest

ListMetricsRequest returns a request value for making API operation for Amazon CloudWatch.

List the specified metrics. You can use the returned metrics with 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 fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner 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).

// Example sending a request using ListMetricsRequest.
req := client.ListMetricsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest Uses

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon CloudWatch.

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

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutAnomalyDetectorRequest Uses

func (c *Client) PutAnomalyDetectorRequest(input *PutAnomalyDetectorInput) PutAnomalyDetectorRequest

PutAnomalyDetectorRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

// Example sending a request using PutAnomalyDetectorRequest.
req := client.PutAnomalyDetectorRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutCompositeAlarmRequest Uses

func (c *Client) PutCompositeAlarmRequest(input *PutCompositeAlarmInput) PutCompositeAlarmRequest

PutCompositeAlarmRequest returns a request value for making API operation for Amazon CloudWatch.

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

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

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.

// Example sending a request using PutCompositeAlarmRequest.
req := client.PutCompositeAlarmRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutDashboardRequest Uses

func (c *Client) PutDashboardRequest(input *PutDashboardInput) PutDashboardRequest

PutDashboardRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

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

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

// Example sending a request using PutDashboardRequest.
req := client.PutDashboardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutInsightRuleRequest Uses

func (c *Client) PutInsightRuleRequest(input *PutInsightRuleInput) PutInsightRuleRequest

PutInsightRuleRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

// Example sending a request using PutInsightRuleRequest.
req := client.PutInsightRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutMetricAlarmRequest Uses

func (c *Client) PutMetricAlarmRequest(input *PutMetricAlarmInput) PutMetricAlarmRequest

PutMetricAlarmRequest returns a request value for making API operation for Amazon CloudWatch.

Creates or updates an alarm and associates it with the specified metric, 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).

// Example sending a request using PutMetricAlarmRequest.
req := client.PutMetricAlarmRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutMetricDataRequest Uses

func (c *Client) PutMetricDataRequest(input *PutMetricDataInput) PutMetricDataRequest

PutMetricDataRequest returns a request value for making API operation for Amazon CloudWatch.

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

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.

// Example sending a request using PutMetricDataRequest.
req := client.PutMetricDataRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) SetAlarmStateRequest Uses

func (c *Client) SetAlarmStateRequest(input *SetAlarmStateInput) SetAlarmStateRequest

SetAlarmStateRequest returns a request value for making API operation for Amazon CloudWatch.

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

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 will return to its actual state only once any of its children alarms change state. It is also re-evaluated 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.

// Example sending a request using SetAlarmStateRequest.
req := client.SetAlarmStateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TagResourceRequest Uses

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon CloudWatch.

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

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

Tags don't have any semantic meaning to 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.

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UntagResourceRequest Uses

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon CloudWatch.

Removes one or more tags from the specified resource.

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) WaitUntilAlarmExists Uses

func (c *Client) WaitUntilAlarmExists(ctx context.Context, input *DescribeAlarmsInput, opts ...aws.WaiterOption) error

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

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilCompositeAlarmExists Uses

func (c *Client) WaitUntilCompositeAlarmExists(ctx context.Context, input *DescribeAlarmsInput, opts ...aws.WaiterOption) error

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

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ComparisonOperator Uses

type ComparisonOperator string
const (
    ComparisonOperatorGreaterThanOrEqualToThreshold            ComparisonOperator = "GreaterThanOrEqualToThreshold"
    ComparisonOperatorGreaterThanThreshold                     ComparisonOperator = "GreaterThanThreshold"
    ComparisonOperatorLessThanThreshold                        ComparisonOperator = "LessThanThreshold"
    ComparisonOperatorLessThanOrEqualToThreshold               ComparisonOperator = "LessThanOrEqualToThreshold"
    ComparisonOperatorLessThanLowerOrGreaterThanUpperThreshold ComparisonOperator = "LessThanLowerOrGreaterThanUpperThreshold"
    ComparisonOperatorLessThanLowerThreshold                   ComparisonOperator = "LessThanLowerThreshold"
    ComparisonOperatorGreaterThanUpperThreshold                ComparisonOperator = "GreaterThanUpperThreshold"
)

Enum values for ComparisonOperator

func (ComparisonOperator) MarshalValue Uses

func (enum ComparisonOperator) MarshalValue() (string, error)

func (ComparisonOperator) MarshalValueBuf Uses

func (enum ComparisonOperator) MarshalValueBuf(b []byte) ([]byte, error)

type CompositeAlarm Uses

type CompositeAlarm struct {

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

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

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

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

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

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

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

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

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

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

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

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

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

The details about a composite alarm.

func (CompositeAlarm) String Uses

func (s CompositeAlarm) String() string

String returns the string representation

type DashboardEntry Uses

type DashboardEntry struct {

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

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

    // The time stamp of when the dashboard was last modified, either by an API
    // call or through the console. This number is expressed as the number of milliseconds
    // since Jan 1, 1970 00:00:00 UTC.
    LastModified *time.Time `type:"timestamp"`

    // The size of the dashboard, in bytes.
    Size *int64 `type:"long"`
    // contains filtered or unexported fields
}

Represents a specific dashboard.

func (DashboardEntry) String Uses

func (s DashboardEntry) String() string

String returns the string representation

type DashboardValidationMessage Uses

type DashboardValidationMessage struct {

    // The data path related to the message.
    DataPath *string `type:"string"`

    // A message describing the error or warning.
    Message *string `type:"string"`
    // contains filtered or unexported fields
}

An error or warning for the operation.

func (DashboardValidationMessage) String Uses

func (s DashboardValidationMessage) String() string

String returns the string representation

type Datapoint Uses

type Datapoint struct {

    // The average of the metric values that correspond to the data point.
    Average *float64 `type:"double"`

    // The percentile statistic for the data point.
    ExtendedStatistics map[string]float64 `type:"map"`

    // The maximum metric value for the data point.
    Maximum *float64 `type:"double"`

    // The minimum metric value for the data point.
    Minimum *float64 `type:"double"`

    // The number of metric values that contributed to the aggregate value of this
    // data point.
    SampleCount *float64 `type:"double"`

    // The sum of the metric values for the data point.
    Sum *float64 `type:"double"`

    // The time stamp used for the data point.
    Timestamp *time.Time `type:"timestamp"`

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

Encapsulates the statistical data that CloudWatch computes from metric data.

func (Datapoint) String Uses

func (s Datapoint) String() string

String returns the string representation

type DeleteAlarmsInput Uses

type DeleteAlarmsInput struct {

    // The alarms to be deleted.
    //
    // AlarmNames is a required field
    AlarmNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAlarmsInput) String Uses

func (s DeleteAlarmsInput) String() string

String returns the string representation

func (*DeleteAlarmsInput) Validate Uses

func (s *DeleteAlarmsInput) Validate() error

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

type DeleteAlarmsOutput Uses

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

func (DeleteAlarmsOutput) String Uses

func (s DeleteAlarmsOutput) String() string

String returns the string representation

type DeleteAlarmsRequest Uses

type DeleteAlarmsRequest struct {
    *aws.Request
    Input *DeleteAlarmsInput
    Copy  func(*DeleteAlarmsInput) DeleteAlarmsRequest
}

DeleteAlarmsRequest is the request type for the DeleteAlarms API operation.

func (DeleteAlarmsRequest) Send Uses

func (r DeleteAlarmsRequest) Send(ctx context.Context) (*DeleteAlarmsResponse, error)

Send marshals and sends the DeleteAlarms API request.

type DeleteAlarmsResponse Uses

type DeleteAlarmsResponse struct {
    *DeleteAlarmsOutput
    // contains filtered or unexported fields
}

DeleteAlarmsResponse is the response type for the DeleteAlarms API operation.

func (*DeleteAlarmsResponse) SDKResponseMetdata Uses

func (r *DeleteAlarmsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAlarms request.

type DeleteAnomalyDetectorInput Uses

type DeleteAnomalyDetectorInput struct {

    // The metric dimensions associated with the anomaly detection model to delete.
    Dimensions []Dimension `type:"list"`

    // The metric name associated with the anomaly detection model to delete.
    //
    // MetricName is a required field
    MetricName *string `min:"1" type:"string" required:"true"`

    // The namespace associated with the anomaly detection model to delete.
    //
    // Namespace is a required field
    Namespace *string `min:"1" type:"string" required:"true"`

    // The statistic associated with the anomaly detection model to delete.
    //
    // Stat is a required field
    Stat *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAnomalyDetectorInput) String Uses

func (s DeleteAnomalyDetectorInput) String() string

String returns the string representation

func (*DeleteAnomalyDetectorInput) Validate Uses

func (s *DeleteAnomalyDetectorInput) Validate() error

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

type DeleteAnomalyDetectorOutput Uses

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

func (DeleteAnomalyDetectorOutput) String Uses

func (s DeleteAnomalyDetectorOutput) String() string

String returns the string representation

type DeleteAnomalyDetectorRequest Uses

type DeleteAnomalyDetectorRequest struct {
    *aws.Request
    Input *DeleteAnomalyDetectorInput
    Copy  func(*DeleteAnomalyDetectorInput) DeleteAnomalyDetectorRequest
}

DeleteAnomalyDetectorRequest is the request type for the DeleteAnomalyDetector API operation.

func (DeleteAnomalyDetectorRequest) Send Uses

func (r DeleteAnomalyDetectorRequest) Send(ctx context.Context) (*DeleteAnomalyDetectorResponse, error)

Send marshals and sends the DeleteAnomalyDetector API request.

type DeleteAnomalyDetectorResponse Uses

type DeleteAnomalyDetectorResponse struct {
    *DeleteAnomalyDetectorOutput
    // contains filtered or unexported fields
}

DeleteAnomalyDetectorResponse is the response type for the DeleteAnomalyDetector API operation.

func (*DeleteAnomalyDetectorResponse) SDKResponseMetdata Uses

func (r *DeleteAnomalyDetectorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAnomalyDetector request.

type DeleteDashboardsInput Uses

type DeleteDashboardsInput struct {

    // The dashboards to be deleted. This parameter is required.
    //
    // DashboardNames is a required field
    DashboardNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteDashboardsInput) String Uses

func (s DeleteDashboardsInput) String() string

String returns the string representation

func (*DeleteDashboardsInput) Validate Uses

func (s *DeleteDashboardsInput) Validate() error

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

type DeleteDashboardsOutput Uses

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

func (DeleteDashboardsOutput) String Uses

func (s DeleteDashboardsOutput) String() string

String returns the string representation

type DeleteDashboardsRequest Uses

type DeleteDashboardsRequest struct {
    *aws.Request
    Input *DeleteDashboardsInput
    Copy  func(*DeleteDashboardsInput) DeleteDashboardsRequest
}

DeleteDashboardsRequest is the request type for the DeleteDashboards API operation.

func (DeleteDashboardsRequest) Send Uses

func (r DeleteDashboardsRequest) Send(ctx context.Context) (*DeleteDashboardsResponse, error)

Send marshals and sends the DeleteDashboards API request.

type DeleteDashboardsResponse Uses

type DeleteDashboardsResponse struct {
    *DeleteDashboardsOutput
    // contains filtered or unexported fields
}

DeleteDashboardsResponse is the response type for the DeleteDashboards API operation.

func (*DeleteDashboardsResponse) SDKResponseMetdata Uses

func (r *DeleteDashboardsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDashboards request.

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).
    //
    // RuleNames is a required field
    RuleNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteInsightRulesInput) String Uses

func (s DeleteInsightRulesInput) String() string

String returns the string representation

func (*DeleteInsightRulesInput) Validate Uses

func (s *DeleteInsightRulesInput) Validate() error

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

type DeleteInsightRulesOutput Uses

type DeleteInsightRulesOutput struct {

    // An array listing the rules that could not be deleted. You cannot delete built-in
    // rules.
    Failures []PartialFailure `type:"list"`
    // contains filtered or unexported fields
}

func (DeleteInsightRulesOutput) String Uses

func (s DeleteInsightRulesOutput) String() string

String returns the string representation

type DeleteInsightRulesRequest Uses

type DeleteInsightRulesRequest struct {
    *aws.Request
    Input *DeleteInsightRulesInput
    Copy  func(*DeleteInsightRulesInput) DeleteInsightRulesRequest
}

DeleteInsightRulesRequest is the request type for the DeleteInsightRules API operation.

func (DeleteInsightRulesRequest) Send Uses

func (r DeleteInsightRulesRequest) Send(ctx context.Context) (*DeleteInsightRulesResponse, error)

Send marshals and sends the DeleteInsightRules API request.

type DeleteInsightRulesResponse Uses

type DeleteInsightRulesResponse struct {
    *DeleteInsightRulesOutput
    // contains filtered or unexported fields
}

DeleteInsightRulesResponse is the response type for the DeleteInsightRules API operation.

func (*DeleteInsightRulesResponse) SDKResponseMetdata Uses

func (r *DeleteInsightRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteInsightRules request.

type DescribeAlarmHistoryInput Uses

type DescribeAlarmHistoryInput struct {

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

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

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

    // The type of alarm histories to retrieve.
    HistoryItemType HistoryItemType `type:"string" enum:"true"`

    // The maximum number of alarm history records to retrieve.
    MaxRecords *int64 `min:"1" type:"integer"`

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

    // 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 ScanBy `type:"string" enum:"true"`

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

func (DescribeAlarmHistoryInput) String Uses

func (s DescribeAlarmHistoryInput) String() string

String returns the string representation

func (*DescribeAlarmHistoryInput) Validate Uses

func (s *DescribeAlarmHistoryInput) Validate() error

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

type DescribeAlarmHistoryOutput Uses

type DescribeAlarmHistoryOutput struct {

    // The alarm histories, in JSON format.
    AlarmHistoryItems []AlarmHistoryItem `type:"list"`

    // The token that marks the start of the next batch of returned results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeAlarmHistoryOutput) String Uses

func (s DescribeAlarmHistoryOutput) String() string

String returns the string representation

type DescribeAlarmHistoryPaginator Uses

type DescribeAlarmHistoryPaginator struct {
    aws.Pager
}

DescribeAlarmHistoryPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeAlarmHistoryPaginator Uses

func NewDescribeAlarmHistoryPaginator(req DescribeAlarmHistoryRequest) DescribeAlarmHistoryPaginator

NewDescribeAlarmHistoryRequestPaginator returns a paginator for DescribeAlarmHistory. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeAlarmHistoryRequest(input)
p := cloudwatch.NewDescribeAlarmHistoryRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeAlarmHistoryPaginator) CurrentPage Uses

func (p *DescribeAlarmHistoryPaginator) CurrentPage() *DescribeAlarmHistoryOutput

type DescribeAlarmHistoryRequest Uses

type DescribeAlarmHistoryRequest struct {
    *aws.Request
    Input *DescribeAlarmHistoryInput
    Copy  func(*DescribeAlarmHistoryInput) DescribeAlarmHistoryRequest
}

DescribeAlarmHistoryRequest is the request type for the DescribeAlarmHistory API operation.

func (DescribeAlarmHistoryRequest) Send Uses

func (r DescribeAlarmHistoryRequest) Send(ctx context.Context) (*DescribeAlarmHistoryResponse, error)

Send marshals and sends the DescribeAlarmHistory API request.

type DescribeAlarmHistoryResponse Uses

type DescribeAlarmHistoryResponse struct {
    *DescribeAlarmHistoryOutput
    // contains filtered or unexported fields
}

DescribeAlarmHistoryResponse is the response type for the DescribeAlarmHistory API operation.

func (*DescribeAlarmHistoryResponse) SDKResponseMetdata Uses

func (r *DescribeAlarmHistoryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAlarmHistory request.

type DescribeAlarmsForMetricInput Uses

type DescribeAlarmsForMetricInput struct {

    // The dimensions associated with the metric. If the metric has any associated
    // dimensions, you must specify them in order for the call to succeed.
    Dimensions []Dimension `type:"list"`

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

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

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

    // The period, in seconds, over which the statistic is applied.
    Period *int64 `min:"1" type:"integer"`

    // The statistic for the metric, other than percentiles. For percentile statistics,
    // use ExtendedStatistics.
    Statistic Statistic `type:"string" enum:"true"`

    // The unit for the metric.
    Unit StandardUnit `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

func (DescribeAlarmsForMetricInput) String Uses

func (s DescribeAlarmsForMetricInput) String() string

String returns the string representation

func (*DescribeAlarmsForMetricInput) Validate Uses

func (s *DescribeAlarmsForMetricInput) Validate() error

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

type DescribeAlarmsForMetricOutput Uses

type DescribeAlarmsForMetricOutput struct {

    // The information for each alarm with the specified metric.
    MetricAlarms []MetricAlarm `type:"list"`
    // contains filtered or unexported fields
}

func (DescribeAlarmsForMetricOutput) String Uses

func (s DescribeAlarmsForMetricOutput) String() string

String returns the string representation

type DescribeAlarmsForMetricRequest Uses

type DescribeAlarmsForMetricRequest struct {
    *aws.Request
    Input *DescribeAlarmsForMetricInput
    Copy  func(*DescribeAlarmsForMetricInput) DescribeAlarmsForMetricRequest
}

DescribeAlarmsForMetricRequest is the request type for the DescribeAlarmsForMetric API operation.

func (DescribeAlarmsForMetricRequest) Send Uses

func (r DescribeAlarmsForMetricRequest) Send(ctx context.Context) (*DescribeAlarmsForMetricResponse, error)

Send marshals and sends the DescribeAlarmsForMetric API request.

type DescribeAlarmsForMetricResponse Uses

type DescribeAlarmsForMetricResponse struct {
    *DescribeAlarmsForMetricOutput
    // contains filtered or unexported fields
}

DescribeAlarmsForMetricResponse is the response type for the DescribeAlarmsForMetric API operation.

func (*DescribeAlarmsForMetricResponse) SDKResponseMetdata Uses

func (r *DescribeAlarmsForMetricResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAlarmsForMetric request.

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

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

    // The names of the alarms to retrieve information about.
    AlarmNames []string `type:"list"`

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

    // 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 will
    // receive a validation error.
    //
    // Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp
    // information are returned by this operation when you use this parameter. To
    // get complete information about these alarms, perform another DescribeAlarms
    // operation and specify the parent alarm names in the AlarmNames parameter.
    ChildrenOfAlarmName *string `min:"1" type:"string"`

    // The maximum number of alarm descriptions to retrieve.
    MaxRecords *int64 `min:"1" type:"integer"`

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

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

    // Specify this parameter to receive information only about alarms that are
    // currently in the state that you specify.
    StateValue StateValue `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

func (DescribeAlarmsInput) String Uses

func (s DescribeAlarmsInput) String() string

String returns the string representation

func (*DescribeAlarmsInput) Validate Uses

func (s *DescribeAlarmsInput) Validate() error

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

type DescribeAlarmsOutput Uses

type DescribeAlarmsOutput struct {

    // The information about any composite alarms returned by the operation.
    CompositeAlarms []CompositeAlarm `type:"list"`

    // The information about any metric alarms returned by the operation.
    MetricAlarms []MetricAlarm `type:"list"`

    // The token that marks the start of the next batch of returned results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeAlarmsOutput) String Uses

func (s DescribeAlarmsOutput) String() string

String returns the string representation

type DescribeAlarmsPaginator Uses

type DescribeAlarmsPaginator struct {
    aws.Pager
}

DescribeAlarmsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeAlarmsPaginator Uses

func NewDescribeAlarmsPaginator(req DescribeAlarmsRequest) DescribeAlarmsPaginator

NewDescribeAlarmsRequestPaginator returns a paginator for DescribeAlarms. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeAlarmsRequest(input)
p := cloudwatch.NewDescribeAlarmsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeAlarmsPaginator) CurrentPage Uses

func (p *DescribeAlarmsPaginator) CurrentPage() *DescribeAlarmsOutput

type DescribeAlarmsRequest Uses

type DescribeAlarmsRequest struct {
    *aws.Request
    Input *DescribeAlarmsInput
    Copy  func(*DescribeAlarmsInput) DescribeAlarmsRequest
}

DescribeAlarmsRequest is the request type for the DescribeAlarms API operation.

func (DescribeAlarmsRequest) Send Uses

func (r DescribeAlarmsRequest) Send(ctx context.Context) (*DescribeAlarmsResponse, error)

Send marshals and sends the DescribeAlarms API request.

type DescribeAlarmsResponse Uses

type DescribeAlarmsResponse struct {
    *DescribeAlarmsOutput
    // contains filtered or unexported fields
}

DescribeAlarmsResponse is the response type for the DescribeAlarms API operation.

func (*DescribeAlarmsResponse) SDKResponseMetdata Uses

func (r *DescribeAlarmsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAlarms request.

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 []Dimension `type:"list"`

    // The maximum number of results to return in one operation. The maximum value
    // that you can specify is 100.
    //
    // To retrieve the remaining results, make another call with the returned NextToken
    // value.
    MaxResults *int64 `min:"1" type:"integer"`

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

    // Limits the results to only the anomaly detection models that are associated
    // with the specified namespace.
    Namespace *string `min:"1" type:"string"`

    // Use the token returned by the previous operation to request the next page
    // of results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeAnomalyDetectorsInput) String Uses

func (s DescribeAnomalyDetectorsInput) String() string

String returns the string representation

func (*DescribeAnomalyDetectorsInput) Validate Uses

func (s *DescribeAnomalyDetectorsInput) Validate() error

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

type DescribeAnomalyDetectorsOutput Uses

type DescribeAnomalyDetectorsOutput struct {

    // The list of anomaly detection models returned by the operation.
    AnomalyDetectors []AnomalyDetector `type:"list"`

    // A token that you can use in a subsequent operation to retrieve the next set
    // of results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeAnomalyDetectorsOutput) String Uses

func (s DescribeAnomalyDetectorsOutput) String() string

String returns the string representation

type DescribeAnomalyDetectorsRequest Uses

type DescribeAnomalyDetectorsRequest struct {
    *aws.Request
    Input *DescribeAnomalyDetectorsInput
    Copy  func(*DescribeAnomalyDetectorsInput) DescribeAnomalyDetectorsRequest
}

DescribeAnomalyDetectorsRequest is the request type for the DescribeAnomalyDetectors API operation.

func (DescribeAnomalyDetectorsRequest) Send Uses

func (r DescribeAnomalyDetectorsRequest) Send(ctx context.Context) (*DescribeAnomalyDetectorsResponse, error)

Send marshals and sends the DescribeAnomalyDetectors API request.

type DescribeAnomalyDetectorsResponse Uses

type DescribeAnomalyDetectorsResponse struct {
    *DescribeAnomalyDetectorsOutput
    // contains filtered or unexported fields
}

DescribeAnomalyDetectorsResponse is the response type for the DescribeAnomalyDetectors API operation.

func (*DescribeAnomalyDetectorsResponse) SDKResponseMetdata Uses

func (r *DescribeAnomalyDetectorsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAnomalyDetectors request.

type DescribeInsightRulesInput Uses

type DescribeInsightRulesInput struct {

    // This parameter is not currently used. Reserved for future use. If it is used
    // in the future, the maximum value may be different.
    MaxResults *int64 `min:"1" type:"integer"`

    // Reserved for future use.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeInsightRulesInput) String Uses

func (s DescribeInsightRulesInput) String() string

String returns the string representation

func (*DescribeInsightRulesInput) Validate Uses

func (s *DescribeInsightRulesInput) Validate() error

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

type DescribeInsightRulesOutput Uses

type DescribeInsightRulesOutput struct {

    // The rules returned by the operation.
    InsightRules []InsightRule `type:"list"`

    // Reserved for future use.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeInsightRulesOutput) String Uses

func (s DescribeInsightRulesOutput) String() string

String returns the string representation

type DescribeInsightRulesPaginator Uses

type DescribeInsightRulesPaginator struct {
    aws.Pager
}

DescribeInsightRulesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeInsightRulesPaginator Uses

func NewDescribeInsightRulesPaginator(req DescribeInsightRulesRequest) DescribeInsightRulesPaginator

NewDescribeInsightRulesRequestPaginator returns a paginator for DescribeInsightRules. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeInsightRulesRequest(input)
p := cloudwatch.NewDescribeInsightRulesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeInsightRulesPaginator) CurrentPage Uses

func (p *DescribeInsightRulesPaginator) CurrentPage() *DescribeInsightRulesOutput

type DescribeInsightRulesRequest Uses

type DescribeInsightRulesRequest struct {
    *aws.Request
    Input *DescribeInsightRulesInput
    Copy  func(*DescribeInsightRulesInput) DescribeInsightRulesRequest
}

DescribeInsightRulesRequest is the request type for the DescribeInsightRules API operation.

func (DescribeInsightRulesRequest) Send Uses

func (r DescribeInsightRulesRequest) Send(ctx context.Context) (*DescribeInsightRulesResponse, error)

Send marshals and sends the DescribeInsightRules API request.

type DescribeInsightRulesResponse Uses

type DescribeInsightRulesResponse struct {
    *DescribeInsightRulesOutput
    // contains filtered or unexported fields
}

DescribeInsightRulesResponse is the response type for the DescribeInsightRules API operation.

func (*DescribeInsightRulesResponse) SDKResponseMetdata Uses

func (r *DescribeInsightRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeInsightRules request.

type Dimension Uses

type Dimension struct {

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

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

Expands the identity of a metric.

func (Dimension) String Uses

func (s Dimension) String() string

String returns the string representation

func (*Dimension) Validate Uses

func (s *Dimension) Validate() error

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

type DimensionFilter Uses

type DimensionFilter struct {

    // The dimension name to be matched.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The value of the dimension to be matched.
    Value *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Represents filters for a dimension.

func (DimensionFilter) String Uses

func (s DimensionFilter) String() string

String returns the string representation

func (*DimensionFilter) Validate Uses

func (s *DimensionFilter) Validate() error

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

type DisableAlarmActionsInput Uses

type DisableAlarmActionsInput struct {

    // The names of the alarms.
    //
    // AlarmNames is a required field
    AlarmNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DisableAlarmActionsInput) String Uses

func (s DisableAlarmActionsInput) String() string

String returns the string representation

func (*DisableAlarmActionsInput) Validate Uses

func (s *DisableAlarmActionsInput) Validate() error

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

type DisableAlarmActionsOutput Uses

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

func (DisableAlarmActionsOutput) String Uses

func (s DisableAlarmActionsOutput) String() string

String returns the string representation

type DisableAlarmActionsRequest Uses

type DisableAlarmActionsRequest struct {
    *aws.Request
    Input *DisableAlarmActionsInput
    Copy  func(*DisableAlarmActionsInput) DisableAlarmActionsRequest
}

DisableAlarmActionsRequest is the request type for the DisableAlarmActions API operation.

func (DisableAlarmActionsRequest) Send Uses

func (r DisableAlarmActionsRequest) Send(ctx context.Context) (*DisableAlarmActionsResponse, error)

Send marshals and sends the DisableAlarmActions API request.

type DisableAlarmActionsResponse Uses

type DisableAlarmActionsResponse struct {
    *DisableAlarmActionsOutput
    // contains filtered or unexported fields
}

DisableAlarmActionsResponse is the response type for the DisableAlarmActions API operation.

func (*DisableAlarmActionsResponse) SDKResponseMetdata Uses

func (r *DisableAlarmActionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisableAlarmActions request.

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).
    //
    // RuleNames is a required field
    RuleNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (DisableInsightRulesInput) String Uses

func (s DisableInsightRulesInput) String() string

String returns the string representation

func (*DisableInsightRulesInput) Validate Uses

func (s *DisableInsightRulesInput) Validate() error

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

type DisableInsightRulesOutput Uses

type DisableInsightRulesOutput struct {

    // An array listing the rules that could not be disabled. You cannot disable
    // built-in rules.
    Failures []PartialFailure `type:"list"`
    // contains filtered or unexported fields
}

func (DisableInsightRulesOutput) String Uses

func (s DisableInsightRulesOutput) String() string

String returns the string representation

type DisableInsightRulesRequest Uses

type DisableInsightRulesRequest struct {
    *aws.Request
    Input *DisableInsightRulesInput
    Copy  func(*DisableInsightRulesInput) DisableInsightRulesRequest
}

DisableInsightRulesRequest is the request type for the DisableInsightRules API operation.

func (DisableInsightRulesRequest) Send Uses

func (r DisableInsightRulesRequest) Send(ctx context.Context) (*DisableInsightRulesResponse, error)

Send marshals and sends the DisableInsightRules API request.

type DisableInsightRulesResponse Uses

type DisableInsightRulesResponse struct {
    *DisableInsightRulesOutput
    // contains filtered or unexported fields
}

DisableInsightRulesResponse is the response type for the DisableInsightRules API operation.

func (*DisableInsightRulesResponse) SDKResponseMetdata Uses

func (r *DisableInsightRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisableInsightRules request.

type EnableAlarmActionsInput Uses

type EnableAlarmActionsInput struct {

    // The names of the alarms.
    //
    // AlarmNames is a required field
    AlarmNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (EnableAlarmActionsInput) String Uses

func (s EnableAlarmActionsInput) String() string

String returns the string representation

func (*EnableAlarmActionsInput) Validate Uses

func (s *EnableAlarmActionsInput) Validate() error

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

type EnableAlarmActionsOutput Uses

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

func (EnableAlarmActionsOutput) String Uses

func (s EnableAlarmActionsOutput) String() string

String returns the string representation

type EnableAlarmActionsRequest Uses

type EnableAlarmActionsRequest struct {
    *aws.Request
    Input *EnableAlarmActionsInput
    Copy  func(*EnableAlarmActionsInput) EnableAlarmActionsRequest
}

EnableAlarmActionsRequest is the request type for the EnableAlarmActions API operation.

func (EnableAlarmActionsRequest) Send Uses

func (r EnableAlarmActionsRequest) Send(ctx context.Context) (*EnableAlarmActionsResponse, error)

Send marshals and sends the EnableAlarmActions API request.

type EnableAlarmActionsResponse Uses

type EnableAlarmActionsResponse struct {
    *EnableAlarmActionsOutput
    // contains filtered or unexported fields
}

EnableAlarmActionsResponse is the response type for the EnableAlarmActions API operation.

func (*EnableAlarmActionsResponse) SDKResponseMetdata Uses

func (r *EnableAlarmActionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the EnableAlarmActions request.

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).
    //
    // RuleNames is a required field
    RuleNames []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (EnableInsightRulesInput) String Uses

func (s EnableInsightRulesInput) String() string

String returns the string representation

func (*EnableInsightRulesInput) Validate Uses

func (s *EnableInsightRulesInput) Validate() error

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

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 []PartialFailure `type:"list"`
    // contains filtered or unexported fields
}

func (EnableInsightRulesOutput) String Uses

func (s EnableInsightRulesOutput) String() string

String returns the string representation

type EnableInsightRulesRequest Uses

type EnableInsightRulesRequest struct {
    *aws.Request
    Input *EnableInsightRulesInput
    Copy  func(*EnableInsightRulesInput) EnableInsightRulesRequest
}

EnableInsightRulesRequest is the request type for the EnableInsightRules API operation.

func (EnableInsightRulesRequest) Send Uses

func (r EnableInsightRulesRequest) Send(ctx context.Context) (*EnableInsightRulesResponse, error)

Send marshals and sends the EnableInsightRules API request.

type EnableInsightRulesResponse Uses

type EnableInsightRulesResponse struct {
    *EnableInsightRulesOutput
    // contains filtered or unexported fields
}

EnableInsightRulesResponse is the response type for the EnableInsightRules API operation.

func (*EnableInsightRulesResponse) SDKResponseMetdata Uses

func (r *EnableInsightRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the EnableInsightRules request.

type GetDashboardInput Uses

type GetDashboardInput struct {

    // The name of the dashboard to be described.
    //
    // DashboardName is a required field
    DashboardName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetDashboardInput) String Uses

func (s GetDashboardInput) String() string

String returns the string representation

func (*GetDashboardInput) Validate Uses

func (s *GetDashboardInput) Validate() error

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

type GetDashboardOutput Uses

type GetDashboardOutput struct {

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

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

    // The name of the dashboard.
    DashboardName *string `type:"string"`
    // contains filtered or unexported fields
}

func (GetDashboardOutput) String Uses

func (s GetDashboardOutput) String() string

String returns the string representation

type GetDashboardRequest Uses

type GetDashboardRequest struct {
    *aws.Request
    Input *GetDashboardInput
    Copy  func(*GetDashboardInput) GetDashboardRequest
}

GetDashboardRequest is the request type for the GetDashboard API operation.

func (GetDashboardRequest) Send Uses

func (r GetDashboardRequest) Send(ctx context.Context) (*GetDashboardResponse, error)

Send marshals and sends the GetDashboard API request.

type GetDashboardResponse Uses

type GetDashboardResponse struct {
    *GetDashboardOutput
    // contains filtered or unexported fields
}

GetDashboardResponse is the response type for the GetDashboard API operation.

func (*GetDashboardResponse) SDKResponseMetdata Uses

func (r *GetDashboardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDashboard request.

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.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" required:"true"`

    // The maximum number of contributors to include in the report. The range is
    // 1 to 100. If you omit this, the default of 10 is used.
    MaxContributorCount *int64 `type:"integer"`

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

    // Determines what statistic to use to rank the contributors. Valid values are
    // SUM and MAXIMUM.
    OrderBy *string `min:"1" type:"string"`

    // The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint
    // results.
    //
    // Period is a required field
    Period *int64 `min:"1" type:"integer" required:"true"`

    // The name of the rule that you want to see data from.
    //
    // RuleName is a required field
    RuleName *string `min:"1" type:"string" required:"true"`

    // The start time of the data to use in the report. When used in a raw HTTP
    // Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
    //
    // StartTime is a required field
    StartTime *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

func (GetInsightRuleReportInput) String Uses

func (s GetInsightRuleReportInput) String() string

String returns the string representation

func (*GetInsightRuleReportInput) Validate Uses

func (s *GetInsightRuleReportInput) Validate() error

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

type GetInsightRuleReportOutput Uses

type GetInsightRuleReportOutput struct {

    // The sum of the values from all individual contributors that match the rule.
    AggregateValue *float64 `type:"double"`

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

    // An approximate count of the unique contributors found by this rule in this
    // time period.
    ApproximateUniqueCount *int64 `type:"long"`

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

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

    // A time series of metric data points that matches the time period in the rule
    // request.
    MetricDatapoints []InsightRuleMetricDatapoint `type:"list"`
    // contains filtered or unexported fields
}

func (GetInsightRuleReportOutput) String Uses

func (s GetInsightRuleReportOutput) String() string

String returns the string representation

type GetInsightRuleReportRequest Uses

type GetInsightRuleReportRequest struct {
    *aws.Request
    Input *GetInsightRuleReportInput
    Copy  func(*GetInsightRuleReportInput) GetInsightRuleReportRequest
}

GetInsightRuleReportRequest is the request type for the GetInsightRuleReport API operation.

func (GetInsightRuleReportRequest) Send Uses

func (r GetInsightRuleReportRequest) Send(ctx context.Context) (*GetInsightRuleReportResponse, error)

Send marshals and sends the GetInsightRuleReport API request.

type GetInsightRuleReportResponse Uses

type GetInsightRuleReportResponse struct {
    *GetInsightRuleReportOutput
    // contains filtered or unexported fields
}

GetInsightRuleReportResponse is the response type for the GetInsightRuleReport API operation.

func (*GetInsightRuleReportResponse) SDKResponseMetdata Uses

func (r *GetInsightRuleReportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetInsightRuleReport request.

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.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" required:"true"`

    // The maximum number of data points the request should return before paginating.
    // If you omit this, the default of 100,800 is used.
    MaxDatapoints *int64 `type:"integer"`

    // The metric queries to be returned. A single GetMetricData call can include
    // as many as 500 MetricDataQuery structures. Each of these structures can specify
    // either a metric to retrieve, or a math expression to perform on retrieved
    // data.
    //
    // MetricDataQueries is a required field
    MetricDataQueries []MetricDataQuery `type:"list" required:"true"`

    // Include this value, if it was returned by the previous call, to get the next
    // set of data points.
    NextToken *string `type:"string"`

    // The order in which data points should be returned. TimestampDescending returns
    // the newest data first and paginates when the MaxDatapoints limit is reached.
    // TimestampAscending returns the oldest data first and paginates when the MaxDatapoints
    // limit is reached.
    ScanBy ScanBy `type:"string" enum:"true"`

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

func (GetMetricDataInput) String Uses

func (s GetMetricDataInput) String() string

String returns the string representation

func (*GetMetricDataInput) Validate Uses

func (s *GetMetricDataInput) Validate() error

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

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 may be returned is Maximum
    // number of allowed metrics exceeded. If there is a message, as much of the
    // operation as possible is still executed.
    //
    // A message appears here only if it is related to the global GetMetricData
    // operation. Any message about a specific metric returned by the operation
    // appears in the MetricDataResult object returned for that metric.
    Messages []MessageData `type:"list"`

    // The metrics that are returned, including the metric name, namespace, and
    // dimensions.
    MetricDataResults []MetricDataResult `type:"list"`

    // A token that marks the next batch of returned results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (GetMetricDataOutput) String Uses

func (s GetMetricDataOutput) String() string

String returns the string representation

type GetMetricDataPaginator Uses

type GetMetricDataPaginator struct {
    aws.Pager
}

GetMetricDataPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetMetricDataPaginator Uses

func NewGetMetricDataPaginator(req GetMetricDataRequest) GetMetricDataPaginator

NewGetMetricDataRequestPaginator returns a paginator for GetMetricData. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.GetMetricDataRequest(input)
p := cloudwatch.NewGetMetricDataRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetMetricDataPaginator) CurrentPage Uses

func (p *GetMetricDataPaginator) CurrentPage() *GetMetricDataOutput

type GetMetricDataRequest Uses

type GetMetricDataRequest struct {
    *aws.Request
    Input *GetMetricDataInput
    Copy  func(*GetMetricDataInput) GetMetricDataRequest
}

GetMetricDataRequest is the request type for the GetMetricData API operation.

func (GetMetricDataRequest) Send Uses

func (r GetMetricDataRequest) Send(ctx context.Context) (*GetMetricDataResponse, error)

Send marshals and sends the GetMetricData API request.

type GetMetricDataResponse Uses

type GetMetricDataResponse struct {
    *GetMetricDataOutput
    // contains filtered or unexported fields
}

GetMetricDataResponse is the response type for the GetMetricData API operation.

func (*GetMetricDataResponse) SDKResponseMetdata Uses

func (r *GetMetricDataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetMetricData request.

type GetMetricStatisticsInput Uses

type GetMetricStatisticsInput struct {

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

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

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

    // The name of the metric, with or without spaces.
    //
    // MetricName is a required field
    MetricName *string `min:"1" type:"string" required:"true"`

    // The namespace of the metric, with or without spaces.
    //
    // Namespace is a required field
    Namespace *string `min:"1" type:"string" required:"true"`

    // The granularity, in seconds, of the returned data points. For metrics with
    // regular resolution, a period can be as short as one minute (60 seconds) and
    // must be a multiple of 60. For high-resolution metrics that are collected
    // at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
    // or any multiple of 60. High-resolution metrics are those metrics stored by
    // a PutMetricData call that includes a StorageResolution of 1 second.
    //
    // If the StartTime parameter specifies a time stamp that is greater than 3
    // hours ago, you must specify the period as follows or no data points in that
    // time range is returned:
    //
    //    * Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
    //    (1 minute).
    //
    //    * Start time between 15 and 63 days ago - Use a multiple of 300 seconds
    //    (5 minutes).
    //
    //    * Start time greater than 63 days ago - Use a multiple of 3600 seconds
    //    (1 hour).
    //
    // Period is a required field
    Period *int64 `min:"1" type:"integer" required:"true"`

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

    // The metric statistics, other than percentile. For percentile statistics,
    // use ExtendedStatistics. When calling GetMetricStatistics, you must specify
    // either Statistics or ExtendedStatistics, but not both.
    Statistics []Statistic `min:"1" type:"list"`

    // 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 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 StandardUnit `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

func (GetMetricStatisticsInput) String Uses

func (s GetMetricStatisticsInput) String() string

String returns the string representation

func (*GetMetricStatisticsInput) Validate Uses

func (s *GetMetricStatisticsInput) Validate() error

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

type GetMetricStatisticsOutput Uses

type GetMetricStatisticsOutput struct {

    // The data points for the specified metric.
    Datapoints []Datapoint `type:"list"`

    // A label for the specified metric.
    Label *string `type:"string"`
    // contains filtered or unexported fields
}

func (GetMetricStatisticsOutput) String Uses

func (s GetMetricStatisticsOutput) String() string

String returns the string representation

type GetMetricStatisticsRequest Uses

type GetMetricStatisticsRequest struct {
    *aws.Request
    Input *GetMetricStatisticsInput
    Copy  func(*GetMetricStatisticsInput) GetMetricStatisticsRequest
}

GetMetricStatisticsRequest is the request type for the GetMetricStatistics API operation.

func (GetMetricStatisticsRequest) Send Uses

func (r GetMetricStatisticsRequest) Send(ctx context.Context) (*GetMetricStatisticsResponse, error)

Send marshals and sends the GetMetricStatistics API request.

type GetMetricStatisticsResponse Uses

type GetMetricStatisticsResponse struct {
    *GetMetricStatisticsOutput
    // contains filtered or unexported fields
}

GetMetricStatisticsResponse is the response type for the GetMetricStatistics API operation.

func (*GetMetricStatisticsResponse) SDKResponseMetdata Uses

func (r *GetMetricStatisticsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetMetricStatistics request.

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.
    //
    // MetricWidget is a required field
    MetricWidget *string `type:"string" required:"true"`

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

func (GetMetricWidgetImageInput) String Uses

func (s GetMetricWidgetImageInput) String() string

String returns the string representation

func (*GetMetricWidgetImageInput) Validate Uses

func (s *GetMetricWidgetImageInput) Validate() error

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

type GetMetricWidgetImageOutput Uses

type GetMetricWidgetImageOutput struct {

    // The image of the graph, in the output format specified.
    //
    // MetricWidgetImage is automatically base64 encoded/decoded by the SDK.
    MetricWidgetImage []byte `type:"blob"`
    // contains filtered or unexported fields
}

func (GetMetricWidgetImageOutput) String Uses

func (s GetMetricWidgetImageOutput) String() string

String returns the string representation

type GetMetricWidgetImageRequest Uses

type GetMetricWidgetImageRequest struct {
    *aws.Request
    Input *GetMetricWidgetImageInput
    Copy  func(*GetMetricWidgetImageInput) GetMetricWidgetImageRequest
}

GetMetricWidgetImageRequest is the request type for the GetMetricWidgetImage API operation.

func (GetMetricWidgetImageRequest) Send Uses

func (r GetMetricWidgetImageRequest) Send(ctx context.Context) (*GetMetricWidgetImageResponse, error)

Send marshals and sends the GetMetricWidgetImage API request.

type GetMetricWidgetImageResponse Uses

type GetMetricWidgetImageResponse struct {
    *GetMetricWidgetImageOutput
    // contains filtered or unexported fields
}

GetMetricWidgetImageResponse is the response type for the GetMetricWidgetImage API operation.

func (*GetMetricWidgetImageResponse) SDKResponseMetdata Uses

func (r *GetMetricWidgetImageResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetMetricWidgetImage request.

type HistoryItemType Uses

type HistoryItemType string
const (
    HistoryItemTypeConfigurationUpdate HistoryItemType = "ConfigurationUpdate"
    HistoryItemTypeStateUpdate         HistoryItemType = "StateUpdate"
    HistoryItemTypeAction              HistoryItemType = "Action"
)

Enum values for HistoryItemType

func (HistoryItemType) MarshalValue Uses

func (enum HistoryItemType) MarshalValue() (string, error)

func (HistoryItemType) MarshalValueBuf Uses

func (enum HistoryItemType) MarshalValueBuf(b []byte) ([]byte, error)

type InsightRule Uses

type InsightRule struct {

    // The definition of the rule, as a JSON object. The definition contains the
    // keywords used to define contributors, the value to aggregate on if this rule
    // returns a sum instead of a count, and the filters. For details on the valid
    // syntax, see Contributor Insights Rule Syntax (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html).
    //
    // Definition is a required field
    Definition *string `min:"1" type:"string" required:"true"`

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

    // For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version":
    // 1}. For built-in rules, this is {"Name": "ServiceLogRule", "Version": 1}
    //
    // Schema is a required field
    Schema *string `type:"string" required:"true"`

    // Indicates whether the rule is enabled or disabled.
    //
    // State is a required field
    State *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

This structure contains the definition for a Contributor Insights rule.

func (InsightRule) String Uses

func (s InsightRule) String() string

String returns the string representation

type InsightRuleContributor Uses

type InsightRuleContributor struct {

    // An approximation of the aggregate value that comes from this contributor.
    //
    // ApproximateAggregateValue is a required field
    ApproximateAggregateValue *float64 `type:"double" required:"true"`

    // An array of the data points where this contributor is present. Only the data
    // points when this contributor appeared are included in the array.
    //
    // Datapoints is a required field
    Datapoints []InsightRuleContributorDatapoint `type:"list" required:"true"`

    // One of the log entry field keywords that is used to define contributors for
    // this rule.
    //
    // Keys is a required field
    Keys []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

If the rule contains a single key, then each unique contributor is each unique value for this key.

For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).

func (InsightRuleContributor) String Uses

func (s InsightRuleContributor) String() string

String returns the string representation

type InsightRuleContributorDatapoint Uses

type InsightRuleContributorDatapoint struct {

    // The approximate value that this contributor added during this timestamp.
    //
    // ApproximateValue is a required field
    ApproximateValue *float64 `type:"double" required:"true"`

    // The timestamp of the data point.
    //
    // Timestamp is a required field
    Timestamp *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

One data point related to one contributor.

For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html) and InsightRuleContributor (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html).

func (InsightRuleContributorDatapoint) String Uses

func (s InsightRuleContributorDatapoint) String() string

String returns the string representation

type InsightRuleMetricDatapoint Uses

type InsightRuleMetricDatapoint struct {

    // The average value from all contributors during the time period represented
    // by that data point.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    Average *float64 `type:"double"`

    // The maximum value provided by one contributor during this timestamp. Each
    // timestamp is evaluated separately, so the identity of the max contributor
    // could be different for each timestamp.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    MaxContributorValue *float64 `type:"double"`

    // The maximum value from a single occurence from a single contributor during
    // the time period represented by that data point.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    Maximum *float64 `type:"double"`

    // The minimum value from a single contributor during the time period represented
    // by that data point.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    Minimum *float64 `type:"double"`

    // The number of occurrences that matched the rule during this data point.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    SampleCount *float64 `type:"double"`

    // The sum of the values from all contributors during the time period represented
    // by that data point.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    Sum *float64 `type:"double"`

    // The timestamp of the data point.
    //
    // Timestamp is a required field
    Timestamp *time.Time `type:"timestamp" required:"true"`

    // The number of unique contributors who published data during this timestamp.
    //
    // This statistic is returned only if you included it in the Metrics array in
    // your request.
    UniqueContributors *float64 `type:"double"`
    // contains filtered or unexported fields
}

One data point from the metric time series returned in a Contributor Insights rule report.

For more information, see GetInsightRuleReport (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html).

func (InsightRuleMetricDatapoint) String Uses

func (s InsightRuleMetricDatapoint) String() string

String returns the string representation

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 `type:"string"`

    // The token returned by a previous call to indicate that there is more data
    // available.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListDashboardsInput) String Uses

func (s ListDashboardsInput) String() string

String returns the string representation

type ListDashboardsOutput Uses

type ListDashboardsOutput struct {

    // The list of matching dashboards.
    DashboardEntries []DashboardEntry `type:"list"`

    // The token that marks the start of the next batch of returned results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListDashboardsOutput) String Uses

func (s ListDashboardsOutput) String() string

String returns the string representation

type ListDashboardsPaginator Uses

type ListDashboardsPaginator struct {
    aws.Pager
}

ListDashboardsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDashboardsPaginator Uses

func NewListDashboardsPaginator(req ListDashboardsRequest) ListDashboardsPaginator

NewListDashboardsRequestPaginator returns a paginator for ListDashboards. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListDashboardsRequest(input)
p := cloudwatch.NewListDashboardsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDashboardsPaginator) CurrentPage Uses

func (p *ListDashboardsPaginator) CurrentPage() *ListDashboardsOutput

type ListDashboardsRequest Uses

type ListDashboardsRequest struct {
    *aws.Request
    Input *ListDashboardsInput
    Copy  func(*ListDashboardsInput) ListDashboardsRequest
}

ListDashboardsRequest is the request type for the ListDashboards API operation.

func (ListDashboardsRequest) Send Uses

func (r ListDashboardsRequest) Send(ctx context.Context) (*ListDashboardsResponse, error)

Send marshals and sends the ListDashboards API request.

type ListDashboardsResponse Uses

type ListDashboardsResponse struct {
    *ListDashboardsOutput
    // contains filtered or unexported fields
}

ListDashboardsResponse is the response type for the ListDashboards API operation.

func (*ListDashboardsResponse) SDKResponseMetdata Uses

func (r *ListDashboardsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDashboards request.

type ListMetricsInput Uses

type ListMetricsInput struct {

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

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

    // The namespace to filter against.
    Namespace *string `min:"1" type:"string"`

    // The token returned by a previous call to indicate that there is more data
    // available.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListMetricsInput) String Uses

func (s ListMetricsInput) String() string

String returns the string representation

func (*ListMetricsInput) Validate Uses

func (s *ListMetricsInput) Validate() error

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

type ListMetricsOutput Uses

type ListMetricsOutput struct {

    // The metrics.
    Metrics []Metric `type:"list"`

    // The token that marks the start of the next batch of returned results.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListMetricsOutput) String Uses

func (s ListMetricsOutput) String() string

String returns the string representation

type ListMetricsPaginator Uses

type ListMetricsPaginator struct {
    aws.Pager
}

ListMetricsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListMetricsPaginator Uses

func NewListMetricsPaginator(req ListMetricsRequest) ListMetricsPaginator

NewListMetricsRequestPaginator returns a paginator for ListMetrics. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListMetricsRequest(input)
p := cloudwatch.NewListMetricsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListMetricsPaginator) CurrentPage Uses

func (p *ListMetricsPaginator) CurrentPage() *ListMetricsOutput

type ListMetricsRequest Uses

type ListMetricsRequest struct {
    *aws.Request
    Input *ListMetricsInput
    Copy  func(*ListMetricsInput) ListMetricsRequest
}

ListMetricsRequest is the request type for the ListMetrics API operation.

func (ListMetricsRequest) Send Uses

func (r ListMetricsRequest) Send(ctx context.Context) (*ListMetricsResponse, error)

Send marshals and sends the ListMetrics API request.

type ListMetricsResponse Uses

type ListMetricsResponse struct {
    *ListMetricsOutput
    // contains filtered or unexported fields
}

ListMetricsResponse is the response type for the ListMetrics API operation.

func (*ListMetricsResponse) SDKResponseMetdata Uses

func (r *ListMetricsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListMetrics request.

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 on ARN format, see Resource Types Defined by Amazon
    // CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
    // in the Amazon Web Services General Reference.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceInput) String Uses

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate Uses

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput Uses

type ListTagsForResourceOutput struct {

    // The list of tag keys and values associated with the resource you specified.
    Tags []Tag `type:"list"`
    // contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String Uses

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest Uses

type ListTagsForResourceRequest struct {
    *aws.Request
    Input *ListTagsForResourceInput
    Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send Uses

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse Uses

type ListTagsForResourceResponse struct {
    *ListTagsForResourceOutput
    // contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata Uses

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type MessageData Uses

type MessageData struct {

    // The error code or status code associated with the message.
    Code *string `type:"string"`

    // The message text.
    Value *string `type:"string"`
    // contains filtered or unexported fields
}

A message returned by the GetMetricDataAPI, including a code and a description.

func (MessageData) String Uses

func (s MessageData) String() string

String returns the string representation

type Metric Uses

type Metric struct {

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

    // The name of the metric. This is a required field.
    MetricName *string `min:"1" type:"string"`

    // The namespace of the metric.
    Namespace *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Represents a specific metric.

func (Metric) String Uses

func (s Metric) String() string

String returns the string representation

func (*Metric) Validate Uses

func (s *Metric) Validate() error

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

type MetricAlarm Uses

type MetricAlarm struct {

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

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

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

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

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

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

    // The arithmetic operation to use when comparing the specified statistic and
    // threshold. The specified statistic value is used as the first operand.
    ComparisonOperator ComparisonOperator `type:"string" enum:"true"`

    // The number of data points that must be breaching to trigger the alarm.
    DatapointsToAlarm *int64 `min:"1" type:"integer"`

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

    // Used only for alarms based on percentiles. If ignore, the alarm state does
    // not change during periods with too few data points to be statistically significant.
    // If evaluate or this parameter is not used, the alarm is always evaluated
    // and possibly changes state no matter how many data points are available.
    EvaluateLowSampleCountPercentile *string `min:"1" type:"string"`

    // The number of periods over which data is compared to the specified threshold.
    EvaluationPeriods *int64 `min:"1" type:"integer"`

    // The percentile statistic for the metric associated with the alarm. Specify
    // a value between p0.0 and p100.
    ExtendedStatistic *string `type:"string"`

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

    // The name of the metric associated with the alarm, if this is an alarm based
    // on a single metric.
    MetricName *string `min:"1" type:"string"`

    // An array of MetricDataQuery structures, used in an alarm based on a metric
    // math expression. Each structure either retrieves a metric or performs a math
    // expression. One item in the Metrics array is the math expression that the
    // alarm watches. This expression by designated by having ReturnValue set to
    // true.
    Metrics []MetricDataQuery `type:"list"`

    // The namespace of the metric associated with the alarm.
    Namespace *string `min:"1" type:"string"`

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

    // The period, in seconds, over which the statistic is applied.
    Period *int64 `min:"1" type:"integer"`

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

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

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

    // The state value for the alarm.
    StateValue StateValue `type:"string" enum:"true"`

    // The statistic for the metric associated with the alarm, other than percentile.
    // For percentile statistics, use ExtendedStatistic.
    Statistic Statistic `type:"string" enum:"true"`

    // The value to compare with the specified statistic.
    Threshold *float64 `type:"double"`

    // In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
    // function used as the threshold for the alarm.
    ThresholdMetricId *string `min:"1" type:"string"`

    // Sets how this alarm is to handle missing data points. If this parameter is
    // omitted, the default behavior of missing is used.
    TreatMissingData *string `min:"1" type:"string"`

    // The unit of the metric associated with the alarm.
    Unit StandardUnit `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

The details about a metric alarm.

func (MetricAlarm) String Uses

func (s MetricAlarm) String() string

String returns the string representation

type MetricDataQuery Uses

type MetricDataQuery struct {

    // The math expression to be performed on the returned data, if this object
    // is performing a math expression. This expression can use the Id of the other
    // metrics to refer to those metrics, and can also use the Id of other expressions
    // to use the result of those expressions. For more information about metric
    // math expressions, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)
    // in the Amazon CloudWatch User Guide.
    //
    // Within each MetricDataQuery object, you must specify either Expression or
    // MetricStat but not both.
    Expression *string `min:"1" type:"string"`

    // A short name used to tie this object to the results in the response. This
    // name must be unique within a single call to GetMetricData. If you are performing
    // math expressions on this set of data, this name represents that data and
    // can serve as a variable in the mathematical expression. The valid characters
    // are letters, numbers, and underscore. The first character must be a lowercase
    // letter.
    //
    // Id is a required field
    Id  *string `min:"1" type:"string" required:"true"`

    // A human-readable label for this metric or expression. This is especially
    // useful if this is an expression, so that you know what the value represents.
    // If the metric or expression is shown in a CloudWatch dashboard widget, the
    // label is shown. If Label is omitted, CloudWatch generates a default.
    Label *string `type:"string"`

    // The metric to be returned, along with statistics, period, and units. Use
    // this parameter only if this object is retrieving a metric and not performing
    // a math expression on returned data.
    //
    // Within one MetricDataQuery object, you must specify either Expression or
    // MetricStat but not both.
    MetricStat *MetricStat `type:"structure"`

    // The granularity, in seconds, of the returned data points. For metrics with
    // regular resolution, a period can be as short as one minute (60 seconds) and
    // must be a multiple of 60. For high-resolution metrics that are collected
    // at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
    // or any multiple of 60. High-resolution metrics are those metrics stored by
    // a PutMetricData operation that includes a StorageResolution of 1 second.
    Period *int64 `min:"1" type:"integer"`

    // When used in GetMetricData, this option indicates whether to return the timestamps
    // and raw data values of this metric. If you are performing this call just
    // to do math expressions and do not also need the raw data returned, you can
    // specify False. If you omit this, the default of True is used.
    //
    // When used in PutMetricAlarm, specify True for the one expression result to
    // use as the alarm. For all other metrics and expressions in the same PutMetricAlarm
    // operation, specify ReturnData as False.
    ReturnData *bool `type:"boolean"`
    // contains filtered or unexported fields
}

This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 500 MetricDataQuery structures.

When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

func (MetricDataQuery) String Uses

func (s MetricDataQuery) String() string

String returns the string representation

func (*MetricDataQuery) Validate Uses

func (s *MetricDataQuery) Validate() error

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

type MetricDataResult Uses

type MetricDataResult struct {

    // The short name you specified to represent this metric.
    Id  *string `min:"1" type:"string"`

    // The human-readable label associated with the data.
    Label *string `type:"string"`

    // A list of messages with additional information about the data returned.
    Messages []MessageData `type:"list"`

    // The status of the returned data. Complete indicates that all data points
    // in the requested time range were returned. PartialData means that an incomplete
    // set of data points were returned. You can use the NextToken value that was
    // returned and repeat your request to get more data points. NextToken is not
    // returned if you are performing a math expression. InternalError indicates
    // that an error occurred. Retry your request using NextToken, if present.
    StatusCode StatusCode `type:"string" enum:"true"`

    // The timestamps for the data points, formatted in Unix timestamp format. The
    // number of timestamps always matches the number of values and the value for
    // Timestamps[x] is Values[x].
    Timestamps []time.Time `type:"list"`

    // The data points for the metric corresponding to Timestamps. The number of
    // values always matches the number of timestamps and the timestamp for Values[x]
    // is Timestamps[x].
    Values []float64 `type:"list"`
    // contains filtered or unexported fields
}

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

func (MetricDataResult) String Uses

func (s MetricDataResult) String() string

String returns the string representation

type MetricDatum Uses

type MetricDatum struct {

    // Array of numbers that is used along with the Values array. Each number in
    // the Count array is the number of times the corresponding value in the Values
    // array occurred during the period.
    //
    // If you omit the Counts array, the default of 1 is used as the value for each
    // count. If you include a Counts array, it must include the same amount of
    // values as the Values array.
    Counts []float64 `type:"list"`

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

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

    // The statistical values for the metric.
    StatisticValues *StatisticSet `type:"structure"`

    // Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution
    // metric, so that CloudWatch stores the metric with sub-minute resolution down
    // to one second. Setting this to 60 specifies this metric as a regular-resolution
    // metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution
    // is available only for custom metrics. For more information about high-resolution
    // metrics, see High-Resolution Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics)
    // in the Amazon CloudWatch User Guide.
    //
    // This field is optional, if you do not specify it the default of 60 is used.
    StorageResolution *int64 `min:"1" type:"integer"`

    // The time the metric data was received, expressed as the number of milliseconds
    // since Jan 1, 1970 00:00:00 UTC.
    Timestamp *time.Time `type:"timestamp"`

    // When you are using a Put operation, this defines what unit you want to use
    // when storing the metric.
    //
    // In a Get operation, this displays the unit that is used for the metric.
    Unit StandardUnit `type:"string" enum:"true"`

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

    // Array of numbers representing the values for the metric during the period.
    // Each unique value is listed just once in this array, and the corresponding
    // number in the Counts array specifies the number of times that value occurred
    // during the period. You can include up to 150 unique values in each PutMetricData
    // action that specifies a Values array.
    //
    // Although the Values array accepts numbers of type Double, CloudWatch rejects
    // values that are either too small or too large. Values must be in the range
    // of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
    // -Infinity) are not supported.
    Values []float64 `type:"list"`
    // contains filtered or unexported fields
}

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

func (MetricDatum) String Uses

func (s MetricDatum) String() string

String returns the string representation

func (*MetricDatum) Validate Uses

func (s *MetricDatum) Validate() error

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

type MetricStat Uses

type MetricStat struct {

    // The metric to return, including the metric name, namespace, and dimensions.
    //
    // Metric is a required field
    Metric *Metric `type:"structure" required:"true"`

    // The granularity, in seconds, of the returned data points. For metrics with
    // regular resolution, a period can be as short as one minute (60 seconds) and
    // must be a multiple of 60. For high-resolution metrics that are collected
    // at intervals of less than one minute, the period can be 1, 5, 10, 30, 60,
    // or any multiple of 60. High-resolution metrics are those metrics stored by
    // a PutMetricData call that includes a StorageResolution of 1 second.
    //
    // If the StartTime parameter specifies a time stamp that is greater than 3
    // hours ago, you must specify the period as follows or no data points in that
    // time range is returned:
    //
    //    * Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds
    //    (1 minute).
    //
    //    * Start time between 15 and 63 days ago - Use a multiple of 300 seconds
    //    (5 minutes).
    //
    //    * Start time greater than 63 days ago - Use a multiple of 3600 seconds
    //    (1 hour).
    //
    // Period is a required field
    Period *int64 `min:"1" type:"integer" required:"true"`

    // The statistic to return. It can include any CloudWatch statistic or extended
    // statistic.
    //
    // Stat is a required field
    Stat *string `type:"string" required:"true"`

    // When you are using a Put operation, this defines what unit you want to use
    // when storing the metric.
    //
    // In a Get operation, if you omit Unit then all data that was collected with
    // any unit is returned, along with the corresponding units that were specified
    // when the data was reported to CloudWatch. If you specify a unit, the operation
    // returns only data 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 StandardUnit `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

This structure defines the metric to be returned, along with the statistics, period, and units.

func (MetricStat) String Uses

func (s MetricStat) String() string

String returns the string representation

func (*MetricStat) Validate Uses

func (s *MetricStat) Validate() error

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

type PartialFailure Uses

type PartialFailure struct {

    // The type of error.
    ExceptionType *string `type:"string"`

    // The code of the error.
    FailureCode *string `type:"string"`

    // A description of the error.
    FailureDescription *string `type:"string"`

    // The specified rule that could not be deleted.
    FailureResource *string `type:"string"`
    // contains filtered or unexported fields
}

This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.

func (PartialFailure) String Uses

func (s PartialFailure) String() string

String returns the string representation

type PutAnomalyDetectorInput Uses

type PutAnomalyDetectorInput struct {

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

    // The metric dimensions to create the anomaly detection model for.
    Dimensions []Dimension `type:"list"`

    // The name of the metric to create the anomaly detection model for.
    //
    // MetricName is a required field
    MetricName *string `min:"1" type:"string" required:"true"`

    // The namespace of the metric to create the anomaly detection model for.
    //
    // Namespace is a required field
    Namespace *string `min:"1" type:"string" required:"true"`

    // The statistic to use for the metric and the anomaly detection model.
    //
    // Stat is a required field
    Stat *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (PutAnomalyDetectorInput) String Uses

func (s PutAnomalyDetectorInput) String() string

String returns the string representation

func (*PutAnomalyDetectorInput) Validate Uses

func (s *PutAnomalyDetectorInput) Validate() error

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

type PutAnomalyDetectorOutput Uses

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

func (PutAnomalyDetectorOutput) String Uses

func (s PutAnomalyDetectorOutput) String() string

String returns the string representation

type PutAnomalyDetectorRequest Uses

type PutAnomalyDetectorRequest struct {
    *aws.Request
    Input *PutAnomalyDetectorInput
    Copy  func(*PutAnomalyDetectorInput) PutAnomalyDetectorRequest
}

PutAnomalyDetectorRequest is the request type for the PutAnomalyDetector API operation.

func (PutAnomalyDetectorRequest) Send Uses

func (r PutAnomalyDetectorRequest) Send(ctx context.Context) (*PutAnomalyDetectorResponse, error)

Send marshals and sends the PutAnomalyDetector API request.

type PutAnomalyDetectorResponse Uses

type PutAnomalyDetectorResponse struct {
    *PutAnomalyDetectorOutput
    // contains filtered or unexported fields
}

PutAnomalyDetectorResponse is the response type for the PutAnomalyDetector API operation.

func (*PutAnomalyDetectorResponse) SDKResponseMetdata Uses

func (r *PutAnomalyDetectorResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutAnomalyDetector request.

type PutCompositeAlarmInput Uses

type PutCompositeAlarmInput struct {

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

    // 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 `type:"list"`

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

    // The name for the composite alarm. This name must be unique within your AWS
    // account.
    //
    // AlarmName is a required field
    AlarmName *string `min:"1" type:"string" required:"true"`

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

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

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

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

func (PutCompositeAlarmInput) String Uses

func (s PutCompositeAlarmInput) String() string

String returns the string representation

func (*PutCompositeAlarmInput) Validate Uses

func (s *PutCompositeAlarmInput) Validate() error

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

type PutCompositeAlarmOutput Uses

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

func (PutCompositeAlarmOutput) String Uses

func (s PutCompositeAlarmOutput) String() string

String returns the string representation

type PutCompositeAlarmRequest Uses

type PutCompositeAlarmRequest struct {
    *aws.Request
    Input *PutCompositeAlarmInput
    Copy  func(*PutCompositeAlarmInput) PutCompositeAlarmRequest
}

PutCompositeAlarmRequest is the request type for the PutCompositeAlarm API operation.

func (PutCompositeAlarmRequest) Send Uses

func (r PutCompositeAlarmRequest) Send(ctx context.Context) (*PutCompositeAlarmResponse, error)

Send marshals and sends the PutCompositeAlarm API request.

type PutCompositeAlarmResponse Uses

type PutCompositeAlarmResponse struct {
    *PutCompositeAlarmOutput
    // contains filtered or unexported fields
}

PutCompositeAlarmResponse is the response type for the PutCompositeAlarm API operation.

func (*PutCompositeAlarmResponse) SDKResponseMetdata Uses

func (r *PutCompositeAlarmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutCompositeAlarm request.

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).
    //
    // DashboardBody is a required field
    DashboardBody *string `type:"string" required:"true"`

    // The name of the dashboard. If a dashboard with this name already exists,
    // this call modifies that dashboard, replacing its current contents. Otherwise,
    // a new dashboard is created. The maximum length is 255, and valid characters
    // are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
    //
    // DashboardName is a required field
    DashboardName *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (PutDashboardInput) String Uses

func (s PutDashboardInput) String() string

String returns the string representation

func (*PutDashboardInput) Validate Uses

func (s *PutDashboardInput) Validate() error

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

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
    // may not render.
    //
    // If this result includes error messages, the input was not valid and the operation
    // failed.
    DashboardValidationMessages []DashboardValidationMessage `type:"list"`
    // contains filtered or unexported fields
}

func (PutDashboardOutput) String Uses

func (s PutDashboardOutput) String() string

String returns the string representation

type PutDashboardRequest Uses

type PutDashboardRequest struct {
    *aws.Request
    Input *PutDashboardInput
    Copy  func(*PutDashboardInput) PutDashboardRequest
}

PutDashboardRequest is the request type for the PutDashboard API operation.

func (PutDashboardRequest) Send Uses

func (r PutDashboardRequest) Send(ctx context.Context) (*PutDashboardResponse, error)

Send marshals and sends the PutDashboard API request.

type PutDashboardResponse Uses

type PutDashboardResponse struct {
    *PutDashboardOutput
    // contains filtered or unexported fields
}

PutDashboardResponse is the response type for the PutDashboard API operation.

func (*PutDashboardResponse) SDKResponseMetdata Uses

func (r *PutDashboardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutDashboard request.

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).
    //
    // RuleDefinition is a required field
    RuleDefinition *string `min:"1" type:"string" required:"true"`

    // A unique name for the rule.
    //
    // RuleName is a required field
    RuleName *string `min:"1" type:"string" required:"true"`

    // The state of the rule. Valid values are ENABLED and DISABLED.
    RuleState *string `min:"1" type:"string"`

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

func (PutInsightRuleInput) String Uses

func (s PutInsightRuleInput) String() string

String returns the string representation

func (*PutInsightRuleInput) Validate Uses

func (s *PutInsightRuleInput) Validate() error

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

type PutInsightRuleOutput Uses

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

func (PutInsightRuleOutput) String Uses

func (s PutInsightRuleOutput) String() string

String returns the string representation

type PutInsightRuleRequest Uses

type PutInsightRuleRequest struct {
    *aws.Request
    Input *PutInsightRuleInput
    Copy  func(*PutInsightRuleInput) PutInsightRuleRequest
}

PutInsightRuleRequest is the request type for the PutInsightRule API operation.

func (PutInsightRuleRequest) Send Uses

func (r PutInsightRuleRequest) Send(ctx context.Context) (*PutInsightRuleResponse, error)

Send marshals and sends the PutInsightRule API request.

type PutInsightRuleResponse Uses

type PutInsightRuleResponse struct {
    *PutInsightRuleOutput
    // contains filtered or unexported fields
}

PutInsightRuleResponse is the response type for the PutInsightRule API operation.

func (*PutInsightRuleResponse) SDKResponseMetdata Uses

func (r *PutInsightRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutInsightRule request.

type PutMetricAlarmInput Uses

type PutMetricAlarmInput struct {

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

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

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

    // The name for the alarm. This name must be unique within your AWS account.
    //
    // AlarmName is a required field
    AlarmName *string `min:"1" type:"string" required:"true"`

    // The arithmetic operation to use when comparing the specified statistic and
    // threshold. The specified statistic value is used as the first operand.
    //
    // The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold,
    // and GreaterThanUpperThreshold are used only for alarms based on anomaly detection
    // models.
    //
    // ComparisonOperator is a required field
    ComparisonOperator ComparisonOperator `type:"string" required:"true" enum:"true"`

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

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

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

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

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

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

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

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

    // The namespace for the metric associated specified in MetricName.
    Namespace *string `min:"1" type:"string"`

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

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

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

    // 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 []Tag `type:"list"`

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

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

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

    // The unit of measure for the statistic. For example, the units for the Amazon
    // EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes
    // that an instance receives on all network interfaces. You can also specify
    // a unit when you create a custom metric. Units help provide conceptual meaning
    // to your data. Metric data points that specify a unit of measure, such as
    // Percent, are aggregated separately.
    //
    // If you don't specify Unit, CloudWatch retrieves all unit types that have
    // been published for the metric and attempts to evaluate the alarm. Usually
    // metrics are published with only one unit, so the alarm will work 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 will behave
    // un-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 StandardUnit `type:"string" enum:"true"`
    // contains filtered or unexported fields
}

func (PutMetricAlarmInput) String Uses

func (s PutMetricAlarmInput) String() string

String returns the string representation

func (*PutMetricAlarmInput) Validate Uses

func (s *PutMetricAlarmInput) Validate() error

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

type PutMetricAlarmOutput Uses

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

func (PutMetricAlarmOutput) String Uses

func (s PutMetricAlarmOutput) String() string

String returns the string representation

type PutMetricAlarmRequest Uses

type PutMetricAlarmRequest struct {
    *aws.Request
    Input *PutMetricAlarmInput
    Copy  func(*PutMetricAlarmInput) PutMetricAlarmRequest
}

PutMetricAlarmRequest is the request type for the PutMetricAlarm API operation.

func (PutMetricAlarmRequest) Send Uses

func (r PutMetricAlarmRequest) Send(ctx context.Context) (*PutMetricAlarmResponse, error)

Send marshals and sends the PutMetricAlarm API request.

type PutMetricAlarmResponse Uses

type PutMetricAlarmResponse struct {
    *PutMetricAlarmOutput
    // contains filtered or unexported fields
}

PutMetricAlarmResponse is the response type for the PutMetricAlarm API operation.

func (*PutMetricAlarmResponse) SDKResponseMetdata Uses

func (r *PutMetricAlarmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutMetricAlarm request.

type PutMetricDataInput Uses

type PutMetricDataInput struct {

    // The data for the metric. The array can include no more than 20 metrics per
    // call.
    //
    // MetricData is a required field
    MetricData []MetricDatum `type:"list" required:"true"`

    // The namespace for the metric data.
    //
    // To avoid conflicts with AWS service namespaces, you should not specify a
    // namespace that begins with AWS/
    //
    // Namespace is a required field
    Namespace *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (PutMetricDataInput) String Uses

func (s PutMetricDataInput) String() string

String returns the string representation

func (*PutMetricDataInput) Validate Uses

func (s *PutMetricDataInput) Validate() error

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

type PutMetricDataOutput Uses

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

func (PutMetricDataOutput) String Uses

func (s PutMetricDataOutput) String() string

String returns the string representation

type PutMetricDataRequest Uses

type PutMetricDataRequest struct {
    *aws.Request
    Input *PutMetricDataInput
    Copy  func(*PutMetricDataInput) PutMetricDataRequest
}

PutMetricDataRequest is the request type for the PutMetricData API operation.

func (PutMetricDataRequest) Send Uses

func (r PutMetricDataRequest) Send(ctx context.Context) (*PutMetricDataResponse, error)

Send marshals and sends the PutMetricData API request.

type PutMetricDataResponse Uses

type PutMetricDataResponse struct {
    *PutMetricDataOutput
    // contains filtered or unexported fields
}

PutMetricDataResponse is the response type for the PutMetricData API operation.

func (*PutMetricDataResponse) SDKResponseMetdata Uses

func (r *PutMetricDataResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutMetricData request.

type Range Uses

type Range struct {

    // The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss.
    // For example, 2019-07-01T23:59:59.
    //
    // EndTime is a required field
    EndTime *time.Time `type:"timestamp" required:"true"`

    // The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss.
    // For example, 2019-07-01T23:59:59.
    //
    // StartTime is a required field
    StartTime *time.Time `type:"timestamp" required:"true"`
    // contains filtered or unexported fields
}

Specifies one range of days or times to exclude from use for training an anomaly detection model.

func (Range) String Uses

func (s Range) String() string

String returns the string representation

func (*Range) Validate Uses

func (s *Range) Validate() error

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

type ScanBy Uses

type ScanBy string
const (
    ScanByTimestampDescending ScanBy = "TimestampDescending"
    ScanByTimestampAscending  ScanBy = "TimestampAscending"
)

Enum values for ScanBy

func (ScanBy) MarshalValue Uses

func (enum ScanBy) MarshalValue() (string, error)

func (ScanBy) MarshalValueBuf Uses

func (enum ScanBy) MarshalValueBuf(b []byte) ([]byte, error)

type SetAlarmStateInput Uses

type SetAlarmStateInput struct {

    // The name for the alarm. This name must be unique within the AWS account.
    // The maximum length is 255 characters.
    //
    // AlarmName is a required field
    AlarmName *string `min:"1" type:"string" required:"true"`

    // The reason that this alarm is set to this specific state, in text format.
    //
    // StateReason is a required field
    StateReason *string `type:"string" required:"true"`

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

    // The value of the state.
    //
    // StateValue is a required field
    StateValue StateValue `type:"string" required:"true" enum:"true"`
    // contains filtered or unexported fields
}

func (SetAlarmStateInput) String Uses

func (s SetAlarmStateInput) String() string

String returns the string representation

func (*SetAlarmStateInput) Validate Uses

func (s *SetAlarmStateInput) Validate() error

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

type SetAlarmStateOutput Uses

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

func (SetAlarmStateOutput) String Uses

func (s SetAlarmStateOutput) String() string

String returns the string representation

type SetAlarmStateRequest Uses

type SetAlarmStateRequest struct {
    *aws.Request
    Input *SetAlarmStateInput
    Copy  func(*SetAlarmStateInput) SetAlarmStateRequest
}

SetAlarmStateRequest is the request type for the SetAlarmState API operation.

func (SetAlarmStateRequest) Send Uses

func (r SetAlarmStateRequest) Send(ctx context.Context) (*SetAlarmStateResponse, error)

Send marshals and sends the SetAlarmState API request.

type SetAlarmStateResponse Uses

type SetAlarmStateResponse struct {
    *SetAlarmStateOutput
    // contains filtered or unexported fields
}

SetAlarmStateResponse is the response type for the SetAlarmState API operation.

func (*SetAlarmStateResponse) SDKResponseMetdata Uses

func (r *SetAlarmStateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the SetAlarmState request.

type StandardUnit Uses

type StandardUnit string
const (
    StandardUnitSeconds         StandardUnit = "Seconds"
    StandardUnitMicroseconds    StandardUnit = "Microseconds"
    StandardUnitMilliseconds    StandardUnit = "Milliseconds"
    StandardUnitBytes           StandardUnit = "Bytes"
    StandardUnitKilobytes       StandardUnit = "Kilobytes"
    StandardUnitMegabytes       StandardUnit = "Megabytes"
    StandardUnitGigabytes       StandardUnit = "Gigabytes"
    StandardUnitTerabytes       StandardUnit = "Terabytes"
    StandardUnitBits            StandardUnit = "Bits"
    StandardUnitKilobits        StandardUnit = "Kilobits"
    StandardUnitMegabits        StandardUnit = "Megabits"
    StandardUnitGigabits        StandardUnit = "Gigabits"
    StandardUnitTerabits        StandardUnit = "Terabits"
    StandardUnitPercent         StandardUnit = "Percent"
    StandardUnitCount           StandardUnit = "Count"
    StandardUnitBytesSecond     StandardUnit = "Bytes/Second"
    StandardUnitKilobytesSecond StandardUnit = "Kilobytes/Second"
    StandardUnitMegabytesSecond StandardUnit = "Megabytes/Second"
    StandardUnitGigabytesSecond StandardUnit = "Gigabytes/Second"
    StandardUnitTerabytesSecond StandardUnit = "Terabytes/Second"
    StandardUnitBitsSecond      StandardUnit = "Bits/Second"
    StandardUnitKilobitsSecond  StandardUnit = "Kilobits/Second"
    StandardUnitMegabitsSecond  StandardUnit = "Megabits/Second"
    StandardUnitGigabitsSecond  StandardUnit = "Gigabits/Second"
    StandardUnitTerabitsSecond  StandardUnit = "Terabits/Second"
    StandardUnitCountSecond     StandardUnit = "Count/Second"
    StandardUnitNone            StandardUnit = "None"
)

Enum values for StandardUnit

func (StandardUnit) MarshalValue Uses

func (enum StandardUnit) MarshalValue() (string, error)

func (StandardUnit) MarshalValueBuf Uses

func (enum StandardUnit) MarshalValueBuf(b []byte) ([]byte, error)

type StateValue Uses

type StateValue string
const (
    StateValueOk               StateValue = "OK"
    StateValueAlarm            StateValue = "ALARM"
    StateValueInsufficientData StateValue = "INSUFFICIENT_DATA"
)

Enum values for StateValue

func (StateValue) MarshalValue Uses

func (enum StateValue) MarshalValue() (string, error)

func (StateValue) MarshalValueBuf Uses

func (enum StateValue) MarshalValueBuf(b []byte) ([]byte, error)

type Statistic Uses

type Statistic string
const (
    StatisticSampleCount Statistic = "SampleCount"
    StatisticAverage     Statistic = "Average"
    StatisticSum         Statistic = "Sum"
    StatisticMinimum     Statistic = "Minimum"
    StatisticMaximum     Statistic = "Maximum"
)

Enum values for Statistic

func (Statistic) MarshalValue Uses

func (enum Statistic) MarshalValue() (string, error)

func (Statistic) MarshalValueBuf Uses

func (enum Statistic) MarshalValueBuf(b []byte) ([]byte, error)

type StatisticSet Uses

type StatisticSet struct {

    // The maximum value of the sample set.
    //
    // Maximum is a required field
    Maximum *float64 `type:"double" required:"true"`

    // The minimum value of the sample set.
    //
    // Minimum is a required field
    Minimum *float64 `type:"double" required:"true"`

    // The number of samples used for the statistic set.
    //
    // SampleCount is a required field
    SampleCount *float64 `type:"double" required:"true"`

    // The sum of values for the sample set.
    //
    // Sum is a required field
    Sum *float64 `type:"double" required:"true"`
    // contains filtered or unexported fields
}

Represents a set of statistics that describes a specific metric.

func (StatisticSet) String Uses

func (s StatisticSet) String() string

String returns the string representation

func (*StatisticSet) Validate Uses

func (s *StatisticSet) Validate() error

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

type StatusCode Uses

type StatusCode string
const (
    StatusCodeComplete      StatusCode = "Complete"
    StatusCodeInternalError StatusCode = "InternalError"
    StatusCodePartialData   StatusCode = "PartialData"
)

Enum values for StatusCode

func (StatusCode) MarshalValue Uses

func (enum StatusCode) MarshalValue() (string, error)

func (StatusCode) MarshalValueBuf Uses

func (enum StatusCode) MarshalValueBuf(b []byte) ([]byte, error)

type Tag Uses

type Tag struct {

    // A string that you can use to assign a value. The combination of tag keys
    // and values can help you organize and categorize your resources.
    //
    // Key is a required field
    Key *string `min:"1" type:"string" required:"true"`

    // The value for the specified tag key.
    //
    // Value is a required field
    Value *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

A key-value pair associated with a CloudWatch resource.

func (Tag) String Uses

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate Uses

func (s *Tag) Validate() error

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

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 on ARN format, see Resource Types Defined by Amazon
    // CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
    // in the Amazon Web Services General Reference.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // The list of key-value pairs to associate with the alarm.
    //
    // Tags is a required field
    Tags []Tag `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput Uses

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

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest Uses

type TagResourceRequest struct {
    *aws.Request
    Input *TagResourceInput
    Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send Uses

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse Uses

type TagResourceResponse struct {
    *TagResourceOutput
    // contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata Uses

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

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 on ARN format, see Resource Types Defined by Amazon
    // CloudWatch (https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies)
    // in the Amazon Web Services General Reference.
    //
    // ResourceARN is a required field
    ResourceARN *string `min:"1" type:"string" required:"true"`

    // The list of tag keys to remove from the resource.
    //
    // TagKeys is a required field
    TagKeys []string `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput Uses

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

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest Uses

type UntagResourceRequest struct {
    *aws.Request
    Input *UntagResourceInput
    Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send Uses

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse Uses

type UntagResourceResponse struct {
    *UntagResourceOutput
    // contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata Uses

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

Directories

PathSynopsis
cloudwatchifacePackage cloudwatchiface provides an interface to enable mocking the Amazon CloudWatch service client for testing your code.

Package cloudwatch imports 9 packages (graph) and is imported by 37 packages. Updated 2020-05-29. Refresh now. Tools for package owners.