dynamodb

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 DiffMultiTables(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleTable(c *gin.Context, dao db.ReaderDAO)
• func GetDynamoDBMetadata(c *gin.Context)
• func GetTable(c *gin.Context, dao db.ReaderDAO)
• func GetTablesMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListTables(c *gin.Context, dao db.ReaderDAO)
• type ListTablesResponse

Functions

func DiffMultiTables

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

DiffMultiTables godoc @Summary Diff Tables @Description get a diff of Tables between two points in time @Tags aws dynamodb @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/dynamodb/tables [get]

func DiffSingleTable

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

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

func GetDynamoDBMetadata

func GetDynamoDBMetadata(c *gin.Context)

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

func GetTable

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

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

func GetTablesMetadata

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

GetTablesMetadata godoc @Summary Get Tables Metadata @Description get a list of tables metadata @Tags aws dynamodb @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/dynamodb/tables [get]

func ListTables

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

ListTables godoc @Summary List Tables @Description get a list of tables @Tags aws dynamodb @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} ListTablesResponse @Failure 400 @Router /inventory/aws/dynamodb/tables [get]

Types

type ListTablesResponse

type ListTablesResponse struct {
	Tables          []*dynamodb.Table `json:"tables"`
	PaginationToken *string           `json:"pagination_token,omitempty"`
}