feat(client-inspector2): This release adds CSV format to GetCisScanRe…

…port for Inspector v2
aws · May 3, 2024 · 79fb03b · 79fb03b
1 parent 9dac593
commit 79fb03b
Show file tree

Hide file tree

Showing 6 changed files with 107 additions and 46 deletions.
diff --git a/clients/client-inspector2/src/commands/GetCisScanReportCommand.ts b/clients/client-inspector2/src/commands/GetCisScanReportCommand.ts
@@ -39,6 +39,7 @@ export interface GetCisScanReportCommandOutput extends GetCisScanReportResponse,
  *   targetAccounts: [ // ReportTargetAccounts
  *     "STRING_VALUE",
  *   ],
+ *   reportFormat: "PDF" || "CSV",
  * };
  * const command = new GetCisScanReportCommand(input);
  * const response = await client.send(command);
@@ -61,6 +62,9 @@ export interface GetCisScanReportCommandOutput extends GetCisScanReportResponse,
  * @throws {@link InternalServerException} (server fault)
  *  <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
  *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</p>
+ *
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The limit on the number of requests per second was exceeded.</p>
  *

diff --git a/...nts/client-inspector2/src/commands/ListCisScanResultsAggregatedByTargetResourceCommand.ts b/...nts/client-inspector2/src/commands/ListCisScanResultsAggregatedByTargetResourceCommand.ts
@@ -6,8 +6,10 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { Inspector2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Inspector2Client";
-import { ListCisScanResultsAggregatedByTargetResourceRequest } from "../models/models_0";
-import { ListCisScanResultsAggregatedByTargetResourceResponse } from "../models/models_1";
+import {
+  ListCisScanResultsAggregatedByTargetResourceRequest,
+  ListCisScanResultsAggregatedByTargetResourceResponse,
+} from "../models/models_1";
 import {
   de_ListCisScanResultsAggregatedByTargetResourceCommand,
   se_ListCisScanResultsAggregatedByTargetResourceCommand,

diff --git a/clients/client-inspector2/src/models/models_0.ts b/clients/client-inspector2/src/models/models_0.ts
@@ -3328,6 +3328,20 @@ export interface CisNumberFilter {
   lowerInclusive?: number;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const CisReportFormat = {
+  CSV: "CSV",
+  PDF: "PDF",
+} as const;
+
+/**
+ * @public
+ */
+export type CisReportFormat = (typeof CisReportFormat)[keyof typeof CisReportFormat];
+
 /**
  * @public
  * @enum
@@ -7144,6 +7158,16 @@ export interface GetCisScanReportRequest {
    * @public
    */
   targetAccounts?: string[];
+
+  /**
+   * <p>
+   *          The format of the report.
+   *          Valid values are <code>PDF</code> and <code>CSV</code>.
+   *          If no value is specified, the report format defaults to <code>PDF</code>.
+   *       </p>
+   * @public
+   */
+  reportFormat?: CisReportFormat;
 }
 
 /**
@@ -7152,7 +7176,7 @@ export interface GetCisScanReportRequest {
 export interface GetCisScanReportResponse {
   /**
    * <p>
-   *          The URL where a PDF of the CIS scan report can be downloaded.
+   *          The URL where a PDF or CSV of the CIS scan report can be downloaded.
    *       </p>
    * @public
    */
@@ -7740,44 +7764,3 @@ export interface ListCisScanResultsAggregatedByChecksResponse {
    */
   nextToken?: string;
 }
-
-/**
- * @public
- */
-export interface ListCisScanResultsAggregatedByTargetResourceRequest {
-  /**
-   * <p>The scan ARN.</p>
-   * @public
-   */
-  scanArn: string | undefined;
-
-  /**
-   * <p>The filter criteria.</p>
-   * @public
-   */
-  filterCriteria?: CisScanResultsAggregatedByTargetResourceFilterCriteria;
-
-  /**
-   * <p>The sort by order.</p>
-   * @public
-   */
-  sortBy?: CisScanResultsAggregatedByTargetResourceSortBy;
-
-  /**
-   * <p>The sort order.</p>
-   * @public
-   */
-  sortOrder?: CisSortOrder;
-
-  /**
-   * <p>The pagination token from a previous request that's used to retrieve the next page of results.</p>
-   * @public
-   */
-  nextToken?: string;
-
-  /**
-   * <p>The maximum number of scan results aggregated by a target resource to be returned in a single page of results.</p>
-   * @public
-   */
-  maxResults?: number;
-}
diff --git a/clients/client-inspector2/src/models/models_1.ts b/clients/client-inspector2/src/models/models_1.ts
@@ -9,6 +9,8 @@ import {
   CisDateFilter,
   CisNumberFilter,
   CisScan,
+  CisScanResultsAggregatedByTargetResourceFilterCriteria,
+  CisScanResultsAggregatedByTargetResourceSortBy,
   CisScanStatusFilter,
   CisSecurityLevel,
   CisSessionMessage,
@@ -42,6 +44,47 @@ import {
   TagFilter,
 } from "./models_0";
 
+/**
+ * @public
+ */
+export interface ListCisScanResultsAggregatedByTargetResourceRequest {
+  /**
+   * <p>The scan ARN.</p>
+   * @public
+   */
+  scanArn: string | undefined;
+
+  /**
+   * <p>The filter criteria.</p>
+   * @public
+   */
+  filterCriteria?: CisScanResultsAggregatedByTargetResourceFilterCriteria;
+
+  /**
+   * <p>The sort by order.</p>
+   * @public
+   */
+  sortBy?: CisScanResultsAggregatedByTargetResourceSortBy;
+
+  /**
+   * <p>The sort order.</p>
+   * @public
+   */
+  sortOrder?: CisSortOrder;
+
+  /**
+   * <p>The pagination token from a previous request that's used to retrieve the next page of results.</p>
+   * @public
+   */
+  nextToken?: string;
+
+  /**
+   * <p>The maximum number of scan results aggregated by a target resource to be returned in a single page of results.</p>
+   * @public
+   */
+  maxResults?: number;
+}
+
 /**
  * @public
  */

diff --git a/clients/client-inspector2/src/protocols/Aws_restJson1.ts b/clients/client-inspector2/src/protocols/Aws_restJson1.ts
@@ -794,6 +794,7 @@ export const se_GetCisScanReportCommand = async (
   let body: any;
   body = JSON.stringify(
     take(input, {
+      reportFormat: [],
       scanArn: [],
       targetAccounts: (_) => _json(_),
     })

diff --git a/codegen/sdk-codegen/aws-models/inspector2.json b/codegen/sdk-codegen/aws-models/inspector2.json
@@ -1860,6 +1860,23 @@
         "smithy.api#pattern": "^\\d{12}|o-[a-z0-9]{10,32}$"
       }
     },
+    "com.amazonaws.inspector2#CisReportFormat": {
+      "type": "enum",
+      "members": {
+        "PDF": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "PDF"
+          }
+        },
+        "CSV": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "CSV"
+          }
+        }
+      }
+    },
     "com.amazonaws.inspector2#CisReportStatus": {
       "type": "enum",
       "members": {
@@ -6967,6 +6984,9 @@
         {
           "target": "com.amazonaws.inspector2#InternalServerException"
         },
+        {
+          "target": "com.amazonaws.inspector2#ResourceNotFoundException"
+        },
         {
           "target": "com.amazonaws.inspector2#ThrottlingException"
         },
@@ -6980,7 +7000,8 @@
           {
             "title": "Sample GetCisScanReport Call",
             "input": {
-              "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38"
+              "scanArn": "arn:aws:inspector2:us-east-1:123412341234:owner/123412341234/cis-scan/624b746d-e080-44ae-8c1d-48e653365a38",
+              "reportFormat": "PDF"
             },
             "output": {
               "url": "www.s3.amazon.com/abcdef",
@@ -7010,6 +7031,13 @@
           "traits": {
             "smithy.api#documentation": "<p>The target accounts.</p>"
           }
+        },
+        "reportFormat": {
+          "target": "com.amazonaws.inspector2#CisReportFormat",
+          "traits": {
+            "smithy.api#default": "PDF",
+            "smithy.api#documentation": "<p>\n         The format of the report. \n         Valid values are <code>PDF</code> and <code>CSV</code>. \n         If no value is specified, the report format defaults to <code>PDF</code>.\n      </p>"
+          }
         }
       },
       "traits": {
@@ -7022,7 +7050,7 @@
         "url": {
           "target": "smithy.api#String",
           "traits": {
-            "smithy.api#documentation": "<p>\n         The URL where a PDF of the CIS scan report can be downloaded.\n      </p>"
+            "smithy.api#documentation": "<p>\n         The URL where a PDF or CSV of the CIS scan report can be downloaded.\n      </p>"
           }
         },
         "status": {