cloudtrail

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 DiffMultiTrails(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleTrail(c *gin.Context, dao db.ReaderDAO)
• func GetCloudTrailMetadata(c *gin.Context)
• func GetTrail(c *gin.Context, dao db.ReaderDAO)
• func GetTrailsMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListTrails(c *gin.Context, dao db.ReaderDAO)
• type ListTrailsResponse

Functions

func DiffMultiTrails

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

DiffMultiTrails godoc @Summary Diff Trails @Description get a diff of Trails between two points in time @Tags aws cloudtrail @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/cloudtrail/trails [get]

func DiffSingleTrail

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

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

func GetCloudTrailMetadata

func GetCloudTrailMetadata(c *gin.Context)

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

func GetTrail

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

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

func GetTrailsMetadata

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

GetTrailsMetadata godoc @Summary Get Trails Metadata @Description get a list of trails metadata @Tags aws cloudtrail @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/cloudtrail/trails [get]

func ListTrails

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

ListTrails godoc @Summary List Trails @Description get a list of trails @Tags aws cloudtrail @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} ListTrailsResponse @Failure 400 @Router /inventory/aws/cloudtrail/trails [get]

Types

type ListTrailsResponse

type ListTrailsResponse struct {
	Trails          []*cloudtrail.Trail `json:"trails"`
	PaginationToken *string             `json:"pagination_token,omitempty"`
}