route53

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 DiffMultiHostedZones(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleHostedZone(c *gin.Context, dao db.ReaderDAO)
• func GetHostedZone(c *gin.Context, dao db.ReaderDAO)
• func GetHostedZonesMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetRoute53Metadata(c *gin.Context)
• func ListHostedZones(c *gin.Context, dao db.ReaderDAO)
• type ListHostedZonesResponse

Functions

func DiffMultiHostedZones

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

DiffMultiHostedZones godoc @Summary Diff HostedZones @Description get a diff of HostedZones between two points in time @Tags aws route53 @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/route53/hosted_zones [get]

func DiffSingleHostedZone

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

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

func GetHostedZone

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

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

func GetHostedZonesMetadata

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

GetHostedZonesMetadata godoc @Summary Get HostedZones Metadata @Description get a list of hosted_zones metadata @Tags aws route53 @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/route53/hosted_zones [get]

func GetRoute53Metadata

func GetRoute53Metadata(c *gin.Context)

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

func ListHostedZones

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

ListHostedZones godoc @Summary List HostedZones @Description get a list of hosted_zones @Tags aws route53 @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} ListHostedZonesResponse @Failure 400 @Router /inventory/aws/route53/hosted_zones [get]

Types

type ListHostedZonesResponse

type ListHostedZonesResponse struct {
	HostedZones     []*route53.HostedZone `json:"hosted_zones"`
	PaginationToken *string               `json:"pagination_token,omitempty"`
}