backup

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_api_routes.tmpl

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_service_metadata_route.tmpl

Index

• func DiffMultiBackupPlans(c *gin.Context, dao db.ReaderDAO)
• func DiffMultiBackupVaults(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleBackupPlan(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleBackupVault(c *gin.Context, dao db.ReaderDAO)
• func GetBackupMetadata(c *gin.Context)
• func GetBackupPlan(c *gin.Context, dao db.ReaderDAO)
• func GetBackupPlansMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetBackupVault(c *gin.Context, dao db.ReaderDAO)
• func GetBackupVaultsMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListBackupPlans(c *gin.Context, dao db.ReaderDAO)
• func ListBackupVaults(c *gin.Context, dao db.ReaderDAO)
• type ListBackupPlansResponse
• type ListBackupVaultsResponse

Functions

func DiffMultiBackupPlans

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

DiffMultiBackupPlans godoc @Summary Diff BackupPlans @Description get a diff of BackupPlans between two points in time @Tags aws backup @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/backup/backup_plans [get]

func DiffMultiBackupVaults

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

DiffMultiBackupVaults godoc @Summary Diff BackupVaults @Description get a diff of BackupVaults between two points in time @Tags aws backup @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/backup/backup_vaults [get]

func DiffSingleBackupPlan

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

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

func DiffSingleBackupVault

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

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

func GetBackupMetadata

func GetBackupMetadata(c *gin.Context)

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

func GetBackupPlan

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

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

func GetBackupPlansMetadata

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

GetBackupPlansMetadata godoc @Summary Get BackupPlans Metadata @Description get a list of backup_plans metadata @Tags aws backup @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/backup/backup_plans [get]

func GetBackupVault

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

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

func GetBackupVaultsMetadata

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

GetBackupVaultsMetadata godoc @Summary Get BackupVaults Metadata @Description get a list of backup_vaults metadata @Tags aws backup @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/backup/backup_vaults [get]

func ListBackupPlans

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

ListBackupPlans godoc @Summary List BackupPlans @Description get a list of backup_plans @Tags aws backup @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} ListBackupPlansResponse @Failure 400 @Router /inventory/aws/backup/backup_plans [get]

func ListBackupVaults

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

ListBackupVaults godoc @Summary List BackupVaults @Description get a list of backup_vaults @Tags aws backup @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} ListBackupVaultsResponse @Failure 400 @Router /inventory/aws/backup/backup_vaults [get]

Types

type ListBackupPlansResponse

type ListBackupPlansResponse struct {
	BackupPlans     []*backup.BackupPlan `json:"backup_plans"`
	PaginationToken *string              `json:"pagination_token,omitempty"`
}

type ListBackupVaultsResponse

type ListBackupVaultsResponse struct {
	BackupVaults    []*backup.BackupVault `json:"backup_vaults"`
	PaginationToken *string               `json:"pagination_token,omitempty"`
}