@aws-sdk/client-connectcases 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -43,6 +43,7 @@ export type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUni
  */
 export declare namespace FieldValueUnion {
     /**
+     * @public
      * <p>String value type.</p>
      */
     interface StringValueMember {
@@ -53,6 +54,7 @@ export declare namespace FieldValueUnion {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Can be either null, or have a Double number value type. Only one value can be
      *       provided.</p>
      */
@@ -64,6 +66,7 @@ export declare namespace FieldValueUnion {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Can be either null, or have a Boolean value type. Only one value can be provided.</p>
      */
     interface BooleanValueMember {
@@ -74,6 +77,7 @@ export declare namespace FieldValueUnion {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>An empty value.</p>
      */
     interface EmptyValueMember {
@@ -83,6 +87,9 @@ export declare namespace FieldValueUnion {
         emptyValue: EmptyFieldValue;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         stringValue?: never;
         doubleValue?: never;
@@ -105,10 +112,12 @@ export declare namespace FieldValueUnion {
  */
 export interface FieldValue {
     /**
+     * @public
      * <p>Unique identifier of a field.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>Union of potential field value types.</p>
      */
     value: FieldValueUnion | undefined;
@@ -118,19 +127,23 @@ export interface FieldValue {
  */
 export interface CreateCaseRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>An array of objects with field ID (matching ListFields/DescribeField) and value union
      *       data.</p>
      */
     fields: FieldValue[] | undefined;
     /**
+     * @public
      * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
      *             request. If not provided, the Amazon Web Services
      *             SDK populates this field. For more information about idempotency, see
@@ -143,10 +156,12 @@ export interface CreateCaseRequest {
  */
 export interface CreateCaseResponse {
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the case.</p>
      */
     caseArn: string | undefined;
@@ -161,6 +176,7 @@ export declare class InternalServerException extends __BaseException {
     readonly $fault: "server";
     $retryable: {};
     /**
+     * @public
      * <p>Advice to clients on when the call can be safely retried.</p>
      */
     retryAfterSeconds?: number;
@@ -178,10 +194,12 @@ export declare class ResourceNotFoundException extends __BaseException {
     readonly name: "ResourceNotFoundException";
     readonly $fault: "client";
     /**
+     * @public
      * <p>Unique identifier of the resource affected.</p>
      */
     resourceId: string | undefined;
     /**
+     * @public
      * <p>Type of the resource affected.</p>
      */
     resourceType: string | undefined;
@@ -221,6 +239,7 @@ export declare class ValidationException extends __BaseException {
  */
 export interface FieldIdentifier {
     /**
+     * @public
      * <p>Unique identifier of a field.</p>
      */
     id: string | undefined;
@@ -230,18 +249,22 @@ export interface FieldIdentifier {
  */
 export interface GetCaseRequest {
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A list of unique field identifiers. </p>
      */
     fields: FieldIdentifier[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
@@ -252,18 +275,22 @@ export interface GetCaseRequest {
  */
 export interface GetCaseResponse {
     /**
+     * @public
      * <p>A list of detailed field information. </p>
      */
     fields: FieldValue[] | undefined;
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -273,18 +300,22 @@ export interface GetCaseResponse {
  */
 export interface ListCasesForContactRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of a contact in Amazon Connect.</p>
      */
     contactArn: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
@@ -296,10 +327,12 @@ export interface ListCasesForContactRequest {
  */
 export interface CaseSummary {
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
@@ -309,10 +342,12 @@ export interface CaseSummary {
  */
 export interface ListCasesForContactResponse {
     /**
+     * @public
      * <p>A list of Case summary information.</p>
      */
     cases: CaseSummary[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
@@ -334,10 +369,12 @@ export type CommentBodyTextType = (typeof CommentBodyTextType)[keyof typeof Comm
  */
 export interface CommentContent {
     /**
+     * @public
      * <p>Text in the body of a <code>Comment</code> on a case.</p>
      */
     body: string | undefined;
     /**
+     * @public
      * <p>Type of the text in the box of a <code>Comment</code> on a case.</p>
      */
     contentType: CommentBodyTextType | string | undefined;
@@ -348,6 +385,7 @@ export interface CommentContent {
  */
 export interface Contact {
     /**
+     * @public
      * <p>A unique identifier of a contact in Amazon Connect.</p>
      */
     contactArn: string | undefined;
@@ -362,6 +400,7 @@ export type RelatedItemInputContent = RelatedItemInputContent.CommentMember | Re
  */
 export declare namespace RelatedItemInputContent {
     /**
+     * @public
      * <p>Object representing a contact in Amazon Connect as an API request field.</p>
      */
     interface ContactMember {
@@ -370,6 +409,7 @@ export declare namespace RelatedItemInputContent {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Represents the content of a comment to be returned to agents.</p>
      */
     interface CommentMember {
@@ -377,6 +417,9 @@ export declare namespace RelatedItemInputContent {
         comment: CommentContent;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         contact?: never;
         comment?: never;
@@ -406,18 +449,22 @@ export type RelatedItemType = (typeof RelatedItemType)[keyof typeof RelatedItemT
  */
 export interface CreateRelatedItemRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>The type of a related item.</p>
      */
     type: RelatedItemType | string | undefined;
     /**
+     * @public
      * <p>The content of a related item to be created.</p>
      */
     content: RelatedItemInputContent | undefined;
@@ -427,10 +474,12 @@ export interface CreateRelatedItemRequest {
  */
 export interface CreateRelatedItemResponse {
     /**
+     * @public
      * <p>The unique identifier of the related item.</p>
      */
     relatedItemId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the related item.</p>
      */
     relatedItemArn: string | undefined;
@@ -460,10 +509,12 @@ export interface CommentFilter {
  */
 export interface ContactFilter {
     /**
+     * @public
      * <p>A list of channels to filter on for related items of type <code>Contact</code>.</p>
      */
     channel?: string[];
     /**
+     * @public
      * <p>A unique identifier of a contact in Amazon Connect.</p>
      */
     contactArn?: string;
@@ -478,6 +529,7 @@ export type RelatedItemTypeFilter = RelatedItemTypeFilter.CommentMember | Relate
  */
 export declare namespace RelatedItemTypeFilter {
     /**
+     * @public
      * <p>A filter for related items of type <code>Contact</code>.</p>
      */
     interface ContactMember {
@@ -486,6 +538,7 @@ export declare namespace RelatedItemTypeFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A filter for related items of type <code>Comment</code>.</p>
      */
     interface CommentMember {
@@ -493,6 +546,9 @@ export declare namespace RelatedItemTypeFilter {
         comment: CommentFilter;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         contact?: never;
         comment?: never;
@@ -510,23 +566,28 @@ export declare namespace RelatedItemTypeFilter {
  */
 export interface SearchRelatedItemsRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>The list of types of related items and their parameters to use for filtering.</p>
      */
     filters?: RelatedItemTypeFilter[];
@@ -537,14 +598,17 @@ export interface SearchRelatedItemsRequest {
  */
 export interface ContactContent {
     /**
+     * @public
      * <p>A unique identifier of a contact in Amazon Connect.</p>
      */
     contactArn: string | undefined;
     /**
+     * @public
      * <p>A list of channels to filter on for related items of type <code>Contact</code>.</p>
      */
     channel: string | undefined;
     /**
+     * @public
      * <p>The difference between the <code>InitiationTimestamp</code> and the
      *         <code>DisconnectTimestamp</code> of the contact.</p>
      */
@@ -560,6 +624,7 @@ export type RelatedItemContent = RelatedItemContent.CommentMember | RelatedItemC
  */
 export declare namespace RelatedItemContent {
     /**
+     * @public
      * <p>Represents the content of a contact to be returned to agents.</p>
      */
     interface ContactMember {
@@ -568,6 +633,7 @@ export declare namespace RelatedItemContent {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Represents the content of a comment to be returned to agents.</p>
      */
     interface CommentMember {
@@ -575,6 +641,9 @@ export declare namespace RelatedItemContent {
         comment: CommentContent;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         contact?: never;
         comment?: never;
@@ -593,22 +662,27 @@ export declare namespace RelatedItemContent {
  */
 export interface SearchRelatedItemsResponseItem {
     /**
+     * @public
      * <p>Unique identifier of a related item.</p>
      */
     relatedItemId: string | undefined;
     /**
+     * @public
      * <p>Type of a related item.</p>
      */
     type: RelatedItemType | string | undefined;
     /**
+     * @public
      * <p>Time at which a related item was associated with a case.</p>
      */
     associationTime: Date | undefined;
     /**
+     * @public
      * <p>Represents the content of a particular type of related item.</p>
      */
     content: RelatedItemContent | undefined;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -618,10 +692,12 @@ export interface SearchRelatedItemsResponseItem {
  */
 export interface SearchRelatedItemsResponse {
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>A list of items related to a case. </p>
      */
     relatedItems: SearchRelatedItemsResponseItem[] | undefined;
@@ -636,6 +712,7 @@ export type FieldFilter = FieldFilter.ContainsMember | FieldFilter.EqualToMember
  */
 export declare namespace FieldFilter {
     /**
+     * @public
      * <p>Object containing field identifier and value information.</p>
      */
     interface EqualToMember {
@@ -648,6 +725,7 @@ export declare namespace FieldFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Object containing field identifier and value information.</p>
      */
     interface ContainsMember {
@@ -660,6 +738,7 @@ export declare namespace FieldFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Object containing field identifier and value information.</p>
      */
     interface GreaterThanMember {
@@ -672,6 +751,7 @@ export declare namespace FieldFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Object containing field identifier and value information.</p>
      */
     interface GreaterThanOrEqualToMember {
@@ -684,6 +764,7 @@ export declare namespace FieldFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Object containing field identifier and value information.</p>
      */
     interface LessThanMember {
@@ -696,6 +777,7 @@ export declare namespace FieldFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Object containing field identifier and value information. </p>
      */
     interface LessThanOrEqualToMember {
@@ -707,6 +789,9 @@ export declare namespace FieldFilter {
         lessThanOrEqualTo: FieldValue;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         equalTo?: never;
         contains?: never;
@@ -745,10 +830,12 @@ export type Order = (typeof Order)[keyof typeof Order];
  */
 export interface Sort {
     /**
+     * @public
      * <p>Unique identifier of a field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>A structured set of sort terms</p>
      */
     sortOrder: Order | string | undefined;
@@ -759,18 +846,22 @@ export interface Sort {
  */
 export interface SearchCasesResponseItem {
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>List of case field values.</p>
      */
     fields: FieldValue[] | undefined;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -780,10 +871,12 @@ export interface SearchCasesResponseItem {
  */
 export interface SearchCasesResponse {
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>A list of case documents where each case contains the properties <code>CaseId</code> and
      *         <code>Fields</code> where each field is a complex union structure. </p>
      */
@@ -794,14 +887,17 @@ export interface SearchCasesResponse {
  */
 export interface UpdateCaseRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of the case.</p>
      */
     caseId: string | undefined;
     /**
+     * @public
      * <p>An array of objects with <code>fieldId</code> (matching ListFields/DescribeField) and
      *       value union data, structured identical to <code>CreateCase</code>.</p>
      */
@@ -817,6 +913,7 @@ export interface UpdateCaseResponse {
  */
 export interface CreateDomainRequest {
     /**
+     * @public
      * <p>The name for your Cases domain. It must be unique for your Amazon Web Services
      *       account.</p>
      */
@@ -840,14 +937,17 @@ export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
  */
 export interface CreateDomainResponse {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) for the Cases domain.</p>
      */
     domainArn: string | undefined;
     /**
+     * @public
      * <p>The status of the domain.</p>
      */
     domainStatus: DomainStatus | string | undefined;
@@ -857,6 +957,7 @@ export interface CreateDomainResponse {
  */
 export interface DeleteDomainRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
@@ -871,6 +972,7 @@ export interface DeleteDomainResponse {
  */
 export interface GetCaseEventConfigurationRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
@@ -881,6 +983,7 @@ export interface GetCaseEventConfigurationRequest {
  */
 export interface CaseEventIncludedData {
     /**
+     * @public
      * <p>List of field identifiers.</p>
      */
     fields: FieldIdentifier[] | undefined;
@@ -891,6 +994,7 @@ export interface CaseEventIncludedData {
  */
 export interface RelatedItemEventIncludedData {
     /**
+     * @public
      * <p>Details of what related item data is published through the case event stream.</p>
      */
     includeContent: boolean | undefined;
@@ -902,10 +1006,12 @@ export interface RelatedItemEventIncludedData {
  */
 export interface EventIncludedData {
     /**
+     * @public
      * <p>Details of what case data is published through the case event stream.</p>
      */
     caseData?: CaseEventIncludedData;
     /**
+     * @public
      * <p>Details of what related item data is published through the case event stream.</p>
      */
     relatedItemData?: RelatedItemEventIncludedData;
@@ -917,10 +1023,12 @@ export interface EventIncludedData {
  */
 export interface EventBridgeConfiguration {
     /**
+     * @public
      * <p>Indicates whether the to broadcast case event data to the customer.</p>
      */
     enabled: boolean | undefined;
     /**
+     * @public
      * <p>Details of what case and related item data is published through the case event
      *       stream.</p>
      */
@@ -931,6 +1039,7 @@ export interface EventBridgeConfiguration {
  */
 export interface GetCaseEventConfigurationResponse {
     /**
+     * @public
      * <p>Configuration to enable EventBridge case event delivery and determine what data is
      *       delivered.</p>
      */
@@ -941,6 +1050,7 @@ export interface GetCaseEventConfigurationResponse {
  */
 export interface GetDomainRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
@@ -950,26 +1060,32 @@ export interface GetDomainRequest {
  */
 export interface GetDomainResponse {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) for the Cases domain.</p>
      */
     domainArn: string | undefined;
     /**
+     * @public
      * <p>The name of the Cases domain.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The timestamp when the Cases domain was created.</p>
      */
     createdTime: Date | undefined;
     /**
+     * @public
      * <p>The status of the Cases domain.</p>
      */
     domainStatus: DomainStatus | string | undefined;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -979,10 +1095,12 @@ export interface GetDomainResponse {
  */
 export interface ListDomainsRequest {
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
@@ -994,14 +1112,17 @@ export interface ListDomainsRequest {
  */
 export interface DomainSummary {
     /**
+     * @public
      * <p>The unique identifier of the domain.</p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the domain.</p>
      */
     domainArn: string | undefined;
     /**
+     * @public
      * <p>The name of the domain.</p>
      */
     name: string | undefined;
@@ -1011,10 +1132,12 @@ export interface DomainSummary {
  */
 export interface ListDomainsResponse {
     /**
+     * @public
      * <p>The Cases domain.</p>
      */
     domains: DomainSummary[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
@@ -1024,10 +1147,12 @@ export interface ListDomainsResponse {
  */
 export interface PutCaseEventConfigurationRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>Configuration to enable EventBridge case event delivery and determine what data is
      *       delivered.</p>
      */
@@ -1043,10 +1168,12 @@ export interface PutCaseEventConfigurationResponse {
  */
 export interface BatchGetFieldRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A list of unique field identifiers. </p>
      */
     fields: FieldIdentifier[] | undefined;
@@ -1057,14 +1184,17 @@ export interface BatchGetFieldRequest {
  */
 export interface FieldError {
     /**
+     * @public
      * <p>The field identifier that caused the error.</p>
      */
     id: string | undefined;
     /**
+     * @public
      * <p>The error code from getting a field.</p>
      */
     errorCode: string | undefined;
     /**
+     * @public
      * <p>The error message from getting a field.</p>
      */
     message?: string;
@@ -1103,30 +1233,37 @@ export type FieldType = (typeof FieldType)[keyof typeof FieldType];
  */
 export interface GetFieldResponse {
     /**
+     * @public
      * <p>Unique identifier of the field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>Name of the field.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the field.</p>
      */
     fieldArn: string | undefined;
     /**
+     * @public
      * <p>Description of the field.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>Type of the field.</p>
      */
     type: FieldType | string | undefined;
     /**
+     * @public
      * <p>Namespace of the field.</p>
      */
     namespace: FieldNamespace | string | undefined;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -1136,10 +1273,12 @@ export interface GetFieldResponse {
  */
 export interface BatchGetFieldResponse {
     /**
+     * @public
      * <p>A list of detailed field information. </p>
      */
     fields: GetFieldResponse[] | undefined;
     /**
+     * @public
      * <p>A list of field errors. </p>
      */
     errors: FieldError[] | undefined;
@@ -1150,17 +1289,20 @@ export interface BatchGetFieldResponse {
  */
 export interface FieldOption {
     /**
+     * @public
      * <p>
      *             <code>FieldOptionName</code> has max length 100 and disallows trailing spaces.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>
      *             <code>FieldOptionValue</code> has max length 100 and must be alphanumeric with hyphens and
      *       underscores.</p>
      */
     value: string | undefined;
     /**
+     * @public
      * <p>Describes whether the <code>FieldOption</code> is active (displayed) or inactive.</p>
      */
     active: boolean | undefined;
@@ -1170,14 +1312,17 @@ export interface FieldOption {
  */
 export interface BatchPutFieldOptionsRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of a field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>A list of <code>FieldOption</code> objects.</p>
      */
     options: FieldOption[] | undefined;
@@ -1188,14 +1333,17 @@ export interface BatchPutFieldOptionsRequest {
  */
 export interface FieldOptionError {
     /**
+     * @public
      * <p>Error message from creating or updating field option.</p>
      */
     message: string | undefined;
     /**
+     * @public
      * <p>Error code from creating or updating field option.</p>
      */
     errorCode: string | undefined;
     /**
+     * @public
      * <p>The field option value that caused the error.</p>
      */
     value: string | undefined;
@@ -1205,6 +1353,7 @@ export interface FieldOptionError {
  */
 export interface BatchPutFieldOptionsResponse {
     /**
+     * @public
      * <p>A list of field errors. </p>
      */
     errors?: FieldOptionError[];
@@ -1214,18 +1363,22 @@ export interface BatchPutFieldOptionsResponse {
  */
 export interface CreateFieldRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The name of the field.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>Defines the data type, some system constraints, and default display of the field.</p>
      */
     type: FieldType | string | undefined;
     /**
+     * @public
      * <p>The description of the field.</p>
      */
     description?: string;
@@ -1235,10 +1388,12 @@ export interface CreateFieldRequest {
  */
 export interface CreateFieldResponse {
     /**
+     * @public
      * <p>The unique identifier of a field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the field.</p>
      */
     fieldArn: string | undefined;
@@ -1248,23 +1403,28 @@ export interface CreateFieldResponse {
  */
 export interface ListFieldOptionsRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of a field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>A list of <code>FieldOption</code> values to filter on for
      *       <code>ListFieldOptions</code>.</p>
      */
@@ -1275,10 +1435,12 @@ export interface ListFieldOptionsRequest {
  */
 export interface ListFieldOptionsResponse {
     /**
+     * @public
      * <p>A list of <code>FieldOption</code> objects.</p>
      */
     options: FieldOption[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
@@ -1288,14 +1450,17 @@ export interface ListFieldOptionsResponse {
  */
 export interface ListFieldsRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
@@ -1307,22 +1472,27 @@ export interface ListFieldsRequest {
  */
 export interface FieldSummary {
     /**
+     * @public
      * <p>The unique identifier of a field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the field.</p>
      */
     fieldArn: string | undefined;
     /**
+     * @public
      * <p>Name of the field.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The type of a field.</p>
      */
     type: FieldType | string | undefined;
     /**
+     * @public
      * <p>The namespace of a field.</p>
      */
     namespace: FieldNamespace | string | undefined;
@@ -1332,10 +1502,12 @@ export interface FieldSummary {
  */
 export interface ListFieldsResponse {
     /**
+     * @public
      * <p>List of detailed field information.</p>
      */
     fields: FieldSummary[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
@@ -1345,18 +1517,22 @@ export interface ListFieldsResponse {
  */
 export interface UpdateFieldRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of a field.</p>
      */
     fieldId: string | undefined;
     /**
+     * @public
      * <p>The name of the field.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The description of a field.</p>
      */
     description?: string;
@@ -1372,6 +1548,7 @@ export interface UpdateFieldResponse {
  */
 export interface FieldItem {
     /**
+     * @public
      * <p>Unique identifier of a field.</p>
      */
     id: string | undefined;
@@ -1382,10 +1559,12 @@ export interface FieldItem {
  */
 export interface FieldGroup {
     /**
+     * @public
      * <p>Name of the field group.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>Represents an ordered list containing field related information.</p>
      */
     fields: FieldItem[] | undefined;
@@ -1400,12 +1579,16 @@ export type Section = Section.FieldGroupMember | Section.$UnknownMember;
  */
 export declare namespace Section {
     /**
+     * @public
      * <p>Consists of a group of fields and associated properties.</p>
      */
     interface FieldGroupMember {
         fieldGroup: FieldGroup;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         fieldGroup?: never;
         $unknown: [string, any];
@@ -1423,6 +1606,7 @@ export declare namespace Section {
  */
 export interface LayoutSections {
     /**
+     * @public
      * <p>Ordered list containing different kinds of sections that can be added.</p>
      */
     sections?: Section[];
@@ -1434,10 +1618,12 @@ export interface LayoutSections {
  */
 export interface BasicLayout {
     /**
+     * @public
      * <p>This represents sections in a panel of the page layout.</p>
      */
     topPanel?: LayoutSections;
     /**
+     * @public
      * <p>This represents sections in a tab of the page layout.</p>
      */
     moreInfo?: LayoutSections;
@@ -1452,6 +1638,7 @@ export type LayoutContent = LayoutContent.BasicMember | LayoutContent.$UnknownMe
  */
 export declare namespace LayoutContent {
     /**
+     * @public
      * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
      *       and More Info tab of Cases user interface.</p>
      */
@@ -1459,6 +1646,9 @@ export declare namespace LayoutContent {
         basic: BasicLayout;
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         basic?: never;
         $unknown: [string, any];
@@ -1474,14 +1664,17 @@ export declare namespace LayoutContent {
  */
 export interface CreateLayoutRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The name of the layout. It must be unique for the Cases domain.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>Information about which fields will be present in the layout, and information about the
      *       order of the fields.</p>
      */
@@ -1492,10 +1685,12 @@ export interface CreateLayoutRequest {
  */
 export interface CreateLayoutResponse {
     /**
+     * @public
      * <p>The unique identifier of the layout.</p>
      */
     layoutId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the newly created layout.</p>
      */
     layoutArn: string | undefined;
@@ -1505,10 +1700,12 @@ export interface CreateLayoutResponse {
  */
 export interface GetLayoutRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of the layout.</p>
      */
     layoutId: string | undefined;
@@ -1518,23 +1715,28 @@ export interface GetLayoutRequest {
  */
 export interface GetLayoutResponse {
     /**
+     * @public
      * <p>The unique identifier of the layout.</p>
      */
     layoutId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the newly created layout.</p>
      */
     layoutArn: string | undefined;
     /**
+     * @public
      * <p>The name of the layout. It must be unique.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>Information about which fields will be present in the layout, the order of the fields, and
      *       read-only attribute of the field. </p>
      */
     content: LayoutContent | undefined;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -1544,14 +1746,17 @@ export interface GetLayoutResponse {
  */
 export interface ListLayoutsRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
@@ -1563,14 +1768,17 @@ export interface ListLayoutsRequest {
  */
 export interface LayoutSummary {
     /**
+     * @public
      * <p>The unique identifier for of the layout.</p>
      */
     layoutId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the layout.</p>
      */
     layoutArn: string | undefined;
     /**
+     * @public
      * <p>The name of the layout.</p>
      */
     name: string | undefined;
@@ -1580,10 +1788,12 @@ export interface LayoutSummary {
  */
 export interface ListLayoutsResponse {
     /**
+     * @public
      * <p>The layouts for the domain.</p>
      */
     layouts: LayoutSummary[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
@@ -1593,18 +1803,22 @@ export interface ListLayoutsResponse {
  */
 export interface UpdateLayoutRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The unique identifier of the layout.</p>
      */
     layoutId: string | undefined;
     /**
+     * @public
      * <p>The name of the layout. It must be unique per domain.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>Information about which fields will be present in the layout, the order of the fields, and
      *       a read-only attribute of the field. </p>
      */
@@ -1620,6 +1834,7 @@ export interface UpdateLayoutResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN)</p>
      */
     arn: string | undefined;
@@ -1629,6 +1844,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
@@ -1638,10 +1854,12 @@ export interface ListTagsForResourceResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN)</p>
      */
     arn: string | undefined;
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags: Record<string, string> | undefined;
@@ -1652,6 +1870,7 @@ export interface TagResourceRequest {
  */
 export interface LayoutConfiguration {
     /**
+     * @public
      * <p> Unique identifier of a layout. </p>
      */
     defaultLayout?: string;
@@ -1662,6 +1881,7 @@ export interface LayoutConfiguration {
  */
 export interface RequiredField {
     /**
+     * @public
      * <p>Unique identifier of a field.</p>
      */
     fieldId: string | undefined;
@@ -1683,27 +1903,33 @@ export type TemplateStatus = (typeof TemplateStatus)[keyof typeof TemplateStatus
  */
 export interface CreateTemplateRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A name for the template. It must be unique per domain.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>A brief description of the template.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>Configuration of layouts associated to the template.</p>
      */
     layoutConfiguration?: LayoutConfiguration;
     /**
+     * @public
      * <p>A list of fields that must contain a value for a case to be successfully created with this
      *       template.</p>
      */
     requiredFields?: RequiredField[];
     /**
+     * @public
      * <p>The status of the template.</p>
      */
     status?: TemplateStatus | string;
@@ -1713,10 +1939,12 @@ export interface CreateTemplateRequest {
  */
 export interface CreateTemplateResponse {
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the newly created template.</p>
      */
     templateArn: string | undefined;
@@ -1726,10 +1954,12 @@ export interface CreateTemplateResponse {
  */
 export interface GetTemplateRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
@@ -1739,35 +1969,43 @@ export interface GetTemplateRequest {
  */
 export interface GetTemplateResponse {
     /**
+     * @public
      * <p>A unique identifier of a template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the template.</p>
      */
     templateArn: string | undefined;
     /**
+     * @public
      * <p>The name of the template.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>A brief description of the template.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>Configuration of layouts associated to the template.</p>
      */
     layoutConfiguration?: LayoutConfiguration;
     /**
+     * @public
      * <p>A list of fields that must contain a value for a case to be successfully created with this
      *       template.</p>
      */
     requiredFields?: RequiredField[];
     /**
+     * @public
      * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
      */
     tags?: Record<string, string>;
     /**
+     * @public
      * <p>The status of the template.</p>
      */
     status: TemplateStatus | string | undefined;
@@ -1777,19 +2015,23 @@ export interface GetTemplateResponse {
  */
 export interface ListTemplatesRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The maximum number of results to return per page.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>A list of status values to filter on.</p>
      */
     status?: (TemplateStatus | string)[];
@@ -1800,18 +2042,22 @@ export interface ListTemplatesRequest {
  */
 export interface TemplateSummary {
     /**
+     * @public
      * <p>The unique identifier for the template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the template.</p>
      */
     templateArn: string | undefined;
     /**
+     * @public
      * <p>The template name.</p>
      */
     name: string | undefined;
     /**
+     * @public
      * <p>The status of the template.</p>
      */
     status: TemplateStatus | string | undefined;
@@ -1821,10 +2067,12 @@ export interface TemplateSummary {
  */
 export interface ListTemplatesResponse {
     /**
+     * @public
      * <p>List of template summary objects.</p>
      */
     templates: TemplateSummary[] | undefined;
     /**
+     * @public
      * <p>The token for the next set of results. This is null if there are no more results to return.</p>
      */
     nextToken?: string;
@@ -1834,31 +2082,38 @@ export interface ListTemplatesResponse {
  */
 export interface UpdateTemplateRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>A unique identifier for the template.</p>
      */
     templateId: string | undefined;
     /**
+     * @public
      * <p>The name of the template. It must be unique per domain.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>A brief description of the template.</p>
      */
     description?: string;
     /**
+     * @public
      * <p>Configuration of layouts associated to the template.</p>
      */
     layoutConfiguration?: LayoutConfiguration;
     /**
+     * @public
      * <p>A list of fields that must contain a value for a case to be successfully created with this
      *       template.</p>
      */
     requiredFields?: RequiredField[];
     /**
+     * @public
      * <p>The status of the template.</p>
      */
     status?: TemplateStatus | string;
@@ -1873,10 +2128,12 @@ export interface UpdateTemplateResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN)</p>
      */
     arn: string | undefined;
     /**
+     * @public
      * <p>List of tag keys.</p>
      */
     tagKeys: string[] | undefined;
@@ -1891,6 +2148,7 @@ export type CaseFilter = CaseFilter.AndAllMember | CaseFilter.FieldMember | Case
  */
 export declare namespace CaseFilter {
     /**
+     * @public
      * <p>A list of fields to filter on.</p>
      */
     interface FieldMember {
@@ -1901,6 +2159,7 @@ export declare namespace CaseFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>A filter for cases. Only one value can be provided.</p>
      */
     interface NotMember {
@@ -1911,6 +2170,7 @@ export declare namespace CaseFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Provides "and all" filtering.</p>
      */
     interface AndAllMember {
@@ -1921,6 +2181,7 @@ export declare namespace CaseFilter {
         $unknown?: never;
     }
     /**
+     * @public
      * <p>Provides "or all" filtering.</p>
      */
     interface OrAllMember {
@@ -1930,6 +2191,9 @@ export declare namespace CaseFilter {
         orAll: CaseFilter[];
         $unknown?: never;
     }
+    /**
+     * @public
+     */
     interface $UnknownMember {
         field?: never;
         not?: never;
@@ -1951,33 +2215,40 @@ export declare namespace CaseFilter {
  */
 export interface SearchCasesRequest {
     /**
+     * @public
      * <p>The unique identifier of the Cases domain. </p>
      */
     domainId: string | undefined;
     /**
+     * @public
      * <p>The maximum number of cases to return. The current maximum supported value is 25. This is
      *       also the default value when no other value is provided.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results. Use the value returned in the previous
      * response in the next request to retrieve the next set of results.</p>
      */
     nextToken?: string;
     /**
+     * @public
      * <p>A word or phrase used to perform a quick search.</p>
      */
     searchTerm?: string;
     /**
+     * @public
      * <p>A list of filter objects.</p>
      */
     filter?: CaseFilter;
     /**
+     * @public
      * <p>A list of sorts where each sort specifies a field and their sort order to be applied to
      *       the results. </p>
      */
     sorts?: Sort[];
     /**
+     * @public
      * <p>The list of field identifiers to be returned as part of the response.</p>
      */
     fields?: FieldIdentifier[];