kms

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 DiffMultiKeys(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleKey(c *gin.Context, dao db.ReaderDAO)
• func GetKMSMetadata(c *gin.Context)
• func GetKey(c *gin.Context, dao db.ReaderDAO)
• func GetKeysMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListKeys(c *gin.Context, dao db.ReaderDAO)
• type ListKeysResponse

Functions

func DiffMultiKeys

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

DiffMultiKeys godoc @Summary Diff Keys @Description get a diff of Keys between two points in time @Tags aws kms @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/kms/keys [get]

func DiffSingleKey

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

DiffSingleKey godoc @Summary Diff Key @Description get a diff of Key between two points in time @Tags aws kms @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 Key to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/kms/keys/{arn} [get]

func GetKMSMetadata

func GetKMSMetadata(c *gin.Context)

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

func GetKey

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

GetKey godoc @Summary Get a specific Key @Description Get a specific Key by its Arn @Tags aws kms @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 Key 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} kms.Key @Failure 400 @Failure 404 @Router /inventory/aws/kms/keys/{arn} [get]

func GetKeysMetadata

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

GetKeysMetadata godoc @Summary Get Keys Metadata @Description get a list of keys metadata @Tags aws kms @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/kms/keys [get]

func ListKeys

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

ListKeys godoc @Summary List Keys @Description get a list of keys @Tags aws kms @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} ListKeysResponse @Failure 400 @Router /inventory/aws/kms/keys [get]

Types

type ListKeysResponse

type ListKeysResponse struct {
	Keys            []*kms.Key `json:"keys"`
	PaginationToken *string    `json:"pagination_token,omitempty"`
}