cloudfront

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 DiffMultiDistributions(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleDistribution(c *gin.Context, dao db.ReaderDAO)
• func GetCloudFrontMetadata(c *gin.Context)
• func GetDistribution(c *gin.Context, dao db.ReaderDAO)
• func GetDistributionsMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListDistributions(c *gin.Context, dao db.ReaderDAO)
• type ListDistributionsResponse

Functions

func DiffMultiDistributions

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

DiffMultiDistributions godoc @Summary Diff Distributions @Description get a diff of Distributions between two points in time @Tags aws cloudfront @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/cloudfront/distributions [get]

func DiffSingleDistribution

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

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

func GetCloudFrontMetadata

func GetCloudFrontMetadata(c *gin.Context)

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

func GetDistribution

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

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

func GetDistributionsMetadata

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

GetDistributionsMetadata godoc @Summary Get Distributions Metadata @Description get a list of distributions metadata @Tags aws cloudfront @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/cloudfront/distributions [get]

func ListDistributions

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

ListDistributions godoc @Summary List Distributions @Description get a list of distributions @Tags aws cloudfront @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} ListDistributionsResponse @Failure 400 @Router /inventory/aws/cloudfront/distributions [get]

Types

type ListDistributionsResponse

type ListDistributionsResponse struct {
	Distributions   []*cloudfront.Distribution `json:"distributions"`
	PaginationToken *string                    `json:"pagination_token,omitempty"`
}