feat(client-auditmanager): This release introduces 2 Audit Manager fe…

…atures: CSV exports and new manual evidence options. You can now export your evidence finder results in CSV format. In addition, you can now add manual evidence to a control by entering free-form text or uploading a file from your browser.
aws · Jun 15, 2023 · 2c78764 · 2c78764
1 parent 3d11530
commit 2c78764
Show file tree

Hide file tree

Showing 30 changed files with 903 additions and 180 deletions.
diff --git a/clients/client-auditmanager/README.md b/clients/client-auditmanager/README.md
@@ -453,6 +453,14 @@ GetEvidenceByEvidenceFolder
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-auditmanager/classes/getevidencebyevidencefoldercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-auditmanager/interfaces/getevidencebyevidencefoldercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-auditmanager/interfaces/getevidencebyevidencefoldercommandoutput.html)
 
+</details>
+<details>
+<summary>
+GetEvidenceFileUploadUrl
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-auditmanager/classes/getevidencefileuploadurlcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-auditmanager/interfaces/getevidencefileuploadurlcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-auditmanager/interfaces/getevidencefileuploadurlcommandoutput.html)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-auditmanager/src/AuditManager.ts b/clients/client-auditmanager/src/AuditManager.ts
@@ -130,6 +130,11 @@ import {
   GetEvidenceByEvidenceFolderCommandOutput,
 } from "./commands/GetEvidenceByEvidenceFolderCommand";
 import { GetEvidenceCommand, GetEvidenceCommandInput, GetEvidenceCommandOutput } from "./commands/GetEvidenceCommand";
+import {
+  GetEvidenceFileUploadUrlCommand,
+  GetEvidenceFileUploadUrlCommandInput,
+  GetEvidenceFileUploadUrlCommandOutput,
+} from "./commands/GetEvidenceFileUploadUrlCommand";
 import {
   GetEvidenceFolderCommand,
   GetEvidenceFolderCommandInput,
@@ -317,6 +322,7 @@ const commands = {
   GetDelegationsCommand,
   GetEvidenceCommand,
   GetEvidenceByEvidenceFolderCommand,
+  GetEvidenceFileUploadUrlCommand,
   GetEvidenceFolderCommand,
   GetEvidenceFoldersByAssessmentCommand,
   GetEvidenceFoldersByAssessmentControlCommand,
@@ -774,6 +780,23 @@ export interface AuditManager {
     cb: (err: any, data?: GetEvidenceByEvidenceFolderCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetEvidenceFileUploadUrlCommand}
+   */
+  getEvidenceFileUploadUrl(
+    args: GetEvidenceFileUploadUrlCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetEvidenceFileUploadUrlCommandOutput>;
+  getEvidenceFileUploadUrl(
+    args: GetEvidenceFileUploadUrlCommandInput,
+    cb: (err: any, data?: GetEvidenceFileUploadUrlCommandOutput) => void
+  ): void;
+  getEvidenceFileUploadUrl(
+    args: GetEvidenceFileUploadUrlCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetEvidenceFileUploadUrlCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetEvidenceFolderCommand}
    */

diff --git a/clients/client-auditmanager/src/AuditManagerClient.ts b/clients/client-auditmanager/src/AuditManagerClient.ts
@@ -126,6 +126,10 @@ import {
   GetEvidenceByEvidenceFolderCommandOutput,
 } from "./commands/GetEvidenceByEvidenceFolderCommand";
 import { GetEvidenceCommandInput, GetEvidenceCommandOutput } from "./commands/GetEvidenceCommand";
+import {
+  GetEvidenceFileUploadUrlCommandInput,
+  GetEvidenceFileUploadUrlCommandOutput,
+} from "./commands/GetEvidenceFileUploadUrlCommand";
 import { GetEvidenceFolderCommandInput, GetEvidenceFolderCommandOutput } from "./commands/GetEvidenceFolderCommand";
 import {
   GetEvidenceFoldersByAssessmentCommandInput,
@@ -264,6 +268,7 @@ export type ServiceInputTypes =
   | GetDelegationsCommandInput
   | GetEvidenceByEvidenceFolderCommandInput
   | GetEvidenceCommandInput
+  | GetEvidenceFileUploadUrlCommandInput
   | GetEvidenceFolderCommandInput
   | GetEvidenceFoldersByAssessmentCommandInput
   | GetEvidenceFoldersByAssessmentControlCommandInput
@@ -330,6 +335,7 @@ export type ServiceOutputTypes =
   | GetDelegationsCommandOutput
   | GetEvidenceByEvidenceFolderCommandOutput
   | GetEvidenceCommandOutput
+  | GetEvidenceFileUploadUrlCommandOutput
   | GetEvidenceFolderCommandOutput
   | GetEvidenceFoldersByAssessmentCommandOutput
   | GetEvidenceFoldersByAssessmentControlCommandOutput

diff --git a/clients/client-auditmanager/src/commands/BatchImportEvidenceToAssessmentControlCommand.ts b/clients/client-auditmanager/src/commands/BatchImportEvidenceToAssessmentControlCommand.ts
@@ -45,16 +45,20 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput
 
 /**
  * @public
- * <p>Uploads one or more pieces of evidence to a control in an Audit Manager assessment.
- *          You can upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by
- *          specifying the S3 URI of the evidence. </p>
- *          <p>You must upload manual evidence to your S3 bucket before you can upload it to your
- *          assessment. For instructions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html">PutObject</a> in
- *          the <i>Amazon Simple Storage Service API Reference.</i>
- *          </p>
+ * <p>Adds one or more pieces of evidence to a control in an Audit Manager assessment. </p>
+ *          <p>You can import manual evidence from any S3 bucket by specifying the S3 URI of the
+ *          object. You can also upload a file from your browser, or enter plain text in response to a
+ *          risk assessment question. </p>
  *          <p>The following restrictions apply to this action:</p>
  *          <ul>
  *             <li>
+ *                <p>
+ *                   <code>manualEvidence</code> can be only one of the following:
+ *                   <code>evidenceFileName</code>, <code>s3ResourcePath</code>, or
+ *                   <code>textResponse</code>
+ *                </p>
+ *             </li>
+ *             <li>
  *                <p>Maximum size of an individual evidence file: 100 MB</p>
  *             </li>
  *             <li>
@@ -80,6 +84,8 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput
  *   manualEvidence: [ // ManualEvidenceList // required
  *     { // ManualEvidence
  *       s3ResourcePath: "STRING_VALUE",
+ *       textResponse: "STRING_VALUE",
+ *       evidenceFileName: "STRING_VALUE",
  *     },
  *   ],
  * };
@@ -90,6 +96,8 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput
  * //     { // BatchImportEvidenceToAssessmentControlError
  * //       manualEvidence: { // ManualEvidence
  * //         s3ResourcePath: "STRING_VALUE",
+ * //         textResponse: "STRING_VALUE",
+ * //         evidenceFileName: "STRING_VALUE",
  * //       },
  * //       errorCode: "STRING_VALUE",
  * //       errorMessage: "STRING_VALUE",
@@ -116,6 +124,9 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p> The resource that's specified in the request can't be found. </p>
  *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p> The request has invalid or missing parameters. </p>
  *

diff --git a/clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts
@@ -96,7 +96,7 @@ export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessment
  * //                 sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
  * //                 sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
  * //                 sourceKeyword: { // SourceKeyword
- * //                   keywordInputType: "SELECT_FROM_LIST",
+ * //                   keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
  * //                   keywordValue: "STRING_VALUE",
  * //                 },
  * //                 sourceFrequency: "DAILY" || "WEEKLY" || "MONTHLY",

diff --git a/clients/client-auditmanager/src/commands/CreateControlCommand.ts b/clients/client-auditmanager/src/commands/CreateControlCommand.ts
@@ -56,7 +56,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met
  *       sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
  *       sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
  *       sourceKeyword: { // SourceKeyword
- *         keywordInputType: "SELECT_FROM_LIST",
+ *         keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
  *         keywordValue: "STRING_VALUE",
  *       },
  *       sourceFrequency: "DAILY" || "WEEKLY" || "MONTHLY",
@@ -88,7 +88,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met
  * //         sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
  * //         sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
  * //         sourceKeyword: { // SourceKeyword
- * //           keywordInputType: "SELECT_FROM_LIST",
+ * //           keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
  * //           keywordValue: "STRING_VALUE",
  * //         },
  * //         sourceFrequency: "DAILY" || "WEEKLY" || "MONTHLY",

diff --git a/clients/client-auditmanager/src/commands/DeleteControlCommand.ts b/clients/client-auditmanager/src/commands/DeleteControlCommand.ts
@@ -37,6 +37,12 @@ export interface DeleteControlCommandOutput extends DeleteControlResponse, __Met
 /**
  * @public
  * <p> Deletes a custom control in Audit Manager. </p>
+ *          <important>
+ *             <p>When you invoke this operation, the custom control is deleted from any frameworks or
+ *             assessments that it’s currently part of. As a result, Audit Manager will stop
+ *             collecting evidence for that custom control in all of your assessments. This includes
+ *             assessments that you previously created before you deleted the custom control.</p>
+ *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetAccountStatusCommand.ts b/clients/client-auditmanager/src/commands/GetAccountStatusCommand.ts
@@ -36,7 +36,7 @@ export interface GetAccountStatusCommandOutput extends GetAccountStatusResponse,
 
 /**
  * @public
- * <p> Returns the registration status of an account in Audit Manager. </p>
+ * <p> Gets the registration status of an account in Audit Manager. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetAssessmentCommand.ts b/clients/client-auditmanager/src/commands/GetAssessmentCommand.ts
@@ -36,7 +36,7 @@ export interface GetAssessmentCommandOutput extends GetAssessmentResponse, __Met
 
 /**
  * @public
- * <p>Returns an assessment from Audit Manager. </p>
+ * <p>Gets information about a specified assessment. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts b/clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts
@@ -36,7 +36,7 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew
 
 /**
  * @public
- * <p>Returns a framework from Audit Manager. </p>
+ * <p>Gets information about a specified framework.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -81,7 +81,7 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew
  * //                 sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
  * //                 sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
  * //                 sourceKeyword: { // SourceKeyword
- * //                   keywordInputType: "SELECT_FROM_LIST",
+ * //                   keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
  * //                   keywordValue: "STRING_VALUE",
  * //                 },
  * //                 sourceFrequency: "DAILY" || "WEEKLY" || "MONTHLY",

diff --git a/clients/client-auditmanager/src/commands/GetAssessmentReportUrlCommand.ts b/clients/client-auditmanager/src/commands/GetAssessmentReportUrlCommand.ts
@@ -36,7 +36,7 @@ export interface GetAssessmentReportUrlCommandOutput extends GetAssessmentReport
 
 /**
  * @public
- * <p> Returns the URL of an assessment report in Audit Manager. </p>
+ * <p> Gets the URL of an assessment report in Audit Manager. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetChangeLogsCommand.ts b/clients/client-auditmanager/src/commands/GetChangeLogsCommand.ts
@@ -36,7 +36,7 @@ export interface GetChangeLogsCommandOutput extends GetChangeLogsResponse, __Met
 
 /**
  * @public
- * <p> Returns a list of changelogs from Audit Manager. </p>
+ * <p> Gets a list of changelogs from Audit Manager. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetControlCommand.ts b/clients/client-auditmanager/src/commands/GetControlCommand.ts
@@ -36,7 +36,7 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
 
 /**
  * @public
- * <p> Returns a control from Audit Manager. </p>
+ * <p> Gets information about a specified control.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,7 +67,7 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
  * //         sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
  * //         sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
  * //         sourceKeyword: { // SourceKeyword
- * //           keywordInputType: "SELECT_FROM_LIST",
+ * //           keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
  * //           keywordValue: "STRING_VALUE",
  * //         },
  * //         sourceFrequency: "DAILY" || "WEEKLY" || "MONTHLY",

diff --git a/clients/client-auditmanager/src/commands/GetDelegationsCommand.ts b/clients/client-auditmanager/src/commands/GetDelegationsCommand.ts
@@ -36,7 +36,7 @@ export interface GetDelegationsCommandOutput extends GetDelegationsResponse, __M
 
 /**
  * @public
- * <p> Returns a list of delegations from an audit owner to a delegate. </p>
+ * <p> Gets a list of delegations from an audit owner to a delegate. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetEvidenceByEvidenceFolderCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceByEvidenceFolderCommand.ts
@@ -41,7 +41,7 @@ export interface GetEvidenceByEvidenceFolderCommandOutput
 
 /**
  * @public
- * <p> Returns all evidence from a specified evidence folder in Audit Manager. </p>
+ * <p> Gets all evidence from a specified evidence folder in Audit Manager. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-auditmanager/src/commands/GetEvidenceCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceCommand.ts
@@ -36,7 +36,7 @@ export interface GetEvidenceCommandOutput extends GetEvidenceResponse, __Metadat
 
 /**
  * @public
- * <p> Returns evidence from Audit Manager. </p>
+ * <p> Gets information about a specified evidence item.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript