ecs

package
v0.0.0-...-62343dc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 8, 2022 License: MIT Imports: 7 Imported by: 0

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DiffMultiClusters

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

DiffMultiClusters godoc @Summary Diff Clusters @Description get a diff of Clusters between two points in time @Tags aws ecs @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/ecs/clusters [get]

func DiffMultiServices

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

DiffMultiServices godoc @Summary Diff Services @Description get a diff of Services between two points in time @Tags aws ecs @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/ecs/services [get]

func DiffMultiTasks

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

DiffMultiTasks godoc @Summary Diff Tasks @Description get a diff of Tasks between two points in time @Tags aws ecs @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/ecs/tasks [get]

func DiffSingleCluster

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

DiffSingleCluster godoc @Summary Diff Cluster @Description get a diff of Cluster between two points in time @Tags aws ecs @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 cluster_arn path string true "The cluster_arn of the Cluster to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/ecs/clusters/{cluster_arn} [get]

func DiffSingleService

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

DiffSingleService godoc @Summary Diff Service @Description get a diff of Service between two points in time @Tags aws ecs @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 service_arn path string true "The service_arn of the Service to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/ecs/services/{service_arn} [get]

func DiffSingleTask

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

DiffSingleTask godoc @Summary Diff Task @Description get a diff of Task between two points in time @Tags aws ecs @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 task_arn path string true "The task_arn of the Task to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/ecs/tasks/{task_arn} [get]

func GetCluster

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

GetCluster godoc @Summary Get a specific Cluster @Description Get a specific Cluster by its ClusterArn @Tags aws ecs @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param cluster_arn path string true "The cluster_arn of the Cluster 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} ecs.Cluster @Failure 400 @Failure 404 @Router /inventory/aws/ecs/clusters/{cluster_arn} [get]

func GetClustersMetadata

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

GetClustersMetadata godoc @Summary Get Clusters Metadata @Description get a list of clusters metadata @Tags aws ecs @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/ecs/clusters [get]

func GetECSMetadata

func GetECSMetadata(c *gin.Context)

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

func GetService

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

GetService godoc @Summary Get a specific Service @Description Get a specific Service by its ServiceArn @Tags aws ecs @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param service_arn path string true "The service_arn of the Service 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} ecs.Service @Failure 400 @Failure 404 @Router /inventory/aws/ecs/services/{service_arn} [get]

func GetServicesMetadata

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

GetServicesMetadata godoc @Summary Get Services Metadata @Description get a list of services metadata @Tags aws ecs @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/ecs/services [get]

func GetTask

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

GetTask godoc @Summary Get a specific Task @Description Get a specific Task by its TaskArn @Tags aws ecs @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param task_arn path string true "The task_arn of the Task 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} ecs.Task @Failure 400 @Failure 404 @Router /inventory/aws/ecs/tasks/{task_arn} [get]

func GetTasksMetadata

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

GetTasksMetadata godoc @Summary Get Tasks Metadata @Description get a list of tasks metadata @Tags aws ecs @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/ecs/tasks [get]

func ListClusters

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

ListClusters godoc @Summary List Clusters @Description get a list of clusters @Tags aws ecs @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} ListClustersResponse @Failure 400 @Router /inventory/aws/ecs/clusters [get]

func ListServices

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

ListServices godoc @Summary List Services @Description get a list of services @Tags aws ecs @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} ListServicesResponse @Failure 400 @Router /inventory/aws/ecs/services [get]

func ListTasks

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

ListTasks godoc @Summary List Tasks @Description get a list of tasks @Tags aws ecs @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} ListTasksResponse @Failure 400 @Router /inventory/aws/ecs/tasks [get]

Types

type ListClustersResponse

type ListClustersResponse struct {
	Clusters        []*ecs.Cluster `json:"clusters"`
	PaginationToken *string        `json:"pagination_token,omitempty"`
}

type ListServicesResponse

type ListServicesResponse struct {
	Services        []*ecs.Service `json:"services"`
	PaginationToken *string        `json:"pagination_token,omitempty"`
}

type ListTasksResponse

type ListTasksResponse struct {
	Tasks           []*ecs.Task `json:"tasks"`
	PaginationToken *string     `json:"pagination_token,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL