sqs

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

Index

• func DiffMultiQueues(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleQueue(c *gin.Context, dao db.ReaderDAO)
• func GetQueue(c *gin.Context, dao db.ReaderDAO)
• func GetQueuesMetadata(c *gin.Context, dao db.ReaderDAO)
• func GetSQSMetadata(c *gin.Context)
• func ListQueues(c *gin.Context, dao db.ReaderDAO)
• type ListQueuesResponse

Functions

func DiffMultiQueues

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

DiffMultiQueues godoc @Summary Diff Queues @Description get a diff of Queues between two points in time @Tags aws sqs @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/sqs/queues [get]

func DiffSingleQueue

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

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

func GetQueue

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

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

func GetQueuesMetadata

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

GetQueuesMetadata godoc @Summary Get Queues Metadata @Description get a list of queues metadata @Tags aws sqs @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/sqs/queues [get]

func GetSQSMetadata

func GetSQSMetadata(c *gin.Context)

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

func ListQueues

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

ListQueues godoc @Summary List Queues @Description get a list of queues @Tags aws sqs @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} ListQueuesResponse @Failure 400 @Router /inventory/aws/sqs/queues [get]

Types

type ListQueuesResponse

type ListQueuesResponse struct {
	Queues          []*sqs.Queue `json:"queues"`
	PaginationToken *string      `json:"pagination_token,omitempty"`
}