s3

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 DiffMultiBuckets(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleBucket(c *gin.Context, dao db.ReaderDAO)
• func GetBucket(c *gin.Context, dao db.ReaderDAO)
• func GetBucketsMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetS3Metadata(c *gin.Context)
• func ListBuckets(c *gin.Context, dao db.ReaderDAO)
• type ListBucketsResponse

Functions

func DiffMultiBuckets

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

DiffMultiBuckets godoc @Summary Diff Buckets @Description get a diff of Buckets between two points in time @Tags aws s3 @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/s3/buckets [get]

func DiffSingleBucket

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

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

func GetBucket

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

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

func GetBucketsMetadata

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

GetBucketsMetadata godoc @Summary Get Buckets Metadata @Description get a list of buckets metadata @Tags aws s3 @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/s3/buckets [get]

func GetS3Metadata

func GetS3Metadata(c *gin.Context)

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

func ListBuckets

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

ListBuckets godoc @Summary List Buckets @Description get a list of buckets @Tags aws s3 @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} ListBucketsResponse @Failure 400 @Router /inventory/aws/s3/buckets [get]

Types

type ListBucketsResponse

type ListBucketsResponse struct {
	Buckets         []*s3.Bucket `json:"buckets"`
	PaginationToken *string      `json:"pagination_token,omitempty"`
}