athena

package
v0.0.0-...-62343dc Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2022 License: MIT Imports: 7 Imported by: 0

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_api_routes.tmpl

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func DiffMultiDataCatalogs 

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

DiffMultiDataCatalogs godoc @Summary Diff DataCatalogs @Description get a diff of DataCatalogs between two points in time @Tags aws athena @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/athena/data_catalogs [get]

func DiffMultiDatabases 

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

DiffMultiDatabases godoc @Summary Diff Databases @Description get a diff of Databases between two points in time @Tags aws athena @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/athena/databases [get]

func DiffMultiWorkGroups 

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

DiffMultiWorkGroups godoc @Summary Diff WorkGroups @Description get a diff of WorkGroups between two points in time @Tags aws athena @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/athena/work_groups [get]

func DiffSingleDataCatalog 

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

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

func DiffSingleDatabase 

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

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

func DiffSingleWorkGroup 

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

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

func GetAthenaMetadata 

func GetAthenaMetadata(c *gin.Context)

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

func GetDataCatalog 

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

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

func GetDataCatalogsMetadata 

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

GetDataCatalogsMetadata godoc @Summary Get DataCatalogs Metadata @Description get a list of data_catalogs metadata @Tags aws athena @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/athena/data_catalogs [get]

func GetDatabase 

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

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

func GetDatabasesMetadata 

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

GetDatabasesMetadata godoc @Summary Get Databases Metadata @Description get a list of databases metadata @Tags aws athena @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/athena/databases [get]

func GetWorkGroup 

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

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

func GetWorkGroupsMetadata 

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

GetWorkGroupsMetadata godoc @Summary Get WorkGroups Metadata @Description get a list of work_groups metadata @Tags aws athena @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/athena/work_groups [get]

func ListDataCatalogs 

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

ListDataCatalogs godoc @Summary List DataCatalogs @Description get a list of data_catalogs @Tags aws athena @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} ListDataCatalogsResponse @Failure 400 @Router /inventory/aws/athena/data_catalogs [get]

func ListDatabases 

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

ListDatabases godoc @Summary List Databases @Description get a list of databases @Tags aws athena @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} ListDatabasesResponse @Failure 400 @Router /inventory/aws/athena/databases [get]

func ListWorkGroups 

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

ListWorkGroups godoc @Summary List WorkGroups @Description get a list of work_groups @Tags aws athena @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} ListWorkGroupsResponse @Failure 400 @Router /inventory/aws/athena/work_groups [get]

Types

type ListDataCatalogsResponse 

type ListDataCatalogsResponse struct {
	DataCatalogs    []*athena.DataCatalog `json:"data_catalogs"`
	PaginationToken *string               `json:"pagination_token,omitempty"`
}

type ListDatabasesResponse 

type ListDatabasesResponse struct {
	Databases       []*athena.Database `json:"databases"`
	PaginationToken *string            `json:"pagination_token,omitempty"`
}

type ListWorkGroupsResponse 

type ListWorkGroupsResponse struct {
	WorkGroups      []*athena.WorkGroup `json:"work_groups"`
	PaginationToken *string             `json:"pagination_token,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.