Skip to content

Commit 3c39592

Browse files
author
cibot
committed
Definitions Update aetuner
1 parent e788f25 commit 3c39592

File tree

1 file changed

+226
-0
lines changed

1 file changed

+226
-0
lines changed

‎alsdkdefs/apis/aetuner/aetuner.v1.yaml‎

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -527,6 +527,75 @@ paths:
527527
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerGetAnalytic2Function.Arn}/invocations'
528528
tags:
529529
- aetuner
530+
post:
531+
summary: Update Analytics
532+
operationId: update_analytic2
533+
responses:
534+
'201':
535+
description: Ok
536+
security:
537+
- aims_request_authorizer: []
538+
requestBody:
539+
content:
540+
application/json:
541+
schema:
542+
type: object
543+
properties:
544+
disable_validation:
545+
type: boolean
546+
description: "Disable the check that tuning referes to a tagset referenced by the analytic. Use if there is a tuning tagset that is not detected to be refernced by an analytic"
547+
default: false
548+
tuning:
549+
type: array
550+
items:
551+
$ref: '#/components/schemas/Tuning'
552+
description: |-
553+
A list of tunings for the analytic.
554+
555+
For visiblity, severity, threshold and handling when the default tagsets are not used it is possible
556+
to expliclity provide a tagset path and key in the tagset for tuning. For blacklist and whitelist
557+
tuning a tagset path and key must be provided. Examples explain how to use it.
558+
559+
NOTE: Spaces are not allowed between the items of a list.
560+
561+
Examples:
562+
Severity
563+
- {"type":"severity","value":"low"}
564+
- {"type":"severity","path":"CustomSeverityMap","key":"windows","value":"low"}
565+
Visibity to incident
566+
- {"type":"visiblity","value":"incident"}
567+
- {"type":"visiblity","path":"CustomVisibilityMap","key":"windows","value":"incident"}
568+
Threshold
569+
- threshold:100
570+
Handling
571+
- {"type":"handling","operation":"add","value":"auto_soc_close"}
572+
- {"type":"handling","operation":"subtract","value":"auto_escalate"}
573+
- {"type":"handling","operation":"add","path":"CustomHandlingMap","key":"windows","value":"auto_soc_close"}
574+
Whitelist
575+
- {"type":"whitelist","operation":"add","path":"tuning/SomeWhitelist","key":"windows","value":["1.0.0.0"]}
576+
- {"type":"whitelist","operation":"subtract","path":"tuning/SomeWhitelist","key":"windows","value":["1.0.0.0","2.0.0.0"]}
577+
Blacklist
578+
- {"type":"blacklist","operation":add","path":"tuning/SomeBlacklist","key":"windows","value":["1.0.0.0"]}
579+
- {"type":"blacklist","operation":subtract,"path":"tuning/SomeBlacklist","key":"windows","value":["1.0.0.0","2.0.0.0"]}
580+
581+
To specify more than one tuning provide them in list like
582+
583+
'[{"type":"severity","value":"incident"},{"type":"visibility","value":"high"},{"type":"threshold","value":"100"}]'
584+
dry_run:
585+
type: boolean
586+
description: "DRY RUN only"
587+
reason:
588+
type: string
589+
description: Reason for the performing the update. This information is used for auditing purposes.
590+
required:
591+
- reason
592+
required: true
593+
description: Update an analytic
594+
x-amazon-apigateway-integration:
595+
uri:
596+
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerUpdateAnalyticFunction.Arn}/invocations'
597+
tags:
598+
- aetuner
530599
'/v1/{account_id}/reset/analytics/{path}':
531600
parameters:
532601
- schema:
@@ -579,6 +648,58 @@ paths:
579648
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAnalyticFunction.Arn}/invocations'
580649
tags:
581650
- aetuner
651+
'/v1/{account_id}/reset/analytics2/{path}':
652+
parameters:
653+
- schema:
654+
type: string
655+
name: account_id
656+
in: path
657+
required: true
658+
description: AIMS Account ID
659+
- schema:
660+
type: string
661+
name: path
662+
in: path
663+
required: true
664+
description: Analytic Fully Qualified Name
665+
post:
666+
summary: Reset Analytics setting to defaults
667+
operationId: reset_analytic2
668+
responses:
669+
'201':
670+
description: Ok
671+
security:
672+
- aims_request_authorizer: []
673+
requestBody:
674+
content:
675+
application/json:
676+
schema:
677+
type: object
678+
properties:
679+
visibility:
680+
type: boolean
681+
severity:
682+
type: boolean
683+
reason:
684+
type: string
685+
description: Reason for the performing the reset. This information is used for auditing purposes.
686+
tuning:
687+
type: array
688+
items:
689+
type: string
690+
example:
691+
- threshold
692+
- whitelist
693+
description: List of tuning keys to reset
694+
required:
695+
- reason
696+
required: true
697+
description: Reset an analytic
698+
x-amazon-apigateway-integration:
699+
uri:
700+
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAnalytic2Function.Arn}/invocations'
701+
tags:
702+
- aetuner
582703
'/v1/{account_id}/reset/all_analytics/visibility':
583704
parameters:
584705
- schema:
@@ -614,6 +735,41 @@ paths:
614735
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAllAnalyticsVisibilityFunction.Arn}/invocations'
615736
tags:
616737
- aetuner
738+
'/v1/{account_id}/reset/all_analytics/visibility2':
739+
parameters:
740+
- schema:
741+
type: string
742+
name: account_id
743+
in: path
744+
required: true
745+
description: AIMS Account ID
746+
post:
747+
summary: Reset all Analytics visibility fields to default
748+
operationId: reset_all_analytics_visibility2
749+
responses:
750+
'201':
751+
description: Ok
752+
content:
753+
application/json:
754+
schema:
755+
type: object
756+
properties:
757+
handling_update:
758+
$ref: '#/components/schemas/ResetAllAnalyticsResponseBody'
759+
security:
760+
- aims_request_authorizer: []
761+
requestBody:
762+
content:
763+
application/json:
764+
schema:
765+
$ref: '#/components/schemas/ResetAllAnalyticsRequestBody'
766+
required: true
767+
description: Reset all Analytics visibility
768+
x-amazon-apigateway-integration:
769+
uri:
770+
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAllAnalyticsVisibility2Function.Arn}/invocations'
771+
tags:
772+
- aetuner
617773
'/v1/{account_id}/reset/all_analytics/severity':
618774
parameters:
619775
- schema:
@@ -649,6 +805,41 @@ paths:
649805
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAllAnalyticsSeverityFunction.Arn}/invocations'
650806
tags:
651807
- aetuner
808+
'/v1/{account_id}/reset/all_analytics/severity2':
809+
parameters:
810+
- schema:
811+
type: string
812+
name: account_id
813+
in: path
814+
required: true
815+
description: AIMS Account ID
816+
post:
817+
summary: Reset all Analytics severity to defaults
818+
operationId: reset_all_analytics_severity2
819+
responses:
820+
'201':
821+
description: Ok
822+
content:
823+
application/json:
824+
schema:
825+
type: object
826+
properties:
827+
severity_update:
828+
$ref: '#/components/schemas/ResetAllAnalyticsResponseBody'
829+
security:
830+
- aims_request_authorizer: []
831+
requestBody:
832+
content:
833+
application/json:
834+
schema:
835+
$ref: '#/components/schemas/ResetAllAnalyticsRequestBody'
836+
required: true
837+
description: Reset all Analytics severity
838+
x-amazon-apigateway-integration:
839+
uri:
840+
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAllAnalyticsSeverity2Function.Arn}/invocations'
841+
tags:
842+
- aetuner
652843
'/v1/{account_id}/reset/all_analytics/handling':
653844
parameters:
654845
- schema:
@@ -684,6 +875,41 @@ paths:
684875
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAllAnalyticsHandlingFunction.Arn}/invocations'
685876
tags:
686877
- aetuner
878+
'/v1/{account_id}/reset/all_analytics/handling2':
879+
parameters:
880+
- schema:
881+
type: string
882+
name: account_id
883+
in: path
884+
required: true
885+
description: AIMS Account ID
886+
post:
887+
summary: Reset all Analytics handling to defaults
888+
operationId: reset_all_analytics_handling2
889+
responses:
890+
'201':
891+
description: Ok
892+
content:
893+
application/json:
894+
schema:
895+
type: object
896+
properties:
897+
handling_update:
898+
$ref: '#/components/schemas/ResetAllAnalyticsResponseBody'
899+
security:
900+
- aims_request_authorizer: []
901+
requestBody:
902+
content:
903+
application/json:
904+
schema:
905+
$ref: '#/components/schemas/ResetAllAnalyticsRequestBody'
906+
required: true
907+
description: Reset all Analytics handling
908+
x-amazon-apigateway-integration:
909+
uri:
910+
'Fn::Sub': 'arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${AETunerResetAllAnalyticsHandling2Function.Arn}/invocations'
911+
tags:
912+
- aetuner
687913
'/v1/tunings/report':
688914
get:
689915
summary: Tuning report commands

0 commit comments

Comments
 (0)