Documentation ¶
Overview ¶
AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_service_metadata_route.tmpl
AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl
Index ¶
- func DiffMultiStacks(c *gin.Context, dao db.ReaderDAO)
- func DiffSingleStack(c *gin.Context, dao db.ReaderDAO)
- func GetCloudFormationMetadata(c *gin.Context)
- func GetStack(c *gin.Context, dao db.ReaderDAO)
- func GetStacksMetadata(c *gin.Context, dao db.ReaderDAO)
- func ListStacks(c *gin.Context, dao db.ReaderDAO)
- type ListStacksResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DiffMultiStacks ¶
DiffMultiStacks godoc @Summary Diff Stacks @Description get a diff of Stacks between two points in time @Tags aws cloudformation @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/cloudformation/stacks [get]
func DiffSingleStack ¶
DiffSingleStack godoc @Summary Diff Stack @Description get a diff of Stack between two points in time @Tags aws cloudformation @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 stack_id path string true "The stack_id of the Stack to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/cloudformation/stacks/{stack_id} [get]
func GetCloudFormationMetadata ¶
GetCloudFormationMetadata godoc @Summary Get CloudFormation Metadata @Description get a list of CloudFormation metadata @Tags aws cloudformation @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/cloudformation [get]
func GetStack ¶
GetStack godoc @Summary Get a specific Stack @Description Get a specific Stack by its StackId @Tags aws cloudformation @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param stack_id path string true "The stack_id of the Stack 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} cloudformation.Stack @Failure 400 @Failure 404 @Router /inventory/aws/cloudformation/stacks/{stack_id} [get]
func GetStacksMetadata ¶
GetStacksMetadata godoc @Summary Get Stacks Metadata @Description get a list of stacks metadata @Tags aws cloudformation @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/cloudformation/stacks [get]
func ListStacks ¶
ListStacks godoc @Summary List Stacks @Description get a list of stacks @Tags aws cloudformation @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} ListStacksResponse @Failure 400 @Router /inventory/aws/cloudformation/stacks [get]
Types ¶
type ListStacksResponse ¶
type ListStacksResponse struct { Stacks []*cloudformation.Stack `json:"stacks"` PaginationToken *string `json:"pagination_token,omitempty"` }