redshift

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

Index

• func DiffMultiClusters(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleCluster(c *gin.Context, dao db.ReaderDAO)
• func GetCluster(c *gin.Context, dao db.ReaderDAO)
• func GetClustersMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetRedshiftMetadata(c *gin.Context)
• func ListClusters(c *gin.Context, dao db.ReaderDAO)
• type ListClustersResponse

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 redshift @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/redshift/clusters [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 redshift @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_identifier path string true "The cluster_identifier of the Cluster to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/redshift/clusters/{cluster_identifier} [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 ClusterIdentifier @Tags aws redshift @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param cluster_identifier path string true "The cluster_identifier 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} redshift.Cluster @Failure 400 @Failure 404 @Router /inventory/aws/redshift/clusters/{cluster_identifier} [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 redshift @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/redshift/clusters [get]

func GetRedshiftMetadata

func GetRedshiftMetadata(c *gin.Context)

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

func ListClusters

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

ListClusters godoc @Summary List Clusters @Description get a list of clusters @Tags aws redshift @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/redshift/clusters [get]

Types

type ListClustersResponse

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