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 DiffMultiSecrets(c *gin.Context, dao db.ReaderDAO)
- func DiffSingleSecret(c *gin.Context, dao db.ReaderDAO)
- func GetSecret(c *gin.Context, dao db.ReaderDAO)
- func GetSecretsManagerMetadata(c *gin.Context)
- func GetSecretsMetadata(c *gin.Context, dao db.ReaderDAO)
- func ListSecrets(c *gin.Context, dao db.ReaderDAO)
- type ListSecretsResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DiffMultiSecrets ¶
DiffMultiSecrets godoc @Summary Diff Secrets @Description get a diff of Secrets between two points in time @Tags aws secretsmanager @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/secretsmanager/secrets [get]
func DiffSingleSecret ¶
DiffSingleSecret godoc @Summary Diff Secret @Description get a diff of Secret between two points in time @Tags aws secretsmanager @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 Secret to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/secretsmanager/secrets/{arn} [get]
func GetSecret ¶
GetSecret godoc @Summary Get a specific Secret @Description Get a specific Secret by its ARN @Tags aws secretsmanager @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 Secret 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} secretsmanager.Secret @Failure 400 @Failure 404 @Router /inventory/aws/secretsmanager/secrets/{arn} [get]
func GetSecretsManagerMetadata ¶
GetSecretsManagerMetadata godoc @Summary Get SecretsManager Metadata @Description get a list of SecretsManager metadata @Tags aws secretsmanager @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/secretsmanager [get]
func GetSecretsMetadata ¶
GetSecretsMetadata godoc @Summary Get Secrets Metadata @Description get a list of secrets metadata @Tags aws secretsmanager @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/secretsmanager/secrets [get]
func ListSecrets ¶
ListSecrets godoc @Summary List Secrets @Description get a list of secrets @Tags aws secretsmanager @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} ListSecretsResponse @Failure 400 @Router /inventory/aws/secretsmanager/secrets [get]
Types ¶
type ListSecretsResponse ¶
type ListSecretsResponse struct { Secrets []*secretsmanager.Secret `json:"secrets"` PaginationToken *string `json:"pagination_token,omitempty"` }