feat(client-inspector-scan): Adds an additional OutputFormat

awstools · awstools · commit fb2ca52a8c14 · 2025-12-17T19:40:53.000Z
diff --git a/clients/client-inspector-scan/src/commands/ScanSbomCommand.ts b/clients/client-inspector-scan/src/commands/ScanSbomCommand.ts
@@ -27,7 +27,7 @@ export interface ScanSbomCommandInput extends ScanSbomRequest {}
 export interface ScanSbomCommandOutput extends ScanSbomResponse, __MetadataBearer {}
 
 /**
- * <p>Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the <a href="">Amazon Inspector SBOM generator</a>.</p>
+ * <p>Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the <a href="https://docs.aws.amazon.com/inspector/latest/user/sbom-generator.html">Amazon Inspector SBOM generator</a>.</p> <note> <p> The output of this action reports NVD and CVSS scores when NVD and CVSS scores are available. Because the output reports both scores, you might notice a discrepency between them. However, you can triage the severity of either score depending on the vendor of your choosing. </p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -38,7 +38,7 @@ export interface ScanSbomCommandOutput extends ScanSbomResponse, __MetadataBeare
  * const client = new InspectorScanClient(config);
  * const input = { // ScanSbomRequest
  *   sbom: "DOCUMENT_VALUE", // required
- *   outputFormat: "CYCLONE_DX_1_5" || "INSPECTOR",
+ *   outputFormat: "CYCLONE_DX_1_5" || "INSPECTOR" || "INSPECTOR_ALT",
  * };
  * const command = new ScanSbomCommand(input);
  * const response = await client.send(command);
@@ -55,18 +55,13 @@ export interface ScanSbomCommandOutput extends ScanSbomResponse, __MetadataBeare
  * @see {@link InspectorScanClientResolvedConfig | config} for InspectorScanClient's `config` shape.
  *
  * @throws {@link AccessDeniedException} (client fault)
- *  <p>You do not have sufficient access to perform this action.
- *   </p>
+ *  <p>You do not have sufficient access to perform this action. </p>
  *
  * @throws {@link InternalServerException} (server fault)
- *  <p>The request processing has failed because of an unknown error, exception or failure.
- *
- *   </p>
+ *  <p>The request processing has failed because of an unknown error, exception or failure. </p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The request was denied due to request throttling.
- *
- *   </p>
+ *  <p>The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
diff --git a/clients/client-inspector-scan/src/models/enums.ts b/clients/client-inspector-scan/src/models/enums.ts
@@ -20,6 +20,7 @@ export type InternalServerExceptionReason =
 export const OutputFormat = {
   CYCLONE_DX_1_5: "CYCLONE_DX_1_5",
   INSPECTOR: "INSPECTOR",
+  INSPECTOR_ALT: "INSPECTOR_ALT",
 } as const;
 /**
  * @public
diff --git a/clients/client-inspector-scan/src/models/errors.ts b/clients/client-inspector-scan/src/models/errors.ts
@@ -6,8 +6,7 @@ import { InspectorScanServiceException as __BaseException } from "./InspectorSca
 import { ValidationExceptionField } from "./models_0";
 
 /**
- * <p>You do not have sufficient access to perform this action.
- *   </p>
+ * <p>You do not have sufficient access to perform this action. </p>
  * @public
  */
 export class AccessDeniedException extends __BaseException {
@@ -27,9 +26,7 @@ export class AccessDeniedException extends __BaseException {
 }
 
 /**
- * <p>The request processing has failed because of an unknown error, exception or failure.
- *
- *   </p>
+ * <p>The request processing has failed because of an unknown error, exception or failure. </p>
  * @public
  */
 export class InternalServerException extends __BaseException {
@@ -64,9 +61,7 @@ export class InternalServerException extends __BaseException {
 }
 
 /**
- * <p>The request was denied due to request throttling.
- *
- *   </p>
+ * <p>The request was denied due to request throttling. </p>
  * @public
  */
 export class ThrottlingException extends __BaseException {
diff --git a/clients/client-inspector-scan/src/models/models_0.ts b/clients/client-inspector-scan/src/models/models_0.ts
@@ -8,7 +8,7 @@ import { OutputFormat } from "./enums";
  */
 export interface ScanSbomRequest {
   /**
-   * <p>The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format.</p>
+   * <p>The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format. This format limits you to passing 2000 components before throwing a <code>ValidException</code> error.</p>
    * @public
    */
   sbom: __DocumentType | undefined;
@@ -32,22 +32,18 @@ export interface ScanSbomResponse {
 }
 
 /**
- * <p>The request has failed validation due to missing required fields or having invalid inputs.
- *    </p>
+ * <p>The request has failed validation due to missing required fields or having invalid inputs. </p>
  * @public
  */
 export interface ValidationExceptionField {
   /**
-   * <p>The name of the validation exception.
-   *
-   *   </p>
+   * <p>The name of the validation exception. </p>
    * @public
    */
   name: string | undefined;
 
   /**
-   * <p>The validation exception message.
-   *   </p>
+   * <p>The validation exception message. </p>
    * @public
    */
   message: string | undefined;
diff --git a/codegen/sdk-codegen/aws-models/inspector-scan.json b/codegen/sdk-codegen/aws-models/inspector-scan.json
@@ -12,7 +12,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>You do not have sufficient access to perform this action.\n  </p>",
+        "smithy.api#documentation": "<p>You do not have sufficient access to perform this action. </p>",
         "smithy.api#error": "client",
         "smithy.api#httpError": 403
       }
@@ -685,7 +685,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>The request processing has failed because of an unknown error, exception or failure.\n   \n  </p>",
+        "smithy.api#documentation": "<p>The request processing has failed because of an unknown error, exception or failure. </p>",
         "smithy.api#error": "server",
         "smithy.api#httpError": 500,
         "smithy.api#retryable": {}
@@ -722,6 +722,12 @@
           "traits": {
             "smithy.api#enumValue": "INSPECTOR"
           }
+        },
+        "INSPECTOR_ALT": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "INSPECTOR_ALT"
+          }
         }
       }
     },
@@ -751,7 +757,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the <a href=\"\">Amazon Inspector SBOM generator</a>.</p>",
+        "smithy.api#documentation": "<p>Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the <a href=\"https://docs.aws.amazon.com/inspector/latest/user/sbom-generator.html\">Amazon Inspector SBOM generator</a>.</p> <note> <p> The output of this action reports NVD and CVSS scores when NVD and CVSS scores are available. Because the output reports both scores, you might notice a discrepency between them. However, you can triage the severity of either score depending on the vendor of your choosing. </p> </note>",
         "smithy.api#examples": [
           {
             "title": "Sample ScanSbom Call",
@@ -931,7 +937,7 @@
         "sbom": {
           "target": "com.amazonaws.inspectorscan#Sbom",
           "traits": {
-            "smithy.api#documentation": "<p>The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format.</p>",
+            "smithy.api#documentation": "<p>The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format. This format limits you to passing 2000 components before throwing a <code>ValidException</code> error.</p>",
             "smithy.api#required": {}
           }
         },
@@ -978,7 +984,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>The request was denied due to request throttling.\n   \n  </p>",
+        "smithy.api#documentation": "<p>The request was denied due to request throttling. </p>",
         "smithy.api#error": "client",
         "smithy.api#httpError": 429,
         "smithy.api#retryable": {
@@ -1021,20 +1027,20 @@
         "name": {
           "target": "smithy.api#String",
           "traits": {
-            "smithy.api#documentation": "<p>The name of the validation exception.\n   \n  </p>",
+            "smithy.api#documentation": "<p>The name of the validation exception. </p>",
             "smithy.api#required": {}
           }
         },
         "message": {
           "target": "smithy.api#String",
           "traits": {
-            "smithy.api#documentation": "<p>The validation exception message.\n  </p>",
+            "smithy.api#documentation": "<p>The validation exception message. </p>",
             "smithy.api#required": {}
           }
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>The request has failed validation due to missing required fields or having invalid inputs.\n   </p>"
+        "smithy.api#documentation": "<p>The request has failed validation due to missing required fields or having invalid inputs. </p>"
       }
     },
     "com.amazonaws.inspectorscan#ValidationExceptionFields": {
