efs

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 DiffMultiFileSystems(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleFileSystem(c *gin.Context, dao db.ReaderDAO)
• func GetEFSMetadata(c *gin.Context)
• func GetFileSystem(c *gin.Context, dao db.ReaderDAO)
• func GetFileSystemsMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListFileSystems(c *gin.Context, dao db.ReaderDAO)
• type ListFileSystemsResponse

Functions

func DiffMultiFileSystems

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

DiffMultiFileSystems godoc @Summary Diff FileSystems @Description get a diff of FileSystems between two points in time @Tags aws efs @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/efs/file_systems [get]

func DiffSingleFileSystem

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

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

func GetEFSMetadata

func GetEFSMetadata(c *gin.Context)

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

func GetFileSystem

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

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

func GetFileSystemsMetadata

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

GetFileSystemsMetadata godoc @Summary Get FileSystems Metadata @Description get a list of file_systems metadata @Tags aws efs @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/efs/file_systems [get]

func ListFileSystems

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

ListFileSystems godoc @Summary List FileSystems @Description get a list of file_systems @Tags aws efs @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} ListFileSystemsResponse @Failure 400 @Router /inventory/aws/efs/file_systems [get]

Types

type ListFileSystemsResponse

type ListFileSystemsResponse struct {
	FileSystems     []*efs.FileSystem `json:"file_systems"`
	PaginationToken *string           `json:"pagination_token,omitempty"`
}