feat(client-connect): This release adds 5 new APIs for managing attac…

…hments: StartAttachedFileUpload, CompleteAttachedFileUpload, GetAttachedFile, BatchGetAttachedFileMetadata, DeleteAttachedFile. These APIs can be used to programmatically upload and download attachments to Connect resources, like cases.
aws · May 3, 2024 · 1cbc8f9 · 1cbc8f9
1 parent bfa8626
commit 1cbc8f9
Show file tree

Hide file tree

Showing 23 changed files with 3,329 additions and 753 deletions.
diff --git a/clients/client-connect/README.md b/clients/client-connect/README.md
@@ -348,6 +348,14 @@ BatchDisassociateAnalyticsDataSet
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/BatchDisassociateAnalyticsDataSetCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/BatchDisassociateAnalyticsDataSetCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/BatchDisassociateAnalyticsDataSetCommandOutput/)
 
+</details>
+<details>
+<summary>
+BatchGetAttachedFileMetadata
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/BatchGetAttachedFileMetadataCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/BatchGetAttachedFileMetadataCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/BatchGetAttachedFileMetadataCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -372,6 +380,14 @@ ClaimPhoneNumber
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/ClaimPhoneNumberCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ClaimPhoneNumberCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/ClaimPhoneNumberCommandOutput/)
 
+</details>
+<details>
+<summary>
+CompleteAttachedFileUpload
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/CompleteAttachedFileUploadCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/CompleteAttachedFileUploadCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/CompleteAttachedFileUploadCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -572,6 +588,14 @@ DeactivateEvaluationForm
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DeactivateEvaluationFormCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeactivateEvaluationFormCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeactivateEvaluationFormCommandOutput/)
 
+</details>
+<details>
+<summary>
+DeleteAttachedFile
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DeleteAttachedFileCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeleteAttachedFileCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeleteAttachedFileCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -1052,6 +1076,14 @@ DismissUserContact
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DismissUserContactCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DismissUserContactCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DismissUserContactCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetAttachedFile
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/GetAttachedFileCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/GetAttachedFileCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/GetAttachedFileCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -1652,6 +1684,14 @@ SendChatIntegrationEvent
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SendChatIntegrationEventCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SendChatIntegrationEventCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SendChatIntegrationEventCommandOutput/)
 
+</details>
+<details>
+<summary>
+StartAttachedFileUpload
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/StartAttachedFileUploadCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/StartAttachedFileUploadCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/StartAttachedFileUploadCommandOutput/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-connect/src/Connect.ts b/clients/client-connect/src/Connect.ts
@@ -87,6 +87,11 @@ import {
   BatchDisassociateAnalyticsDataSetCommandInput,
   BatchDisassociateAnalyticsDataSetCommandOutput,
 } from "./commands/BatchDisassociateAnalyticsDataSetCommand";
+import {
+  BatchGetAttachedFileMetadataCommand,
+  BatchGetAttachedFileMetadataCommandInput,
+  BatchGetAttachedFileMetadataCommandOutput,
+} from "./commands/BatchGetAttachedFileMetadataCommand";
 import {
   BatchGetFlowAssociationCommand,
   BatchGetFlowAssociationCommandInput,
@@ -102,6 +107,11 @@ import {
   ClaimPhoneNumberCommandInput,
   ClaimPhoneNumberCommandOutput,
 } from "./commands/ClaimPhoneNumberCommand";
+import {
+  CompleteAttachedFileUploadCommand,
+  CompleteAttachedFileUploadCommandInput,
+  CompleteAttachedFileUploadCommandOutput,
+} from "./commands/CompleteAttachedFileUploadCommand";
 import {
   CreateAgentStatusCommand,
   CreateAgentStatusCommandInput,
@@ -211,6 +221,11 @@ import {
   DeactivateEvaluationFormCommandInput,
   DeactivateEvaluationFormCommandOutput,
 } from "./commands/DeactivateEvaluationFormCommand";
+import {
+  DeleteAttachedFileCommand,
+  DeleteAttachedFileCommandInput,
+  DeleteAttachedFileCommandOutput,
+} from "./commands/DeleteAttachedFileCommand";
 import {
   DeleteContactEvaluationCommand,
   DeleteContactEvaluationCommandInput,
@@ -495,6 +510,11 @@ import {
   DismissUserContactCommandInput,
   DismissUserContactCommandOutput,
 } from "./commands/DismissUserContactCommand";
+import {
+  GetAttachedFileCommand,
+  GetAttachedFileCommandInput,
+  GetAttachedFileCommandOutput,
+} from "./commands/GetAttachedFileCommand";
 import {
   GetContactAttributesCommand,
   GetContactAttributesCommandInput,
@@ -838,6 +858,11 @@ import {
   SendChatIntegrationEventCommandInput,
   SendChatIntegrationEventCommandOutput,
 } from "./commands/SendChatIntegrationEventCommand";
+import {
+  StartAttachedFileUploadCommand,
+  StartAttachedFileUploadCommandInput,
+  StartAttachedFileUploadCommandOutput,
+} from "./commands/StartAttachedFileUploadCommand";
 import {
   StartChatContactCommand,
   StartChatContactCommandInput,
@@ -1157,9 +1182,11 @@ const commands = {
   AssociateUserProficienciesCommand,
   BatchAssociateAnalyticsDataSetCommand,
   BatchDisassociateAnalyticsDataSetCommand,
+  BatchGetAttachedFileMetadataCommand,
   BatchGetFlowAssociationCommand,
   BatchPutContactCommand,
   ClaimPhoneNumberCommand,
+  CompleteAttachedFileUploadCommand,
   CreateAgentStatusCommand,
   CreateContactFlowCommand,
   CreateContactFlowModuleCommand,
@@ -1185,6 +1212,7 @@ const commands = {
   CreateViewVersionCommand,
   CreateVocabularyCommand,
   DeactivateEvaluationFormCommand,
+  DeleteAttachedFileCommand,
   DeleteContactEvaluationCommand,
   DeleteContactFlowCommand,
   DeleteContactFlowModuleCommand,
@@ -1245,6 +1273,7 @@ const commands = {
   DisassociateTrafficDistributionGroupUserCommand,
   DisassociateUserProficienciesCommand,
   DismissUserContactCommand,
+  GetAttachedFileCommand,
   GetContactAttributesCommand,
   GetCurrentMetricDataCommand,
   GetCurrentUserDataCommand,
@@ -1320,6 +1349,7 @@ const commands = {
   SearchUsersCommand,
   SearchVocabulariesCommand,
   SendChatIntegrationEventCommand,
+  StartAttachedFileUploadCommand,
   StartChatContactCommand,
   StartContactEvaluationCommand,
   StartContactRecordingCommand,
@@ -1660,6 +1690,23 @@ export interface Connect {
     cb: (err: any, data?: BatchDisassociateAnalyticsDataSetCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link BatchGetAttachedFileMetadataCommand}
+   */
+  batchGetAttachedFileMetadata(
+    args: BatchGetAttachedFileMetadataCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<BatchGetAttachedFileMetadataCommandOutput>;
+  batchGetAttachedFileMetadata(
+    args: BatchGetAttachedFileMetadataCommandInput,
+    cb: (err: any, data?: BatchGetAttachedFileMetadataCommandOutput) => void
+  ): void;
+  batchGetAttachedFileMetadata(
+    args: BatchGetAttachedFileMetadataCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: BatchGetAttachedFileMetadataCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link BatchGetFlowAssociationCommand}
    */
@@ -1708,6 +1755,23 @@ export interface Connect {
     cb: (err: any, data?: ClaimPhoneNumberCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CompleteAttachedFileUploadCommand}
+   */
+  completeAttachedFileUpload(
+    args: CompleteAttachedFileUploadCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CompleteAttachedFileUploadCommandOutput>;
+  completeAttachedFileUpload(
+    args: CompleteAttachedFileUploadCommandInput,
+    cb: (err: any, data?: CompleteAttachedFileUploadCommandOutput) => void
+  ): void;
+  completeAttachedFileUpload(
+    args: CompleteAttachedFileUploadCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CompleteAttachedFileUploadCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CreateAgentStatusCommand}
    */
@@ -2094,6 +2158,23 @@ export interface Connect {
     cb: (err: any, data?: DeactivateEvaluationFormCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteAttachedFileCommand}
+   */
+  deleteAttachedFile(
+    args: DeleteAttachedFileCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteAttachedFileCommandOutput>;
+  deleteAttachedFile(
+    args: DeleteAttachedFileCommandInput,
+    cb: (err: any, data?: DeleteAttachedFileCommandOutput) => void
+  ): void;
+  deleteAttachedFile(
+    args: DeleteAttachedFileCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteAttachedFileCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteContactEvaluationCommand}
    */
@@ -3042,6 +3123,20 @@ export interface Connect {
     cb: (err: any, data?: DismissUserContactCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetAttachedFileCommand}
+   */
+  getAttachedFile(
+    args: GetAttachedFileCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetAttachedFileCommandOutput>;
+  getAttachedFile(args: GetAttachedFileCommandInput, cb: (err: any, data?: GetAttachedFileCommandOutput) => void): void;
+  getAttachedFile(
+    args: GetAttachedFileCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetAttachedFileCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetContactAttributesCommand}
    */
@@ -4206,6 +4301,23 @@ export interface Connect {
     cb: (err: any, data?: SendChatIntegrationEventCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link StartAttachedFileUploadCommand}
+   */
+  startAttachedFileUpload(
+    args: StartAttachedFileUploadCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<StartAttachedFileUploadCommandOutput>;
+  startAttachedFileUpload(
+    args: StartAttachedFileUploadCommandInput,
+    cb: (err: any, data?: StartAttachedFileUploadCommandOutput) => void
+  ): void;
+  startAttachedFileUpload(
+    args: StartAttachedFileUploadCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: StartAttachedFileUploadCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link StartChatContactCommand}
    */