Definitions Update remediations

Author: cibot

alsdkdefs/apis/remediations/assets_query.v1.yaml

@@ -1683,6 +1683,15 @@ paths:
                       description: |-
                         A list of asset types that determines the assets included in the individual scope. If an asset would be included in
                         multiple scopes, the scopes' allowed asset types are unioned together.
+                return_asset_types:
+                  type: array
+                  description: |-
+                    A list of groupable asset types that limits the exploration of the asset model. The types specified in
+                    this list, as well as their topological ancestor types, are the only ones that will be returned in the
+                    resulting topology.assets rows.
+                  items:
+                    type: string
+                    minLength: 1
       x-codeSamples:
         - lang: Shell
           label: Topology Preview
@@ -1696,6 +1705,26 @@ paths:
                     "deployment:any",
                     "region.name:!eu-west-1"
                   ]
+                }
+              ]
+            }
+            EOF
+        - lang: Shell
+          label: Topology Preview (return_asset_types=host)
+          source: |-
+            curl "https://api.cloudinsight.alertlogic.com/assets_query/v1/19000001/topology/asset_group" \
+                 -X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
+            {
+              "scopes": [
+                {
+                  "include": [
+                    "deployment:any",
+                    "region.name:!eu-west-1"
+                  ]
+                }
+              ],
+              "return_asset_types": [
+                "host"
               ]
             }
             EOF
@@ -1708,7 +1737,9 @@ paths:
                 $ref: 'schemas.yaml#/TopologyPreviewResponse'
               examples:
                 Topology Preview Example:
-                  $ref: 'examples.yaml#/TopologyPreviewExample'
+                  $ref: 'examples.yaml#/FullAssetGroupTopologyPreviewExample'
+                'Topology Preview Example (return_asset_types=host)':
+                  $ref: 'examples.yaml#/HostAssetGroupTopologyPreviewExample'
         "401":
           $ref: 'responses.yaml#/Unauthorized'
         "403":

alsdkdefs/apis/remediations/examples.yaml

@@ -3313,7 +3313,7 @@ QueryTopologyOverviewExample:
         - - host:/aws/us-east-1/host/web-1a-1
           - image:/aws/us-east-1/image/ami-1
       rows: 3
-TopologyPreviewExample:
+FullAssetGroupTopologyPreviewExample:
   value:
     topology:
       assets:
@@ -3414,6 +3414,88 @@ TopologyPreviewExample:
           threatiness: 22
           type: vpc
       rows: 9
+HostAssetGroupTopologyPreviewExample:
+  value:
+    topology:
+      assets:
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-west-2
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/eu-west-1
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-east-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/us-east-1/vpc/vpc-1
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/eu-west-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/eu-west-1/vpc/vpc-1
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-east-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/us-east-1/vpc/vpc-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:subnet:/aws/us-east-1/subnet/subnet-1a-web
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-east-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/us-east-1/vpc/vpc-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:subnet:/aws/us-east-1/subnet/subnet-1a-web
+          - 814C2911-09BB-1005-9916-7831C1BAC182:host:/aws/us-east-1/host/web-1a-1
+        - - 814C2911-09BB-1005-9916-7831C1BAC182:deployment:/al/19000001/aws/814C2911-09BB-1005-9916-7831C1BAC182
+          - 814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-east-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/us-east-1/vpc/vpc-1
+          - 814C2911-09BB-1005-9916-7831C1BAC182:host:/aws/us-east-1/host/web-1a-1
+      data:
+        814C2911-09BB-1005-9916-7831C1BAC182:host:/aws/us-east-1/host/web-1a-1:
+          alertlogic_agent: false
+          alertlogic_appliance: true
+          created_on: 1427317669928
+          group_membership: IN
+          key: "/aws/us-east-1/host/web-1a-1"
+          state: running
+          threat_level: 2
+          threatiness: 2
+          type: host
+        814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-east-1:
+          created_on: 1427317669194
+          group_membership: IN
+          key: "/aws/us-east-1"
+          threat_level: 3
+          threatiness: 22
+          type: region
+        814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/us-west-2:
+          created_on: 1589381951438
+          group_membership: NOT_IN
+          key: "/aws/us-west-2"
+          threat_level: 0
+          threatiness: 0
+          type: region
+        814C2911-09BB-1005-9916-7831C1BAC182:region:/aws/eu-west-1:
+          created_on: 1589381951438
+          group_membership: EXCLUDED
+          key: "/aws/eu-west-1"
+          threat_level: 0
+          threatiness: 0
+          type: region
+        814C2911-09BB-1005-9916-7831C1BAC182:subnet:/aws/us-east-1/subnet/subnet-1a-web:
+          created_on: 1427317669627
+          group_membership: IN
+          key: "/aws/us-east-1/subnet/subnet-1a-web"
+          threat_level: 2
+          threatiness: 8
+          type: subnet
+        814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/us-east-1/vpc/vpc-1:
+          created_on: 1427317669270
+          group_membership: IN
+          key: "/aws/us-east-1/vpc/vpc-1"
+          threat_level: 3
+          threatiness: 22
+          type: vpc
+        814C2911-09BB-1005-9916-7831C1BAC182:vpc:/aws/eu-west-1/vpc/vpc-2:
+          created_on: 1427317669270
+          group_membership: EXCLUDED
+          key: "/aws/eu-west-1/vpc/vpc-2"
+          threat_level: 3
+          threatiness: 22
+          type: vpc
+      rows: 7
+
 DisposeSingleRemediationExample:
   value:
     assets: