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_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
AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl
Index ¶
- func DiffMultiGroups(c *gin.Context, dao db.ReaderDAO)
- func DiffMultiPolicies(c *gin.Context, dao db.ReaderDAO)
- func DiffMultiRoles(c *gin.Context, dao db.ReaderDAO)
- func DiffMultiUsers(c *gin.Context, dao db.ReaderDAO)
- func DiffSingleGroup(c *gin.Context, dao db.ReaderDAO)
- func DiffSinglePolicy(c *gin.Context, dao db.ReaderDAO)
- func DiffSingleRole(c *gin.Context, dao db.ReaderDAO)
- func DiffSingleUser(c *gin.Context, dao db.ReaderDAO)
- func GetGroup(c *gin.Context, dao db.ReaderDAO)
- func GetGroupsMetadata(c *gin.Context, dao db.ReaderDAO)
- func GetIAMMetadata(c *gin.Context)
- func GetPoliciesMetadata(c *gin.Context, dao db.ReaderDAO)
- func GetPolicy(c *gin.Context, dao db.ReaderDAO)
- func GetRole(c *gin.Context, dao db.ReaderDAO)
- func GetRolesMetadata(c *gin.Context, dao db.ReaderDAO)
- func GetUser(c *gin.Context, dao db.ReaderDAO)
- func GetUsersMetadata(c *gin.Context, dao db.ReaderDAO)
- func ListGroups(c *gin.Context, dao db.ReaderDAO)
- func ListPolicies(c *gin.Context, dao db.ReaderDAO)
- func ListRoles(c *gin.Context, dao db.ReaderDAO)
- func ListUsers(c *gin.Context, dao db.ReaderDAO)
- type ListGroupsResponse
- type ListPoliciesResponse
- type ListRolesResponse
- type ListUsersResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DiffMultiGroups ¶
DiffMultiGroups godoc @Summary Diff Groups @Description get a diff of Groups between two points in time @Tags aws iam @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/iam/groups [get]
func DiffMultiPolicies ¶
DiffMultiPolicies godoc @Summary Diff Policies @Description get a diff of Policies between two points in time @Tags aws iam @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/iam/policies [get]
func DiffMultiRoles ¶
DiffMultiRoles godoc @Summary Diff Roles @Description get a diff of Roles between two points in time @Tags aws iam @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/iam/roles [get]
func DiffMultiUsers ¶
DiffMultiUsers godoc @Summary Diff Users @Description get a diff of Users between two points in time @Tags aws iam @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/iam/users [get]
func DiffSingleGroup ¶
DiffSingleGroup godoc @Summary Diff Group @Description get a diff of Group between two points in time @Tags aws iam @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 group_id path string true "The group_id of the Group to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/iam/groups/{group_id} [get]
func DiffSinglePolicy ¶
DiffSinglePolicy godoc @Summary Diff Policy @Description get a diff of Policy between two points in time @Tags aws iam @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 policy_id path string true "The policy_id of the Policy to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/iam/policies/{policy_id} [get]
func DiffSingleRole ¶
DiffSingleRole godoc @Summary Diff Role @Description get a diff of Role between two points in time @Tags aws iam @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 role_id path string true "The role_id of the Role to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/iam/roles/{role_id} [get]
func DiffSingleUser ¶
DiffSingleUser godoc @Summary Diff User @Description get a diff of User between two points in time @Tags aws iam @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 user_id path string true "The user_id of the User to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/iam/users/{user_id} [get]
func GetGroup ¶
GetGroup godoc @Summary Get a specific Group @Description Get a specific Group by its GroupId @Tags aws iam @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param group_id path string true "The group_id of the Group 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} iam.Group @Failure 400 @Failure 404 @Router /inventory/aws/iam/groups/{group_id} [get]
func GetGroupsMetadata ¶
GetGroupsMetadata godoc @Summary Get Groups Metadata @Description get a list of groups metadata @Tags aws iam @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/iam/groups [get]
func GetIAMMetadata ¶
GetIAMMetadata godoc @Summary Get IAM Metadata @Description get a list of IAM metadata @Tags aws iam @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/iam [get]
func GetPoliciesMetadata ¶
GetPoliciesMetadata godoc @Summary Get Policies Metadata @Description get a list of policies metadata @Tags aws iam @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/iam/policies [get]
func GetPolicy ¶
GetPolicy godoc @Summary Get a specific Policy @Description Get a specific Policy by its PolicyId @Tags aws iam @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param policy_id path string true "The policy_id of the Policy 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} iam.Policy @Failure 400 @Failure 404 @Router /inventory/aws/iam/policies/{policy_id} [get]
func GetRole ¶
GetRole godoc @Summary Get a specific Role @Description Get a specific Role by its RoleId @Tags aws iam @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param role_id path string true "The role_id of the Role 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} iam.Role @Failure 400 @Failure 404 @Router /inventory/aws/iam/roles/{role_id} [get]
func GetRolesMetadata ¶
GetRolesMetadata godoc @Summary Get Roles Metadata @Description get a list of roles metadata @Tags aws iam @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/iam/roles [get]
func GetUser ¶
GetUser godoc @Summary Get a specific User @Description Get a specific User by its UserId @Tags aws iam @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param user_id path string true "The user_id of the User 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} iam.User @Failure 400 @Failure 404 @Router /inventory/aws/iam/users/{user_id} [get]
func GetUsersMetadata ¶
GetUsersMetadata godoc @Summary Get Users Metadata @Description get a list of users metadata @Tags aws iam @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/iam/users [get]
func ListGroups ¶
ListGroups godoc @Summary List Groups @Description get a list of groups @Tags aws iam @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} ListGroupsResponse @Failure 400 @Router /inventory/aws/iam/groups [get]
func ListPolicies ¶
ListPolicies godoc @Summary List Policies @Description get a list of policies @Tags aws iam @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} ListPoliciesResponse @Failure 400 @Router /inventory/aws/iam/policies [get]
func ListRoles ¶
ListRoles godoc @Summary List Roles @Description get a list of roles @Tags aws iam @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} ListRolesResponse @Failure 400 @Router /inventory/aws/iam/roles [get]
func ListUsers ¶
ListUsers godoc @Summary List Users @Description get a list of users @Tags aws iam @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} ListUsersResponse @Failure 400 @Router /inventory/aws/iam/users [get]