sns

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

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

Index

• func DiffMultiSubscriptions(c *gin.Context, dao db.ReaderDAO)
• func DiffMultiTopics(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleSubscription(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleTopic(c *gin.Context, dao db.ReaderDAO)
• func GetSNSMetadata(c *gin.Context)
• func GetSubscription(c *gin.Context, dao db.ReaderDAO)
• func GetSubscriptionsMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetTopic(c *gin.Context, dao db.ReaderDAO)
• func GetTopicsMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListSubscriptions(c *gin.Context, dao db.ReaderDAO)
• func ListTopics(c *gin.Context, dao db.ReaderDAO)
• type ListSubscriptionsResponse
• type ListTopicsResponse

Functions

func DiffMultiSubscriptions

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

DiffMultiSubscriptions godoc @Summary Diff Subscriptions @Description get a diff of Subscriptions between two points in time @Tags aws sns @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/sns/subscriptions [get]

func DiffMultiTopics

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

DiffMultiTopics godoc @Summary Diff Topics @Description get a diff of Topics between two points in time @Tags aws sns @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/sns/topics [get]

func DiffSingleSubscription

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

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

func DiffSingleTopic

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

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

func GetSNSMetadata

func GetSNSMetadata(c *gin.Context)

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

func GetSubscription

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

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

func GetSubscriptionsMetadata

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

GetSubscriptionsMetadata godoc @Summary Get Subscriptions Metadata @Description get a list of subscriptions metadata @Tags aws sns @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/sns/subscriptions [get]

func GetTopic

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

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

func GetTopicsMetadata

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

GetTopicsMetadata godoc @Summary Get Topics Metadata @Description get a list of topics metadata @Tags aws sns @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/sns/topics [get]

func ListSubscriptions

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

ListSubscriptions godoc @Summary List Subscriptions @Description get a list of subscriptions @Tags aws sns @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} ListSubscriptionsResponse @Failure 400 @Router /inventory/aws/sns/subscriptions [get]

func ListTopics

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

ListTopics godoc @Summary List Topics @Description get a list of topics @Tags aws sns @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} ListTopicsResponse @Failure 400 @Router /inventory/aws/sns/topics [get]

Types

type ListSubscriptionsResponse

type ListSubscriptionsResponse struct {
	Subscriptions   []*sns.Subscription `json:"subscriptions"`
	PaginationToken *string             `json:"pagination_token,omitempty"`
}

type ListTopicsResponse

type ListTopicsResponse struct {
	Topics          []*sns.Topic `json:"topics"`
	PaginationToken *string      `json:"pagination_token,omitempty"`
}