feat(client-connectcases): Introduces CustomEntity as part of the UserUnion data type. This field is used to indicate the entity who is performing the API action.

awstools · awstools · commit 9ee87df4a621 · 2025-04-29T18:10:02.000Z
diff --git a/clients/client-connectcases/src/commands/CreateCaseCommand.ts b/clients/client-connectcases/src/commands/CreateCaseCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { CreateCaseRequest, CreateCaseResponse } from "../models/models_0";
+import { CreateCaseRequest, CreateCaseRequestFilterSensitiveLog, CreateCaseResponse } from "../models/models_0";
 import { de_CreateCaseCommand, se_CreateCaseCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -72,6 +72,7 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB
  *   clientToken: "STRING_VALUE",
  *   performedBy: { // UserUnion Union: only one key present
  *     userArn: "STRING_VALUE",
+ *     customEntity: "STRING_VALUE",
  *   },
  * };
  * const command = new CreateCaseCommand(input);
@@ -134,7 +135,7 @@ export class CreateCaseCommand extends $Command
   })
   .s("AmazonConnectCases", "CreateCase", {})
   .n("ConnectCasesClient", "CreateCaseCommand")
-  .f(void 0, void 0)
+  .f(CreateCaseRequestFilterSensitiveLog, void 0)
   .ser(se_CreateCaseCommand)
   .de(de_CreateCaseCommand)
   .build() {
diff --git a/clients/client-connectcases/src/commands/CreateRelatedItemCommand.ts b/clients/client-connectcases/src/commands/CreateRelatedItemCommand.ts
@@ -93,6 +93,7 @@ export interface CreateRelatedItemCommandOutput extends CreateRelatedItemRespons
  *   },
  *   performedBy: { // UserUnion Union: only one key present
  *     userArn: "STRING_VALUE",
+ *     customEntity: "STRING_VALUE",
  *   },
  * };
  * const command = new CreateRelatedItemCommand(input);
diff --git a/clients/client-connectcases/src/commands/GetCaseAuditEventsCommand.ts b/clients/client-connectcases/src/commands/GetCaseAuditEventsCommand.ts
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { GetCaseAuditEventsRequest, GetCaseAuditEventsResponse } from "../models/models_0";
+import {
+  GetCaseAuditEventsRequest,
+  GetCaseAuditEventsResponse,
+  GetCaseAuditEventsResponseFilterSensitiveLog,
+} from "../models/models_0";
 import { de_GetCaseAuditEventsCommand, se_GetCaseAuditEventsCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -73,6 +77,7 @@ export interface GetCaseAuditEventsCommandOutput extends GetCaseAuditEventsRespo
  * //       performedBy: { // AuditEventPerformedBy
  * //         user: { // UserUnion Union: only one key present
  * //           userArn: "STRING_VALUE",
+ * //           customEntity: "STRING_VALUE",
  * //         },
  * //         iamPrincipalArn: "STRING_VALUE", // required
  * //       },
@@ -128,7 +133,7 @@ export class GetCaseAuditEventsCommand extends $Command
   })
   .s("AmazonConnectCases", "GetCaseAuditEvents", {})
   .n("ConnectCasesClient", "GetCaseAuditEventsCommand")
-  .f(void 0, void 0)
+  .f(void 0, GetCaseAuditEventsResponseFilterSensitiveLog)
   .ser(se_GetCaseAuditEventsCommand)
   .de(de_GetCaseAuditEventsCommand)
   .build() {
diff --git a/clients/client-connectcases/src/commands/SearchRelatedItemsCommand.ts b/clients/client-connectcases/src/commands/SearchRelatedItemsCommand.ts
@@ -115,6 +115,7 @@ export interface SearchRelatedItemsCommandOutput extends SearchRelatedItemsRespo
  * //       },
  * //       performedBy: { // UserUnion Union: only one key present
  * //         userArn: "STRING_VALUE",
+ * //         customEntity: "STRING_VALUE",
  * //       },
  * //     },
  * //   ],
diff --git a/clients/client-connectcases/src/commands/UpdateCaseCommand.ts b/clients/client-connectcases/src/commands/UpdateCaseCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { UpdateCaseRequest, UpdateCaseResponse } from "../models/models_0";
+import { UpdateCaseRequest, UpdateCaseRequestFilterSensitiveLog, UpdateCaseResponse } from "../models/models_0";
 import { de_UpdateCaseCommand, se_UpdateCaseCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -58,6 +58,7 @@ export interface UpdateCaseCommandOutput extends UpdateCaseResponse, __MetadataB
  *   ],
  *   performedBy: { // UserUnion Union: only one key present
  *     userArn: "STRING_VALUE",
+ *     customEntity: "STRING_VALUE",
  *   },
  * };
  * const command = new UpdateCaseCommand(input);
@@ -112,7 +113,7 @@ export class UpdateCaseCommand extends $Command
   })
   .s("AmazonConnectCases", "UpdateCase", {})
   .n("ConnectCasesClient", "UpdateCaseCommand")
-  .f(void 0, void 0)
+  .f(UpdateCaseRequestFilterSensitiveLog, void 0)
   .ser(se_UpdateCaseCommand)
   .de(de_UpdateCaseCommand)
   .build() {
diff --git a/clients/client-connectcases/src/models/models_0.ts b/clients/client-connectcases/src/models/models_0.ts
@@ -190,10 +190,10 @@ export interface FieldValue {
 }
 
 /**
- * <p>Represents the identity of the person who performed the action.</p>
+ * <p>Represents the entity that performed the action.</p>
  * @public
  */
-export type UserUnion = UserUnion.UserArnMember | UserUnion.$UnknownMember;
+export type UserUnion = UserUnion.CustomEntityMember | UserUnion.UserArnMember | UserUnion.$UnknownMember;
 
 /**
  * @public
@@ -205,6 +205,17 @@ export namespace UserUnion {
    */
   export interface UserArnMember {
     userArn: string;
+    customEntity?: never;
+    $unknown?: never;
+  }
+
+  /**
+   * <p>Any provided entity.</p>
+   * @public
+   */
+  export interface CustomEntityMember {
+    userArn?: never;
+    customEntity: string;
     $unknown?: never;
   }
 
@@ -213,16 +224,19 @@ export namespace UserUnion {
    */
   export interface $UnknownMember {
     userArn?: never;
+    customEntity?: never;
     $unknown: [string, any];
   }
 
   export interface Visitor<T> {
     userArn: (value: string) => T;
+    customEntity: (value: string) => T;
     _: (name: string, value: any) => T;
   }
 
   export const visit = <T>(value: UserUnion, visitor: Visitor<T>): T => {
     if (value.userArn !== undefined) return visitor.userArn(value.userArn);
+    if (value.customEntity !== undefined) return visitor.customEntity(value.customEntity);
     return visitor._(value.$unknown[0], value.$unknown[1]);
   };
 }
@@ -260,7 +274,7 @@ export interface CreateCaseRequest {
   clientToken?: string | undefined;
 
   /**
-   * <p>Represents the identity of the person who performed the action.</p>
+   * <p>Represents the entity that performed the action.</p>
    * @public
    */
   performedBy?: UserUnion | undefined;
@@ -636,7 +650,7 @@ export interface AuditEventField {
  */
 export interface AuditEventPerformedBy {
   /**
-   * <p>Represents the identity of the person who performed the action.</p>
+   * <p>Represents the entity that performed the action.</p>
    * @public
    */
   user?: UserUnion | undefined;
@@ -1782,7 +1796,7 @@ export interface UpdateCaseRequest {
   fields: FieldValue[] | undefined;
 
   /**
-   * <p>Represents the identity of the person who performed the action.</p>
+   * <p>Represents the entity that performed the action.</p>
    * @public
    */
   performedBy?: UserUnion | undefined;
@@ -4134,6 +4148,49 @@ export interface SearchCasesRequest {
   fields?: FieldIdentifier[] | undefined;
 }
 
+/**
+ * @internal
+ */
+export const UserUnionFilterSensitiveLog = (obj: UserUnion): any => {
+  if (obj.userArn !== undefined) return { userArn: obj.userArn };
+  if (obj.customEntity !== undefined) return { customEntity: SENSITIVE_STRING };
+  if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" };
+};
+
+/**
+ * @internal
+ */
+export const CreateCaseRequestFilterSensitiveLog = (obj: CreateCaseRequest): any => ({
+  ...obj,
+  ...(obj.fields && { fields: obj.fields.map((item) => item) }),
+  ...(obj.performedBy && { performedBy: UserUnionFilterSensitiveLog(obj.performedBy) }),
+});
+
+/**
+ * @internal
+ */
+export const AuditEventPerformedByFilterSensitiveLog = (obj: AuditEventPerformedBy): any => ({
+  ...obj,
+  ...(obj.user && { user: UserUnionFilterSensitiveLog(obj.user) }),
+});
+
+/**
+ * @internal
+ */
+export const AuditEventFilterSensitiveLog = (obj: AuditEvent): any => ({
+  ...obj,
+  ...(obj.fields && { fields: obj.fields.map((item) => item) }),
+  ...(obj.performedBy && { performedBy: AuditEventPerformedByFilterSensitiveLog(obj.performedBy) }),
+});
+
+/**
+ * @internal
+ */
+export const GetCaseAuditEventsResponseFilterSensitiveLog = (obj: GetCaseAuditEventsResponse): any => ({
+  ...obj,
+  ...(obj.auditEvents && { auditEvents: obj.auditEvents.map((item) => AuditEventFilterSensitiveLog(item)) }),
+});
+
 /**
  * @internal
  */
@@ -4169,7 +4226,7 @@ export const RelatedItemInputContentFilterSensitiveLog = (obj: RelatedItemInputC
 export const CreateRelatedItemRequestFilterSensitiveLog = (obj: CreateRelatedItemRequest): any => ({
   ...obj,
   ...(obj.content && { content: RelatedItemInputContentFilterSensitiveLog(obj.content) }),
-  ...(obj.performedBy && { performedBy: obj.performedBy }),
+  ...(obj.performedBy && { performedBy: UserUnionFilterSensitiveLog(obj.performedBy) }),
 });
 
 /**
@@ -4233,7 +4290,7 @@ export const RelatedItemContentFilterSensitiveLog = (obj: RelatedItemContent): a
 export const SearchRelatedItemsResponseItemFilterSensitiveLog = (obj: SearchRelatedItemsResponseItem): any => ({
   ...obj,
   ...(obj.content && { content: RelatedItemContentFilterSensitiveLog(obj.content) }),
-  ...(obj.performedBy && { performedBy: obj.performedBy }),
+  ...(obj.performedBy && { performedBy: UserUnionFilterSensitiveLog(obj.performedBy) }),
 });
 
 /**
@@ -4245,3 +4302,12 @@ export const SearchRelatedItemsResponseFilterSensitiveLog = (obj: SearchRelatedI
     relatedItems: obj.relatedItems.map((item) => SearchRelatedItemsResponseItemFilterSensitiveLog(item)),
   }),
 });
+
+/**
+ * @internal
+ */
+export const UpdateCaseRequestFilterSensitiveLog = (obj: UpdateCaseRequest): any => ({
+  ...obj,
+  ...(obj.fields && { fields: obj.fields.map((item) => item) }),
+  ...(obj.performedBy && { performedBy: UserUnionFilterSensitiveLog(obj.performedBy) }),
+});
diff --git a/codegen/sdk-codegen/aws-models/connectcases.json b/codegen/sdk-codegen/aws-models/connectcases.json
@@ -2472,6 +2472,17 @@
         "smithy.api#timestampFormat": "date-time"
       }
     },
+    "com.amazonaws.connectcases#CustomEntity": {
+      "type": "string",
+      "traits": {
+        "smithy.api#length": {
+          "min": 1,
+          "max": 500
+        },
+        "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\.@:/ ]*[a-zA-Z0-9_\\-\\.@:/]$",
+        "smithy.api#sensitive": {}
+      }
+    },
     "com.amazonaws.connectcases#DeleteCaseRule": {
       "type": "operation",
       "input": {
@@ -5580,7 +5591,7 @@
             "smithy.api#documentation": "<p>The maximum number of cases to return. The current maximum supported value is 25. This is\n      also the default value when no other value is provided.</p>",
             "smithy.api#range": {
               "min": 1,
-              "max": 25
+              "max": 100
             }
           }
         },
@@ -5642,7 +5653,7 @@
           "traits": {
             "smithy.api#documentation": "<p>A list of case documents where each case contains the properties <code>CaseId</code> and\n        <code>Fields</code> where each field is a complex union structure. </p>",
             "smithy.api#length": {
-              "max": 25
+              "max": 100
             },
             "smithy.api#required": {}
           }
@@ -6907,10 +6918,16 @@
           "traits": {
             "smithy.api#documentation": "<p>Represents the Amazon Connect ARN of the user.</p>"
           }
+        },
+        "customEntity": {
+          "target": "com.amazonaws.connectcases#CustomEntity",
+          "traits": {
+            "smithy.api#documentation": "<p>Any provided entity.</p>"
+          }
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>Represents the identity of the person who performed the action.</p>"
+        "smithy.api#documentation": "<p>Represents the entity that performed the action.</p>"
       }
     },
     "com.amazonaws.connectcases#ValidationException": {
