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 DiffMultiGateways(c *gin.Context, dao db.ReaderDAO)
- func DiffSingleGateway(c *gin.Context, dao db.ReaderDAO)
- func GetGateway(c *gin.Context, dao db.ReaderDAO)
- func GetGatewaysMetadata(c *gin.Context, dao db.ReaderDAO)
- func GetStorageGatewayMetadata(c *gin.Context)
- func ListGateways(c *gin.Context, dao db.ReaderDAO)
- type ListGatewaysResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DiffMultiGateways ¶
DiffMultiGateways godoc @Summary Diff Gateways @Description get a diff of Gateways between two points in time @Tags aws storagegateway @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/storagegateway/gateways [get]
func DiffSingleGateway ¶
DiffSingleGateway godoc @Summary Diff Gateway @Description get a diff of Gateway between two points in time @Tags aws storagegateway @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 gateway_arn path string true "The gateway_arn of the Gateway to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/storagegateway/gateways/{gateway_arn} [get]
func GetGateway ¶
GetGateway godoc @Summary Get a specific Gateway @Description Get a specific Gateway by its GatewayARN @Tags aws storagegateway @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param gateway_arn path string true "The gateway_arn of the Gateway 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} storagegateway.Gateway @Failure 400 @Failure 404 @Router /inventory/aws/storagegateway/gateways/{gateway_arn} [get]
func GetGatewaysMetadata ¶
GetGatewaysMetadata godoc @Summary Get Gateways Metadata @Description get a list of gateways metadata @Tags aws storagegateway @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/storagegateway/gateways [get]
func GetStorageGatewayMetadata ¶
GetStorageGatewayMetadata godoc @Summary Get StorageGateway Metadata @Description get a list of StorageGateway metadata @Tags aws storagegateway @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/storagegateway [get]
func ListGateways ¶
ListGateways godoc @Summary List Gateways @Description get a list of gateways @Tags aws storagegateway @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} ListGatewaysResponse @Failure 400 @Router /inventory/aws/storagegateway/gateways [get]
Types ¶
type ListGatewaysResponse ¶
type ListGatewaysResponse struct { Gateways []*storagegateway.Gateway `json:"gateways"` PaginationToken *string `json:"pagination_token,omitempty"` }