cloudwatch

Documentation

Overview

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_service_metadata_route.tmpl

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl

Index

• func DiffMultiCompositeAlarms(c *gin.Context, dao db.ReaderDAO)
• func DiffMultiMetricAlarms(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleCompositeAlarm(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleMetricAlarm(c *gin.Context, dao db.ReaderDAO)
• func GetCloudWatchMetadata(c *gin.Context)
• func GetCompositeAlarm(c *gin.Context, dao db.ReaderDAO)
• func GetCompositeAlarmsMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetMetricAlarm(c *gin.Context, dao db.ReaderDAO)
• func GetMetricAlarmsMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListCompositeAlarms(c *gin.Context, dao db.ReaderDAO)
• func ListMetricAlarms(c *gin.Context, dao db.ReaderDAO)
• type ListCompositeAlarmsResponse
• type ListMetricAlarmsResponse

Functions

func DiffMultiCompositeAlarms

func DiffMultiCompositeAlarms(c *gin.Context, dao db.ReaderDAO)

DiffMultiCompositeAlarms godoc @Summary Diff CompositeAlarms @Description get a diff of CompositeAlarms between two points in time @Tags aws cloudwatch @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/cloudwatch/composite_alarms [get]

func DiffMultiMetricAlarms

func DiffMultiMetricAlarms(c *gin.Context, dao db.ReaderDAO)

DiffMultiMetricAlarms godoc @Summary Diff MetricAlarms @Description get a diff of MetricAlarms between two points in time @Tags aws cloudwatch @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/cloudwatch/metric_alarms [get]

func DiffSingleCompositeAlarm

func DiffSingleCompositeAlarm(c *gin.Context, dao db.ReaderDAO)

DiffSingleCompositeAlarm godoc @Summary Diff CompositeAlarm @Description get a diff of CompositeAlarm between two points in time @Tags aws cloudwatch @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param alarm_arn path string true "The alarm_arn of the CompositeAlarm to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/cloudwatch/composite_alarms/{alarm_arn} [get]

func DiffSingleMetricAlarm

func DiffSingleMetricAlarm(c *gin.Context, dao db.ReaderDAO)

DiffSingleMetricAlarm godoc @Summary Diff MetricAlarm @Description get a diff of MetricAlarm between two points in time @Tags aws cloudwatch @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param alarm_arn path string true "The alarm_arn of the MetricAlarm to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/cloudwatch/metric_alarms/{alarm_arn} [get]

func GetCloudWatchMetadata

func GetCloudWatchMetadata(c *gin.Context)

GetCloudWatchMetadata godoc @Summary Get CloudWatch Metadata @Description get a list of CloudWatch metadata @Tags aws cloudwatch @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/cloudwatch [get]

func GetCompositeAlarm

func GetCompositeAlarm(c *gin.Context, dao db.ReaderDAO)

GetCompositeAlarm godoc @Summary Get a specific CompositeAlarm @Description Get a specific CompositeAlarm by its AlarmArn @Tags aws cloudwatch @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param alarm_arn path string true "The alarm_arn of the CompositeAlarm to retrieve" @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Security ApiKeyAuth @Success 200 {object} cloudwatch.CompositeAlarm @Failure 400 @Failure 404 @Router /inventory/aws/cloudwatch/composite_alarms/{alarm_arn} [get]

func GetCompositeAlarmsMetadata

func GetCompositeAlarmsMetadata(c *gin.Context, dao db.ReaderDAO)

GetCompositeAlarmsMetadata godoc @Summary Get CompositeAlarms Metadata @Description get a list of composite_alarms metadata @Tags aws cloudwatch @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Security ApiKeyAuth @Success 200 {array} routes.AwsResourceMetadata @Failure 400 @Router /metadata/aws/cloudwatch/composite_alarms [get]

func GetMetricAlarm

func GetMetricAlarm(c *gin.Context, dao db.ReaderDAO)

GetMetricAlarm godoc @Summary Get a specific MetricAlarm @Description Get a specific MetricAlarm by its AlarmArn @Tags aws cloudwatch @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param alarm_arn path string true "The alarm_arn of the MetricAlarm to retrieve" @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Security ApiKeyAuth @Success 200 {object} cloudwatch.MetricAlarm @Failure 400 @Failure 404 @Router /inventory/aws/cloudwatch/metric_alarms/{alarm_arn} [get]

func GetMetricAlarmsMetadata

func GetMetricAlarmsMetadata(c *gin.Context, dao db.ReaderDAO)

GetMetricAlarmsMetadata godoc @Summary Get MetricAlarms Metadata @Description get a list of metric_alarms metadata @Tags aws cloudwatch @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Security ApiKeyAuth @Success 200 {array} routes.AwsResourceMetadata @Failure 400 @Router /metadata/aws/cloudwatch/metric_alarms [get]

func ListCompositeAlarms

func ListCompositeAlarms(c *gin.Context, dao db.ReaderDAO)

ListCompositeAlarms godoc @Summary List CompositeAlarms @Description get a list of composite_alarms @Tags aws cloudwatch @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param pagination_token query string false "A pagination token. If this is specified, the next set of results is retrieved. The pagination token is returned in the response." @Param max_results query int false "The maximum number of results to return. Default is 100" @Security ApiKeyAuth @Success 200 {object} ListCompositeAlarmsResponse @Failure 400 @Router /inventory/aws/cloudwatch/composite_alarms [get]

func ListMetricAlarms

func ListMetricAlarms(c *gin.Context, dao db.ReaderDAO)

ListMetricAlarms godoc @Summary List MetricAlarms @Description get a list of metric_alarms @Tags aws cloudwatch @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param pagination_token query string false "A pagination token. If this is specified, the next set of results is retrieved. The pagination token is returned in the response." @Param max_results query int false "The maximum number of results to return. Default is 100" @Security ApiKeyAuth @Success 200 {object} ListMetricAlarmsResponse @Failure 400 @Router /inventory/aws/cloudwatch/metric_alarms [get]

Types

type ListCompositeAlarmsResponse

type ListCompositeAlarmsResponse struct {
	CompositeAlarms []*cloudwatch.CompositeAlarm `json:"composite_alarms"`
	PaginationToken *string                      `json:"pagination_token,omitempty"`
}

type ListMetricAlarmsResponse

type ListMetricAlarmsResponse struct {
	MetricAlarms    []*cloudwatch.MetricAlarm `json:"metric_alarms"`
	PaginationToken *string                   `json:"pagination_token,omitempty"`
}