acm

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 DiffMultiCertificates(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleCertificate(c *gin.Context, dao db.ReaderDAO)
• func GetACMMetadata(c *gin.Context)
• func GetCertificate(c *gin.Context, dao db.ReaderDAO)
• func GetCertificatesMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListCertificates(c *gin.Context, dao db.ReaderDAO)
• type ListCertificatesResponse

Functions

func DiffMultiCertificates

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

DiffMultiCertificates godoc @Summary Diff Certificates @Description get a diff of Certificates between two points in time @Tags aws acm @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/acm/certificates [get]

func DiffSingleCertificate

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

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

func GetACMMetadata

func GetACMMetadata(c *gin.Context)

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

func GetCertificate

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

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

func GetCertificatesMetadata

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

GetCertificatesMetadata godoc @Summary Get Certificates Metadata @Description get a list of certificates metadata @Tags aws acm @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/acm/certificates [get]

func ListCertificates

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

ListCertificates godoc @Summary List Certificates @Description get a list of certificates @Tags aws acm @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} ListCertificatesResponse @Failure 400 @Router /inventory/aws/acm/certificates [get]

Types

type ListCertificatesResponse

type ListCertificatesResponse struct {
	Certificates    []*acm.Certificate `json:"certificates"`
	PaginationToken *string            `json:"pagination_token,omitempty"`
}