From b8975e69d1512c1232ad28e7e5126e4fd5cd029a Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 26 Nov 2024 19:15:55 +0000 Subject: [PATCH] feat(client-connect): Enables access to ValueMap and ValueInteger types for SegmentAttributes and fixes deserialization bug for DescribeContactFlow in AmazonConnect Public API --- .../src/commands/CreateContactCommand.ts | 19 +- .../src/commands/CreateEmailAddressCommand.ts | 4 +- .../commands/CreateEvaluationFormCommand.ts | 2 +- .../src/commands/DeleteEmailAddressCommand.ts | 2 +- .../src/commands/DeleteViewVersionCommand.ts | 3 +- .../src/commands/DeleteVocabularyCommand.ts | 3 +- .../src/commands/DescribeContactCommand.ts | 10 + .../commands/DescribeContactFlowCommand.ts | 3 +- .../DescribeContactFlowModuleCommand.ts | 2 +- .../commands/DescribeEmailAddressCommand.ts | 2 +- .../commands/ListAssociatedContactsCommand.ts | 3 +- ...ealtimeContactAnalysisSegmentsV2Command.ts | 2 +- .../src/commands/SearchContactFlowsCommand.ts | 4 +- .../commands/SearchEmailAddressesCommand.ts | 2 +- .../src/commands/SendOutboundEmailCommand.ts | 7 +- .../StartAttachedFileUploadCommand.ts | 4 +- .../src/commands/StartChatContactCommand.ts | 13 +- .../src/commands/StartEmailContactCommand.ts | 20 +- .../StartOutboundChatContactCommand.ts | 13 +- .../StartOutboundEmailContactCommand.ts | 3 +- .../src/commands/StartTaskContactCommand.ts | 17 +- .../src/commands/TagResourceCommand.ts | 4 +- .../src/commands/UpdateContactCommand.ts | 17 +- .../UpdateContactFlowContentCommand.ts | 2 +- .../UpdateContactFlowModuleContentCommand.ts | 2 +- .../UpdateEmailAddressMetadataCommand.ts | 3 +- .../UpdateQueueOutboundEmailConfigCommand.ts | 4 +- clients/client-connect/src/models/models_0.ts | 197 +- clients/client-connect/src/models/models_1.ts | 203 +- clients/client-connect/src/models/models_2.ts | 2448 ++++++++--------- clients/client-connect/src/models/models_3.ts | 867 ++++-- .../src/protocols/Aws_restJson1.ts | 101 +- codegen/sdk-codegen/aws-models/connect.json | 497 ++-- 33 files changed, 2382 insertions(+), 2101 deletions(-) diff --git a/clients/client-connect/src/commands/CreateContactCommand.ts b/clients/client-connect/src/commands/CreateContactCommand.ts index bfae7923e86e..5949da2bf283 100644 --- a/clients/client-connect/src/commands/CreateContactCommand.ts +++ b/clients/client-connect/src/commands/CreateContactCommand.ts @@ -6,11 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - CreateContactRequest, - CreateContactRequestFilterSensitiveLog, - CreateContactResponse, -} from "../models/models_0"; +import { CreateContactResponse } from "../models/models_0"; +import { CreateContactRequest, CreateContactRequestFilterSensitiveLog } from "../models/models_2"; import { de_CreateContactCommand, se_CreateContactCommand } from "../protocols/Aws_restJson1"; /** @@ -32,7 +29,7 @@ export interface CreateContactCommandInput extends CreateContactRequest {} export interface CreateContactCommandOutput extends CreateContactResponse, __MetadataBearer {} /** - *

+ *

Creates a new contact.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,6 +64,16 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met * SegmentAttributes: { // SegmentAttributes * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", + * ValueMap: { // SegmentAttributeValueMap + * "": { + * ValueString: "STRING_VALUE", + * ValueMap: { + * "": "", + * }, + * ValueInteger: Number("int"), + * }, + * }, + * ValueInteger: Number("int"), * }, * }, * }; diff --git a/clients/client-connect/src/commands/CreateEmailAddressCommand.ts b/clients/client-connect/src/commands/CreateEmailAddressCommand.ts index efa8d8e90bee..64219f200db6 100644 --- a/clients/client-connect/src/commands/CreateEmailAddressCommand.ts +++ b/clients/client-connect/src/commands/CreateEmailAddressCommand.ts @@ -32,7 +32,9 @@ export interface CreateEmailAddressCommandInput extends CreateEmailAddressReques export interface CreateEmailAddressCommandOutput extends CreateEmailAddressResponse, __MetadataBearer {} /** - *

+ *

Create new email address in the specified Amazon Connect instance. For more information + * about email addresses, see Create email addresses in the + * Amazon Connect Administrator Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/CreateEvaluationFormCommand.ts b/clients/client-connect/src/commands/CreateEvaluationFormCommand.ts index e39f5535ff98..55151ac2445e 100644 --- a/clients/client-connect/src/commands/CreateEvaluationFormCommand.ts +++ b/clients/client-connect/src/commands/CreateEvaluationFormCommand.ts @@ -7,7 +7,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; import { CreateEvaluationFormResponse } from "../models/models_0"; -import { CreateEvaluationFormRequest } from "../models/models_3"; +import { CreateEvaluationFormRequest } from "../models/models_2"; import { de_CreateEvaluationFormCommand, se_CreateEvaluationFormCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/DeleteEmailAddressCommand.ts b/clients/client-connect/src/commands/DeleteEmailAddressCommand.ts index f74d14e23821..fd4956fa53a3 100644 --- a/clients/client-connect/src/commands/DeleteEmailAddressCommand.ts +++ b/clients/client-connect/src/commands/DeleteEmailAddressCommand.ts @@ -28,7 +28,7 @@ export interface DeleteEmailAddressCommandInput extends DeleteEmailAddressReques export interface DeleteEmailAddressCommandOutput extends DeleteEmailAddressResponse, __MetadataBearer {} /** - *

+ *

Deletes email address from the specified Amazon Connect instance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/DeleteViewVersionCommand.ts b/clients/client-connect/src/commands/DeleteViewVersionCommand.ts index 98f87318e6f6..e48e8905655e 100644 --- a/clients/client-connect/src/commands/DeleteViewVersionCommand.ts +++ b/clients/client-connect/src/commands/DeleteViewVersionCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteViewVersionRequest } from "../models/models_0"; -import { DeleteViewVersionResponse } from "../models/models_1"; +import { DeleteViewVersionRequest, DeleteViewVersionResponse } from "../models/models_0"; import { de_DeleteViewVersionCommand, se_DeleteViewVersionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/DeleteVocabularyCommand.ts b/clients/client-connect/src/commands/DeleteVocabularyCommand.ts index ca2f3b053e7c..0d8c9412b686 100644 --- a/clients/client-connect/src/commands/DeleteVocabularyCommand.ts +++ b/clients/client-connect/src/commands/DeleteVocabularyCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteVocabularyRequest, DeleteVocabularyResponse } from "../models/models_1"; +import { DeleteVocabularyRequest } from "../models/models_0"; +import { DeleteVocabularyResponse } from "../models/models_1"; import { de_DeleteVocabularyCommand, se_DeleteVocabularyCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/DescribeContactCommand.ts b/clients/client-connect/src/commands/DescribeContactCommand.ts index 3d6fa57f9d0e..ba20c1630b51 100644 --- a/clients/client-connect/src/commands/DescribeContactCommand.ts +++ b/clients/client-connect/src/commands/DescribeContactCommand.ts @@ -233,6 +233,16 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _ * // SegmentAttributes: { // SegmentAttributes * // "": { // SegmentAttributeValue * // ValueString: "STRING_VALUE", + * // ValueMap: { // SegmentAttributeValueMap + * // "": { + * // ValueString: "STRING_VALUE", + * // ValueMap: { + * // "": "", + * // }, + * // ValueInteger: Number("int"), + * // }, + * // }, + * // ValueInteger: Number("int"), * // }, * // }, * // }, diff --git a/clients/client-connect/src/commands/DescribeContactFlowCommand.ts b/clients/client-connect/src/commands/DescribeContactFlowCommand.ts index 9f3115a2458f..02d78db279b3 100644 --- a/clients/client-connect/src/commands/DescribeContactFlowCommand.ts +++ b/clients/client-connect/src/commands/DescribeContactFlowCommand.ts @@ -32,7 +32,7 @@ export interface DescribeContactFlowCommandOutput extends DescribeContactFlowRes *

You can also create and update flows using the Amazon Connect * Flow language.

*

Use the $SAVED alias in the request to describe the SAVED content - * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. Once a contact flow is + * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. After a flow is * published, $SAVED needs to be supplied to view saved content that has not been * published.

*

In the response, Status indicates the flow status as either @@ -65,7 +65,6 @@ export interface DescribeContactFlowCommandOutput extends DescribeContactFlowRes * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, - * // IsDefault: true || false, * // FlowContentSha256: "STRING_VALUE", * // Version: Number("long"), * // VersionDescription: "STRING_VALUE", diff --git a/clients/client-connect/src/commands/DescribeContactFlowModuleCommand.ts b/clients/client-connect/src/commands/DescribeContactFlowModuleCommand.ts index 0cb427f23b45..5f3b58e5ee11 100644 --- a/clients/client-connect/src/commands/DescribeContactFlowModuleCommand.ts +++ b/clients/client-connect/src/commands/DescribeContactFlowModuleCommand.ts @@ -30,7 +30,7 @@ export interface DescribeContactFlowModuleCommandOutput extends DescribeContactF /** *

Describes the specified flow module.

*

Use the $SAVED alias in the request to describe the SAVED content - * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. Once a contact flow is + * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. After a flow is * published, $SAVED needs to be supplied to view saved content that has not been * published.

* @example diff --git a/clients/client-connect/src/commands/DescribeEmailAddressCommand.ts b/clients/client-connect/src/commands/DescribeEmailAddressCommand.ts index 3a9ad218f56d..6bff5604d6fd 100644 --- a/clients/client-connect/src/commands/DescribeEmailAddressCommand.ts +++ b/clients/client-connect/src/commands/DescribeEmailAddressCommand.ts @@ -32,7 +32,7 @@ export interface DescribeEmailAddressCommandInput extends DescribeEmailAddressRe export interface DescribeEmailAddressCommandOutput extends DescribeEmailAddressResponse, __MetadataBearer {} /** - *

+ *

Describe email address form the specified Amazon Connect instance.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/ListAssociatedContactsCommand.ts b/clients/client-connect/src/commands/ListAssociatedContactsCommand.ts index b7abc80067aa..b228596eec02 100644 --- a/clients/client-connect/src/commands/ListAssociatedContactsCommand.ts +++ b/clients/client-connect/src/commands/ListAssociatedContactsCommand.ts @@ -28,7 +28,8 @@ export interface ListAssociatedContactsCommandInput extends ListAssociatedContac export interface ListAssociatedContactsCommandOutput extends ListAssociatedContactsResponse, __MetadataBearer {} /** - *

+ *

Provides information about contact tree, a list of associated contacts with a unique + * identifier.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts b/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts index bfb6ce6a0f89..ecbab748b172 100644 --- a/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts +++ b/clients/client-connect/src/commands/ListRealtimeContactAnalysisSegmentsV2Command.ts @@ -168,7 +168,7 @@ export interface ListRealtimeContactAnalysisSegmentsV2CommandOutput * @throws {@link OutputTypeNotFoundException} (client fault) *

Thrown for analyzed content when requested OutputType was not enabled for a given contact. * For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction - * policy set in Contact flow.

+ * policy set in the flow.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource was not found.

diff --git a/clients/client-connect/src/commands/SearchContactFlowsCommand.ts b/clients/client-connect/src/commands/SearchContactFlowsCommand.ts index ae2296df4601..6366a3466473 100644 --- a/clients/client-connect/src/commands/SearchContactFlowsCommand.ts +++ b/clients/client-connect/src/commands/SearchContactFlowsCommand.ts @@ -29,8 +29,7 @@ export interface SearchContactFlowsCommandInput extends SearchContactFlowsReques export interface SearchContactFlowsCommandOutput extends SearchContactFlowsResponse, __MetadataBearer {} /** - *

Searches the contact flows in an Amazon Connect instance, with optional - * filtering.

+ *

Searches the flows in an Amazon Connect instance, with optional filtering.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -108,7 +107,6 @@ export interface SearchContactFlowsCommandOutput extends SearchContactFlowsRespo * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, - * // IsDefault: true || false, * // FlowContentSha256: "STRING_VALUE", * // Version: Number("long"), * // VersionDescription: "STRING_VALUE", diff --git a/clients/client-connect/src/commands/SearchEmailAddressesCommand.ts b/clients/client-connect/src/commands/SearchEmailAddressesCommand.ts index fe4940b44f26..7422eea124c5 100644 --- a/clients/client-connect/src/commands/SearchEmailAddressesCommand.ts +++ b/clients/client-connect/src/commands/SearchEmailAddressesCommand.ts @@ -29,7 +29,7 @@ export interface SearchEmailAddressesCommandInput extends SearchEmailAddressesRe export interface SearchEmailAddressesCommandOutput extends SearchEmailAddressesResponse, __MetadataBearer {} /** - *

+ *

Searches email address in an instance, with optional filtering.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/SendOutboundEmailCommand.ts b/clients/client-connect/src/commands/SendOutboundEmailCommand.ts index 29d181628a4a..17df58121fab 100644 --- a/clients/client-connect/src/commands/SendOutboundEmailCommand.ts +++ b/clients/client-connect/src/commands/SendOutboundEmailCommand.ts @@ -32,7 +32,12 @@ export interface SendOutboundEmailCommandInput extends SendOutboundEmailRequest export interface SendOutboundEmailCommandOutput extends SendOutboundEmailResponse, __MetadataBearer {} /** - *

+ *

Send outbound email for outbound campaigns. For more information about outbound campaigns, + * see Set up Amazon Connect outbound campaigns.

+ * + *

Only the Amazon Connect outbound campaigns service principal is allowed to assume a + * role in your account and call this API.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/StartAttachedFileUploadCommand.ts b/clients/client-connect/src/commands/StartAttachedFileUploadCommand.ts index 4c7068077d69..3a643d067a09 100644 --- a/clients/client-connect/src/commands/StartAttachedFileUploadCommand.ts +++ b/clients/client-connect/src/commands/StartAttachedFileUploadCommand.ts @@ -30,7 +30,9 @@ export interface StartAttachedFileUploadCommandOutput extends StartAttachedFileU /** *

Provides a pre-signed Amazon S3 URL in response for uploading your content.

* - *

You may only use this API to upload attachments to an Amazon Connect Case.

+ *

You may only use this API to upload attachments to an Amazon Connect Case or + * Amazon Connect + * Email.

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-connect/src/commands/StartChatContactCommand.ts b/clients/client-connect/src/commands/StartChatContactCommand.ts index c8c35f81e631..4108f91cbded 100644 --- a/clients/client-connect/src/commands/StartChatContactCommand.ts +++ b/clients/client-connect/src/commands/StartChatContactCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { StartChatContactRequest, StartChatContactResponse } from "../models/models_2"; +import { StartChatContactResponse } from "../models/models_2"; +import { StartChatContactRequest } from "../models/models_3"; import { de_StartChatContactCommand, se_StartChatContactCommand } from "../protocols/Aws_restJson1"; /** @@ -93,6 +94,16 @@ export interface StartChatContactCommandOutput extends StartChatContactResponse, * SegmentAttributes: { // SegmentAttributes * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", + * ValueMap: { // SegmentAttributeValueMap + * "": { + * ValueString: "STRING_VALUE", + * ValueMap: { + * "": "", + * }, + * ValueInteger: Number("int"), + * }, + * }, + * ValueInteger: Number("int"), * }, * }, * }; diff --git a/clients/client-connect/src/commands/StartEmailContactCommand.ts b/clients/client-connect/src/commands/StartEmailContactCommand.ts index a23edcdfcfbe..47cab464bad7 100644 --- a/clients/client-connect/src/commands/StartEmailContactCommand.ts +++ b/clients/client-connect/src/commands/StartEmailContactCommand.ts @@ -6,11 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - StartEmailContactRequest, - StartEmailContactRequestFilterSensitiveLog, - StartEmailContactResponse, -} from "../models/models_2"; +import { StartEmailContactResponse } from "../models/models_2"; +import { StartEmailContactRequest, StartEmailContactRequestFilterSensitiveLog } from "../models/models_3"; import { de_StartEmailContactCommand, se_StartEmailContactCommand } from "../protocols/Aws_restJson1"; /** @@ -32,7 +29,8 @@ export interface StartEmailContactCommandInput extends StartEmailContactRequest export interface StartEmailContactCommandOutput extends StartEmailContactResponse, __MetadataBearer {} /** - *

+ *

Creates an inbound email contact and initiates a flow to start the email contact for the + * customer. Response of this API provides the ContactId of the email contact created.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -96,6 +94,16 @@ export interface StartEmailContactCommandOutput extends StartEmailContactRespons * SegmentAttributes: { // SegmentAttributes * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", + * ValueMap: { // SegmentAttributeValueMap + * "": { + * ValueString: "STRING_VALUE", + * ValueMap: { + * "": "", + * }, + * ValueInteger: Number("int"), + * }, + * }, + * ValueInteger: Number("int"), * }, * }, * ClientToken: "STRING_VALUE", diff --git a/clients/client-connect/src/commands/StartOutboundChatContactCommand.ts b/clients/client-connect/src/commands/StartOutboundChatContactCommand.ts index ded18f8894c0..df7fcd6f0be6 100644 --- a/clients/client-connect/src/commands/StartOutboundChatContactCommand.ts +++ b/clients/client-connect/src/commands/StartOutboundChatContactCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { StartOutboundChatContactRequest, StartOutboundChatContactResponse } from "../models/models_2"; +import { StartOutboundChatContactResponse } from "../models/models_2"; +import { StartOutboundChatContactRequest } from "../models/models_3"; import { de_StartOutboundChatContactCommand, se_StartOutboundChatContactCommand } from "../protocols/Aws_restJson1"; /** @@ -72,6 +73,16 @@ export interface StartOutboundChatContactCommandOutput extends StartOutboundChat * SegmentAttributes: { // SegmentAttributes // required * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", + * ValueMap: { // SegmentAttributeValueMap + * "": { + * ValueString: "STRING_VALUE", + * ValueMap: { + * "": "", + * }, + * ValueInteger: Number("int"), + * }, + * }, + * ValueInteger: Number("int"), * }, * }, * Attributes: { // Attributes diff --git a/clients/client-connect/src/commands/StartOutboundEmailContactCommand.ts b/clients/client-connect/src/commands/StartOutboundEmailContactCommand.ts index 22ab45db6069..6f36e039c411 100644 --- a/clients/client-connect/src/commands/StartOutboundEmailContactCommand.ts +++ b/clients/client-connect/src/commands/StartOutboundEmailContactCommand.ts @@ -32,7 +32,8 @@ export interface StartOutboundEmailContactCommandInput extends StartOutboundEmai export interface StartOutboundEmailContactCommandOutput extends StartOutboundEmailContactResponse, __MetadataBearer {} /** - *

+ *

Initiates a flow to send an agent reply or outbound email contact (created from the + * CreateContact API) to a customer.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/StartTaskContactCommand.ts b/clients/client-connect/src/commands/StartTaskContactCommand.ts index c228c0061f77..1cb9020c4648 100644 --- a/clients/client-connect/src/commands/StartTaskContactCommand.ts +++ b/clients/client-connect/src/commands/StartTaskContactCommand.ts @@ -6,11 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - StartTaskContactRequest, - StartTaskContactRequestFilterSensitiveLog, - StartTaskContactResponse, -} from "../models/models_2"; +import { StartTaskContactResponse } from "../models/models_2"; +import { StartTaskContactRequest, StartTaskContactRequestFilterSensitiveLog } from "../models/models_3"; import { de_StartTaskContactCommand, se_StartTaskContactCommand } from "../protocols/Aws_restJson1"; /** @@ -115,6 +112,16 @@ export interface StartTaskContactCommandOutput extends StartTaskContactResponse, * SegmentAttributes: { // SegmentAttributes * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", + * ValueMap: { // SegmentAttributeValueMap + * "": { + * ValueString: "STRING_VALUE", + * ValueMap: { + * "": "", + * }, + * ValueInteger: Number("int"), + * }, + * }, + * ValueInteger: Number("int"), * }, * }, * }; diff --git a/clients/client-connect/src/commands/TagResourceCommand.ts b/clients/client-connect/src/commands/TagResourceCommand.ts index 3f06021fa51d..1a08dfc6c448 100644 --- a/clients/client-connect/src/commands/TagResourceCommand.ts +++ b/clients/client-connect/src/commands/TagResourceCommand.ts @@ -30,8 +30,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {} /** *

Adds the specified tags to the specified resource.

*

Some of the supported resource types are agents, routing profiles, queues, quick connects, - * contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task - * templates. For a complete list, see Tagging resources in Amazon Connect.

+ * flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. + * For a complete list, see Tagging resources in Amazon Connect.

*

For sample policies that use tags, see Amazon Connect * Identity-Based Policy Examples in the Amazon Connect Administrator * Guide.

diff --git a/clients/client-connect/src/commands/UpdateContactCommand.ts b/clients/client-connect/src/commands/UpdateContactCommand.ts index b9ae069b3d17..c8c259156f65 100644 --- a/clients/client-connect/src/commands/UpdateContactCommand.ts +++ b/clients/client-connect/src/commands/UpdateContactCommand.ts @@ -6,11 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - UpdateContactRequest, - UpdateContactRequestFilterSensitiveLog, - UpdateContactResponse, -} from "../models/models_2"; +import { UpdateContactResponse } from "../models/models_2"; +import { UpdateContactRequest, UpdateContactRequestFilterSensitiveLog } from "../models/models_3"; import { de_UpdateContactCommand, se_UpdateContactCommand } from "../protocols/Aws_restJson1"; /** @@ -62,6 +59,16 @@ export interface UpdateContactCommandOutput extends UpdateContactResponse, __Met * SegmentAttributes: { // SegmentAttributes * "": { // SegmentAttributeValue * ValueString: "STRING_VALUE", + * ValueMap: { // SegmentAttributeValueMap + * "": { + * ValueString: "STRING_VALUE", + * ValueMap: { + * "": "", + * }, + * ValueInteger: Number("int"), + * }, + * }, + * ValueInteger: Number("int"), * }, * }, * }; diff --git a/clients/client-connect/src/commands/UpdateContactFlowContentCommand.ts b/clients/client-connect/src/commands/UpdateContactFlowContentCommand.ts index 4d4afb528b05..b1bc7105d97a 100644 --- a/clients/client-connect/src/commands/UpdateContactFlowContentCommand.ts +++ b/clients/client-connect/src/commands/UpdateContactFlowContentCommand.ts @@ -32,7 +32,7 @@ export interface UpdateContactFlowContentCommandOutput extends UpdateContactFlow *

You can also create and update flows using the Amazon Connect * Flow language.

*

Use the $SAVED alias in the request to describe the SAVED content - * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. Once a contact flow is + * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. After a flow is * published, $SAVED needs to be supplied to view saved content that has not been * published.

* @example diff --git a/clients/client-connect/src/commands/UpdateContactFlowModuleContentCommand.ts b/clients/client-connect/src/commands/UpdateContactFlowModuleContentCommand.ts index b7fae6f8cd44..b646e32c7c46 100644 --- a/clients/client-connect/src/commands/UpdateContactFlowModuleContentCommand.ts +++ b/clients/client-connect/src/commands/UpdateContactFlowModuleContentCommand.ts @@ -35,7 +35,7 @@ export interface UpdateContactFlowModuleContentCommandOutput /** *

Updates specified flow module for the specified Amazon Connect instance.

*

Use the $SAVED alias in the request to describe the SAVED content - * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. Once a contact flow is + * of a Flow. For example, arn:aws:.../contact-flow/\{id\}:$SAVED. After a flow is * published, $SAVED needs to be supplied to view saved content that has not been * published.

* @example diff --git a/clients/client-connect/src/commands/UpdateEmailAddressMetadataCommand.ts b/clients/client-connect/src/commands/UpdateEmailAddressMetadataCommand.ts index 562997d16540..d6cc3e49bb87 100644 --- a/clients/client-connect/src/commands/UpdateEmailAddressMetadataCommand.ts +++ b/clients/client-connect/src/commands/UpdateEmailAddressMetadataCommand.ts @@ -32,7 +32,8 @@ export interface UpdateEmailAddressMetadataCommandInput extends UpdateEmailAddre export interface UpdateEmailAddressMetadataCommandOutput extends UpdateEmailAddressMetadataResponse, __MetadataBearer {} /** - *

+ *

Updates an email address metadata. For more information about email addresses, see Create email + * addresses in the Amazon Connect Administrator Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts b/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts index a8016e10f136..6306c9776b3e 100644 --- a/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts +++ b/clients/client-connect/src/commands/UpdateQueueOutboundEmailConfigCommand.ts @@ -31,7 +31,7 @@ export interface UpdateQueueOutboundEmailConfigCommandInput extends UpdateQueueO export interface UpdateQueueOutboundEmailConfigCommandOutput extends __MetadataBearer {} /** - *

+ *

Updates the outbound email address Id for a specified queue.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,7 +61,7 @@ export interface UpdateQueueOutboundEmailConfigCommandOutput extends __MetadataB *

You do not have sufficient permissions to perform this action.

* * @throws {@link ConditionalOperationFailedException} (client fault) - *

+ *

A conditional check failed.

* * @throws {@link InternalServiceException} (server fault) *

Request processing failed because of an error or failure with the service.

diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts index ae2caf452acb..0b8186f045dd 100644 --- a/clients/client-connect/src/models/models_0.ts +++ b/clients/client-connect/src/models/models_0.ts @@ -227,36 +227,40 @@ export class ThrottlingException extends __BaseException { } /** - *

+ *

Information about the email recipient

* @public */ export interface EmailRecipient { /** - *

+ *

Address of the email recipient.

+ *

Type: String

+ *

Length Constraints: Minimum length of 1. Maximum length of 256.

* @public */ Address?: string | undefined; /** - *

+ *

Display name of the email recipient.

+ *

Type: String

+ *

Length Constraints: Minimum length of 1. Maximum length of 256.

* @public */ DisplayName?: string | undefined; } /** - *

+ *

List of additional email addresses for an email contact.

* @public */ export interface AdditionalEmailRecipients { /** - *

+ *

List of additional TO email recipients for an email contact.

* @public */ ToList?: EmailRecipient[] | undefined; /** - *

+ *

List of additional CC email recipients for an email contact.

* @public */ CcList?: EmailRecipient[] | undefined; @@ -1191,7 +1195,7 @@ export type AttachedFileServiceQuotaExceededExceptionReason = (typeof AttachedFileServiceQuotaExceededExceptionReason)[keyof typeof AttachedFileServiceQuotaExceededExceptionReason]; /** - *

+ *

The reason for the exception.

* @public */ export type ServiceQuotaExceededExceptionReason = @@ -1203,7 +1207,7 @@ export type ServiceQuotaExceededExceptionReason = */ export namespace ServiceQuotaExceededExceptionReason { /** - *

+ *

Total file size of all files or total number of files exceeds the service quota

* @public */ export interface AttachedFileServiceQuotaExceededExceptionReasonMember { @@ -1242,7 +1246,7 @@ export class ServiceQuotaExceededException extends __BaseException { readonly $fault: "client" = "client"; Message?: string | undefined; /** - *

+ *

The reason for the exception.

* @public */ Reason?: ServiceQuotaExceededExceptionReason | undefined; @@ -2128,8 +2132,8 @@ export interface BatchGetAttachedFileMetadataRequest { InstanceId: string | undefined; /** - *

The resource to which the attached file is (being) uploaded to. Cases are the only - * current supported resource.

+ *

The resource to which the attached file is (being) uploaded to. The supported resources are + * Cases and Email.

* *

This value must be a valid ARN.

* @@ -2719,8 +2723,8 @@ export interface CompleteAttachedFileUploadRequest { FileId: string | undefined; /** - *

The resource to which the attached file is (being) uploaded to. Cases are the only - * current supported resource.

+ *

The resource to which the attached file is (being) uploaded to. The supported resources are + * Cases and Email.

* *

This value must be a valid ARN.

* @@ -2910,144 +2914,48 @@ export interface Reference { Type: ReferenceType | undefined; /** - *

+ *

Status of the attachment reference type.

* @public */ Status?: ReferenceStatus | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the reference

* @public */ Arn?: string | undefined; /** - *

+ *

Relevant details why the reference was not successfully created.

* @public */ StatusReason?: string | undefined; } /** - *

A value for a segment attribute. This is structured as a map where the key is - * valueString and the value is a string.

- * @public - */ -export interface SegmentAttributeValue { - /** - *

The value of a segment attribute.

- * @public - */ - ValueString?: string | undefined; -} - -/** - *

+ *

The user details for the contact.

* @public */ export interface UserInfo { /** - *

+ *

The user identifier for the contact.

* @public */ UserId?: string | undefined; } -/** - * @public - */ -export interface CreateContactRequest { - /** - *

- * @public - */ - InstanceId: string | undefined; - - /** - *

- * @public - */ - ClientToken?: string | undefined; - - /** - *

- * @public - */ - RelatedContactId?: string | undefined; - - /** - *

- * @public - */ - Attributes?: Record | undefined; - - /** - *

- * @public - */ - References?: Record | undefined; - - /** - *

- * @public - */ - Channel: Channel | undefined; - - /** - *

- * @public - */ - InitiationMethod: ContactInitiationMethod | undefined; - - /** - *

- * @public - */ - ExpiryDurationInMinutes?: number | undefined; - - /** - *

- * @public - */ - UserInfo?: UserInfo | undefined; - - /** - *

- * @public - */ - InitiateAs?: InitiateAs | undefined; - - /** - *

- * @public - */ - Name?: string | undefined; - - /** - *

- * @public - */ - Description?: string | undefined; - - /** - *

- * @public - */ - SegmentAttributes?: Record | undefined; -} - /** * @public */ export interface CreateContactResponse { /** - *

+ *

The identifier of the contact in this instance of Amazon Connect.

* @public */ ContactId?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the created contact.

* @public */ ContactArn?: string | undefined; @@ -3349,37 +3257,40 @@ export interface CreateContactFlowVersionResponse { */ export interface CreateEmailAddressRequest { /** - *

+ *

The description of the email address.

* @public */ Description?: string | undefined; /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.

* @public */ EmailAddress: string | undefined; /** - *

+ *

The display name of email address

* @public */ DisplayName?: string | undefined; /** - *

+ *

The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.

* @public */ Tags?: Record | undefined; /** - *

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ ClientToken?: string | undefined; @@ -3390,13 +3301,13 @@ export interface CreateEmailAddressRequest { */ export interface CreateEmailAddressResponse { /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the email address.

* @public */ EmailAddressArn?: string | undefined; @@ -4631,12 +4542,12 @@ export interface OutboundCallerConfig { } /** - *

+ *

The outbound email address Id.

* @public */ export interface OutboundEmailConfig { /** - *

+ *

The identifier of the email address.

* @public */ OutboundEmailAddressId?: string | undefined; @@ -4671,7 +4582,7 @@ export interface CreateQueueRequest { OutboundCallerConfig?: OutboundCallerConfig | undefined; /** - *

+ *

The outbound email address ID for a specified queue.

* @public */ OutboundEmailConfig?: OutboundEmailConfig | undefined; @@ -5764,7 +5675,8 @@ export interface CreateTaskTemplateRequest { ContactFlowId?: string | undefined; /** - *

+ *

The ContactFlowId for the flow that will be run if this template is used to create a + * self-assigned task.

* @public */ SelfAssignFlowId?: string | undefined; @@ -6864,13 +6776,13 @@ export interface DeleteContactFlowModuleResponse {} */ export interface DeleteEmailAddressRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId: string | undefined; @@ -7215,13 +7127,26 @@ export interface DeleteViewVersionRequest { } /** - * @internal + * @public */ -export const CreateContactRequestFilterSensitiveLog = (obj: CreateContactRequest): any => ({ - ...obj, - ...(obj.Name && { Name: SENSITIVE_STRING }), - ...(obj.Description && { Description: SENSITIVE_STRING }), -}); +export interface DeleteViewVersionResponse {} + +/** + * @public + */ +export interface DeleteVocabularyRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier of the custom vocabulary.

+ * @public + */ + VocabularyId: string | undefined; +} /** * @internal diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts index 410dd9eeb5b7..88f354a21eee 100644 --- a/clients/client-connect/src/models/models_1.ts +++ b/clients/client-connect/src/models/models_1.ts @@ -65,28 +65,6 @@ import { VocabularyState, } from "./models_0"; -/** - * @public - */ -export interface DeleteViewVersionResponse {} - -/** - * @public - */ -export interface DeleteVocabularyRequest { - /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

- * @public - */ - InstanceId: string | undefined; - - /** - *

The identifier of the custom vocabulary.

- * @public - */ - VocabularyId: string | undefined; -} - /** * @public */ @@ -328,24 +306,24 @@ export interface Customer { } /** - *

+ *

Information about the endpoint.

* @public */ export interface EndpointInfo { /** - *

+ *

Type of endpoint.

* @public */ Type?: EndpointType | undefined; /** - *

+ *

Address of the endpoint.

* @public */ Address?: string | undefined; /** - *

+ *

Display name of the endpoint.

* @public */ DisplayName?: string | undefined; @@ -876,7 +854,7 @@ export interface ContactFlow { State?: ContactFlowState | undefined; /** - *

The status of the contact flow.

+ *

The status of the flow.

* @public */ Status?: ContactFlowStatus | undefined; @@ -901,13 +879,6 @@ export interface ContactFlow { */ Tags?: Record | undefined; - /** - *

Amazon Connect includes a set of default flows that have already been published. It uses - * them to power your contact center.

- * @public - */ - IsDefault?: boolean | undefined; - /** *

Indicates the checksum value of the flow content.

* @public @@ -927,13 +898,13 @@ export interface ContactFlow { VersionDescription?: string | undefined; /** - *

The time at which the contact flow was last modified.

+ *

The time at which the flow was last modified.

* @public */ LastModifiedTime?: Date | undefined; /** - *

The region in which the contact flow was last modified

+ *

The region in which the flow was last modified

* @public */ LastModifiedRegion?: string | undefined; @@ -1066,13 +1037,13 @@ export interface DescribeContactFlowModuleResponse { */ export interface DescribeEmailAddressRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId: string | undefined; @@ -1083,49 +1054,49 @@ export interface DescribeEmailAddressRequest { */ export interface DescribeEmailAddressResponse { /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the email address.

* @public */ EmailAddressArn?: string | undefined; /** - *

+ *

The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.

* @public */ EmailAddress?: string | undefined; /** - *

+ *

The display name of email address

* @public */ DisplayName?: string | undefined; /** - *

+ *

The description of the email address.

* @public */ Description?: string | undefined; /** - *

+ *

The email address creation timestamp in ISO 8601 Datetime.

* @public */ CreateTimestamp?: string | undefined; /** - *

+ *

The email address last modification timestamp in ISO 8601 Datetime.

* @public */ ModifiedTimestamp?: string | undefined; /** - *

+ *

The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.

* @public */ Tags?: Record | undefined; @@ -2235,7 +2206,7 @@ export interface Queue { OutboundCallerConfig?: OutboundCallerConfig | undefined; /** - *

+ *

The outbound email address ID for a specified queue.

* @public */ OutboundEmailConfig?: OutboundEmailConfig | undefined; @@ -3664,7 +3635,7 @@ export interface DismissUserContactResponse {} */ export interface GetAttachedFileRequest { /** - *

The unique identifier of the Connect instance.

+ *

The unique identifier of the Amazon Connect instance.

* @public */ InstanceId: string | undefined; @@ -3683,8 +3654,8 @@ export interface GetAttachedFileRequest { UrlExpiryInSeconds?: number | undefined; /** - *

The resource to which the attached file is (being) uploaded to. Cases are the only - * current supported resource.

+ *

The resource to which the attached file is (being) uploaded to. The supported resources are + * Cases and Email.

* *

This value must be a valid ARN.

* @@ -6567,7 +6538,8 @@ export interface GetTaskTemplateResponse { ContactFlowId?: string | undefined; /** - *

+ *

ContactFlowId for the flow that will be run if this template is used to create a + * self-assigned task

* @public */ SelfAssignFlowId?: string | undefined; @@ -6909,85 +6881,88 @@ export interface ListApprovedOriginsResponse { */ export interface ListAssociatedContactsRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The identifier of the contact in this instance of Amazon Connect.

* @public */ ContactId: string | undefined; /** - *

+ *

The maximum number of results to return per page.

+ *

The maximum number of results to return per page. The default MaxResult size is 25.

+ *

Valid Range: Minimum value of 1. Maximum value of 100.

* @public */ MaxResults?: number | undefined; /** - *

+ *

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.

* @public */ NextToken?: string | undefined; } /** - *

+ *

Contact summary of a contact in contact tree associated with unique identifier.

* @public */ export interface AssociatedContactSummary { /** - *

+ *

The identifier of the contact in this instance of Amazon Connect.

* @public */ ContactId?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the contact

* @public */ ContactArn?: string | undefined; /** - *

+ *

The date and time this contact was initiated, in UTC time.

* @public */ InitiationTimestamp?: Date | undefined; /** - *

+ *

The timestamp when the customer endpoint disconnected from Amazon Connect.

* @public */ DisconnectTimestamp?: Date | undefined; /** - *

+ *

If this contact is related to other contacts, this is the ID of the initial contact.

* @public */ InitialContactId?: string | undefined; /** - *

+ *

If this contact is not the first contact, this is the ID of the previous contact.

* @public */ PreviousContactId?: string | undefined; /** - *

+ *

The contactId that is related to this contact.

* @public */ RelatedContactId?: string | undefined; /** - *

+ *

Indicates how the contact was initiated.

* @public */ InitiationMethod?: ContactInitiationMethod | undefined; /** - *

+ *

How the contact reached your contact center.

* @public */ Channel?: Channel | undefined; @@ -6998,13 +6973,14 @@ export interface AssociatedContactSummary { */ export interface ListAssociatedContactsResponse { /** - *

+ *

List of the contact summary for all the contacts in contact tree associated with unique + * identifier.

* @public */ ContactSummaryList?: AssociatedContactSummary[] | undefined; /** - *

+ *

If there are additional results, this is the token for the next set of results.

* @public */ NextToken?: string | undefined; @@ -7431,7 +7407,7 @@ export interface ContactFlowSummary { ContactFlowState?: ContactFlowState | undefined; /** - *

The status of the contact flow.

+ *

The status of the flow.

* @public */ ContactFlowStatus?: ContactFlowStatus | undefined; @@ -7485,7 +7461,7 @@ export interface ListContactFlowVersionsRequest { } /** - *

A summary of a contact flow version's metadata.

+ *

A summary of a flow version's metadata.

* @public */ export interface ContactFlowVersionSummary { @@ -7584,7 +7560,7 @@ export interface AttachmentReference { Status?: ReferenceStatus | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the attachment reference.

* @public */ Arn?: string | undefined; @@ -7629,18 +7605,19 @@ export interface EmailReference { } /** - *

+ *

Information about the reference when the referenceType is EMAIL_MESSAGE. + * Otherwise, null.

* @public */ export interface EmailMessageReference { /** - *

+ *

The name of the email message reference

* @public */ Name?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the email message reference

* @public */ Arn?: string | undefined; @@ -7754,7 +7731,8 @@ export namespace ReferenceSummary { } /** - *

+ *

Information about the reference when the referenceType is EMAIL_MESSAGE. + * Otherwise, null.

* @public */ export interface EmailMessageMember { @@ -9816,6 +9794,83 @@ export interface RealTimeContactAnalysisTranscriptItemRedaction { CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined; } +/** + * @public + * @enum + */ +export const RealTimeContactAnalysisSentimentLabel = { + NEGATIVE: "NEGATIVE", + NEUTRAL: "NEUTRAL", + POSITIVE: "POSITIVE", +} as const; + +/** + * @public + */ +export type RealTimeContactAnalysisSentimentLabel = + (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel]; + +/** + *

The analyzed transcript segment.

+ * @public + */ +export interface RealTimeContactAnalysisSegmentTranscript { + /** + *

The identifier of the transcript.

+ * @public + */ + Id: string | undefined; + + /** + *

The identifier of the participant.

+ * @public + */ + ParticipantId: string | undefined; + + /** + *

The role of the participant. For example, is it a customer, agent, or system.

+ * @public + */ + ParticipantRole: ParticipantRole | undefined; + + /** + *

The display name of the participant.

+ * @public + */ + DisplayName?: string | undefined; + + /** + *

The content of the transcript. Can be redacted.

+ * @public + */ + Content: string | undefined; + + /** + *

The type of content of the item. For example, text/plain.

+ * @public + */ + ContentType?: string | undefined; + + /** + *

Field describing the time of the event. It can have different representations of time.

+ * @public + */ + Time: RealTimeContactAnalysisTimeData | undefined; + + /** + *

Object describing redaction that was applied to the transcript. If transcript has the field + * it means part of the transcript was redacted.

+ * @public + */ + Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined; + + /** + *

The sentiment detected for this piece of transcript.

+ * @public + */ + Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined; +} + /** * @internal */ diff --git a/clients/client-connect/src/models/models_2.ts b/clients/client-connect/src/models/models_2.ts index aed90ae0506d..cc5eb4384a7a 100644 --- a/clients/client-connect/src/models/models_2.ts +++ b/clients/client-connect/src/models/models_2.ts @@ -13,15 +13,18 @@ import { AllowedCapabilities, Application, Channel, + ContactFlowStatus, + ContactFlowType, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, - Endpoint, EvaluationFormQuestion, + EvaluationFormScoringStrategy, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, + InitiateAs, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, @@ -36,7 +39,6 @@ import { RoutingProfileQueueConfig, RuleAction, RulePublishStatus, - SegmentAttributeValue, StringComparisonType, StringCondition, TagCondition, @@ -47,6 +49,7 @@ import { UseCaseType, UserIdentityInfo, UserIdentityInfoFilterSensitiveLog, + UserInfo, UserPhoneConfig, UserProficiency, View, @@ -65,6 +68,7 @@ import { ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, + EvaluationFormVersionStatus, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, @@ -82,9 +86,8 @@ import { RealTimeContactAnalysisSegmentEvent, RealTimeContactAnalysisSegmentIssues, RealTimeContactAnalysisSegmentPostContactSummary, + RealTimeContactAnalysisSegmentTranscript, RealTimeContactAnalysisSupportedChannel, - RealTimeContactAnalysisTimeData, - RealTimeContactAnalysisTranscriptItemRedaction, RoutingProfile, SignInConfig, SortOrder, @@ -92,83 +95,6 @@ import { TrafficDistributionGroupStatus, } from "./models_1"; -/** - * @public - * @enum - */ -export const RealTimeContactAnalysisSentimentLabel = { - NEGATIVE: "NEGATIVE", - NEUTRAL: "NEUTRAL", - POSITIVE: "POSITIVE", -} as const; - -/** - * @public - */ -export type RealTimeContactAnalysisSentimentLabel = - (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel]; - -/** - *

The analyzed transcript segment.

- * @public - */ -export interface RealTimeContactAnalysisSegmentTranscript { - /** - *

The identifier of the transcript.

- * @public - */ - Id: string | undefined; - - /** - *

The identifier of the participant.

- * @public - */ - ParticipantId: string | undefined; - - /** - *

The role of the participant. For example, is it a customer, agent, or system.

- * @public - */ - ParticipantRole: ParticipantRole | undefined; - - /** - *

The display name of the participant.

- * @public - */ - DisplayName?: string | undefined; - - /** - *

The content of the transcript. Can be redacted.

- * @public - */ - Content: string | undefined; - - /** - *

The type of content of the item. For example, text/plain.

- * @public - */ - ContentType?: string | undefined; - - /** - *

Field describing the time of the event. It can have different representations of time.

- * @public - */ - Time: RealTimeContactAnalysisTimeData | undefined; - - /** - *

Object describing redaction that was applied to the transcript. If transcript has the field - * it means part of the transcript was redacted.

- * @public - */ - Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined; - - /** - *

The sentiment detected for this piece of transcript.

- * @public - */ - Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined; -} - /** *

An analyzed segment for a real-time analysis session.

* @public @@ -352,7 +278,7 @@ export interface ListRealtimeContactAnalysisSegmentsV2Response { /** *

Thrown for analyzed content when requested OutputType was not enabled for a given contact. * For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction - * policy set in Contact flow.

+ * policy set in the flow.

* @public */ export class OutputTypeNotFoundException extends __BaseException { @@ -2101,7 +2027,7 @@ export interface ContactFlowModuleSearchFilter { */ export interface SearchContactFlowModulesResponse { /** - *

The search criteria to be used to return contact flow modules.

+ *

The search criteria to be used to return flow modules.

* @public */ ContactFlowModules?: ContactFlowModule[] | undefined; @@ -2113,7 +2039,7 @@ export interface SearchContactFlowModulesResponse { NextToken?: string | undefined; /** - *

The total number of contact flows which matched your search query.

+ *

The total number of flows which matched your search query.

* @public */ ApproximateTotalCount?: number | undefined; @@ -2159,7 +2085,7 @@ export interface SearchContactFlowsResponse { NextToken?: string | undefined; /** - *

The total number of contact flows which matched your search query.

+ *

The total number of flows which matched your search query.

* @public */ ApproximateTotalCount?: number | undefined; @@ -2226,8 +2152,7 @@ export interface Transcript { } /** - *

A structure that defines search criteria for contacts using analysis outputs from Amazon - * Connect Contact Lens.

+ *

A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.

* @public */ export interface ContactAnalysis { @@ -2239,7 +2164,7 @@ export interface ContactAnalysis { } /** - *

The search criteria based on user-defned contact attribute key and values to search + *

The search criteria based on user-defined contact attribute key and values to search * on.

* @public */ @@ -2279,36 +2204,38 @@ export interface SearchableContactAttributes { } /** - *

+ *

The search criteria based on searchable segment attribute key and values to search + * on.

* @public */ export interface SearchableSegmentAttributesCriteria { /** - *

+ *

The key containing a searchable segment attribute.

* @public */ Key: string | undefined; /** - *

+ *

The list of values to search for within a searchable segment attribute.

* @public */ Values: string[] | undefined; } /** - *

+ *

The search criteria based on searchable segment attributes of a contact

* @public */ export interface SearchableSegmentAttributes { /** - *

+ *

The list of criteria based on searchable segment attributes.

* @public */ Criteria: SearchableSegmentAttributesCriteria[] | undefined; /** - *

+ *

The match type combining search criteria using multiple searchable segment + * attributes.

* @public */ MatchType?: SearchContactsMatchType | undefined; @@ -2369,7 +2296,7 @@ export interface SearchCriteria { SearchableContactAttributes?: SearchableContactAttributes | undefined; /** - *

+ *

The search criteria based on searchable segment attributes of a contact.

* @public */ SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined; @@ -2532,12 +2459,14 @@ export interface ContactSearchSummaryQueueInfo { } /** - *

+ *

The value of a segment attribute. This is structured as a map with a single key-value pair. + * The key 'valueString' indicates that the attribute type is a string, and its corresponding value + * is the actual string value of the segment attribute.

* @public */ export interface ContactSearchSummarySegmentAttributeValue { /** - *

+ *

The value of a segment attribute represented as a string.

* @public */ ValueString?: string | undefined; @@ -2621,7 +2550,7 @@ export interface ContactSearchSummary { ScheduledTimestamp?: Date | undefined; /** - *

+ *

Set of segment attributes for a contact.

* @public */ SegmentAttributes?: Record | undefined; @@ -2651,7 +2580,7 @@ export interface SearchContactsResponse { } /** - *

+ *

Filters to be applied to search results.

* @public */ export interface EmailAddressSearchFilter { @@ -2674,36 +2603,36 @@ export interface EmailAddressSearchFilter { } /** - *

+ *

Contains information about an email address for a contact center.

* @public */ export interface EmailAddressMetadata { /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the email address.

* @public */ EmailAddressArn?: string | undefined; /** - *

+ *

The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.

* @public */ EmailAddress?: string | undefined; /** - *

+ *

The description of the email address.

* @public */ Description?: string | undefined; /** - *

+ *

The display name of email address.

* @public */ DisplayName?: string | undefined; @@ -2714,19 +2643,19 @@ export interface EmailAddressMetadata { */ export interface SearchEmailAddressesResponse { /** - *

+ *

If there are additional results, this is the token for the next set of results.

* @public */ NextToken?: string | undefined; /** - *

+ *

List of email addresses matching SearchFilter and SearchCriteria

* @public */ EmailAddresses?: EmailAddressMetadata[] | undefined; /** - *

+ *

The total number of email addresses which matched your search query.

* @public */ ApproximateTotalCount?: number | undefined; @@ -3974,30 +3903,30 @@ export interface SendChatIntegrationEventResponse { } /** - *

+ *

Contains information about a source or destination email address

* @public */ export interface EmailAddressInfo { /** - *

+ *

The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.

* @public */ EmailAddress: string | undefined; /** - *

+ *

The display name of email address.

* @public */ DisplayName?: string | undefined; } /** - *

+ *

The additional recipients information of outbound email.

* @public */ export interface OutboundAdditionalRecipients { /** - *

+ *

The additional CC email address recipients information.

* @public */ CcEmailAddresses?: EmailAddressInfo[] | undefined; @@ -4018,108 +3947,114 @@ export const OutboundMessageSourceType = { export type OutboundMessageSourceType = (typeof OutboundMessageSourceType)[keyof typeof OutboundMessageSourceType]; /** - *

+ *

Information about the raw email body content.

* @public */ export interface OutboundRawMessage { /** - *

+ *

The email subject.

* @public */ Subject: string | undefined; /** - *

+ *

The email message body.

* @public */ Body: string | undefined; /** - *

+ *

Type of content, that is, text/plain or text/html.

* @public */ ContentType: string | undefined; } /** - *

+ *

Information about the template attributes.

* @public */ export interface TemplateAttributes { /** - *

+ *

An object that specifies the custom attributes values to use for variables in the message + * template. This object contains different categories of key-value pairs. Each key defines a + * variable or placeholder in the message template.

* @public */ CustomAttributes?: Record | undefined; /** - *

+ *

An object that specifies the customer profile attributes values to use for variables in the + * message template. This object contains different categories of key-value pairs. Each key defines + * a variable or placeholder in the message template.

* @public */ CustomerProfileAttributes?: string | undefined; } /** - *

+ *

Information about template message configuration.

* @public */ export interface TemplatedMessageConfig { /** - *

+ *

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain + * the ARN.

* @public */ KnowledgeBaseId: string | undefined; /** - *

+ *

The identifier of the message template Id.

* @public */ MessageTemplateId: string | undefined; /** - *

+ *

Information about template attributes, that is, CustomAttributes or + * CustomerProfileAttributes.

* @public */ TemplateAttributes: TemplateAttributes | undefined; } /** - *

+ *

Information about email body content.

* @public */ export interface OutboundEmailContent { /** - *

+ *

The message source type, that is, RAW or TEMPLATE.

* @public */ MessageSourceType: OutboundMessageSourceType | undefined; /** - *

+ *

Information about template message configuration.

* @public */ TemplatedMessageConfig?: TemplatedMessageConfig | undefined; /** - *

+ *

The raw email body content.

* @public */ RawMessage?: OutboundRawMessage | undefined; } /** - *

+ *

Information about the campaign.

* @public */ export interface SourceCampaign { /** - *

+ *

A unique identifier for a campaign.

* @public */ CampaignId?: string | undefined; /** - *

+ *

A unique identifier for a each request part of same campaign.

* @public */ OutboundRequestId?: string | undefined; @@ -4144,49 +4079,52 @@ export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType]; */ export interface SendOutboundEmailRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The email address to be used for sending email.

* @public */ FromEmailAddress: EmailAddressInfo | undefined; /** - *

+ *

The email address to send the email to.

* @public */ DestinationEmailAddress: EmailAddressInfo | undefined; /** - *

+ *

The additional recipients address of the email in CC.

* @public */ AdditionalRecipients?: OutboundAdditionalRecipients | undefined; /** - *

+ *

The email message body to be sent to the newly created email.

* @public */ EmailMessage: OutboundEmailContent | undefined; /** - *

+ *

Denotes the class of traffic.

* @public */ TrafficType: TrafficType | undefined; /** - *

+ *

A Campaign object need for Campaign traffic type.

* @public */ SourceCampaign?: SourceCampaign | undefined; /** - *

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ ClientToken?: string | undefined; @@ -4237,13 +4175,16 @@ export interface StartAttachedFileUploadRequest { /** *

The use case for the file.

+ * + *

Only ATTACHMENTS are supported.

+ * * @public */ FileUseCaseType: FileUseCaseType | undefined; /** - *

The resource to which the attached file is (being) uploaded to. Cases are the only - * current supported resource.

+ *

The resource to which the attached file is (being) uploaded to. The supported resources are + * Cases and Email.

* *

This value must be a valid ARN.

* @@ -4406,120 +4347,6 @@ export interface PersistentChat { SourceContactId?: string | undefined; } -/** - * @public - */ -export interface StartChatContactRequest { - /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

- * @public - */ - InstanceId: string | undefined; - - /** - *

The identifier of the flow for initiating the chat. - * To - * see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the - * flow page, under the name of the flow, choose Show additional flow - * information. The ContactFlowId is the last part of the ARN, shown here in bold:

- *

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx - *

- * @public - */ - ContactFlowId: string | undefined; - - /** - *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

- *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys - * can include only alphanumeric, dash, and underscore characters.

- * @public - */ - Attributes?: Record | undefined; - - /** - *

Information identifying the participant.

- * @public - */ - ParticipantDetails: ParticipantDetails | undefined; - - /** - *

The initial message to be sent to the newly created chat. If you have a Lex bot in your - * flow, the initial message is not delivered to the Lex bot.

- * @public - */ - InitialMessage?: ChatMessage | undefined; - - /** - *

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 - * Making retries safe with idempotent APIs.

- * @public - */ - ClientToken?: string | undefined; - - /** - *

The total duration of the newly started chat session. If not specified, the chat session - * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum - * configurable time is 10,080 minutes (7 days).

- * @public - */ - ChatDurationInMinutes?: number | undefined; - - /** - *

The supported chat message content types. Supported types are text/plain, - * text/markdown, application/json, - * application/vnd.amazonaws.connect.message.interactive, and - * application/vnd.amazonaws.connect.message.interactive.response.

- *

Content types must always contain text/plain. You can then put any other - * supported type in the list. For example, all the following lists are valid because they contain - * text/plain: [text/plain, text/markdown, application/json], - * [text/markdown, text/plain], [text/plain, application/json, - * application/vnd.amazonaws.connect.message.interactive.response].

- * - *

The type application/vnd.amazonaws.connect.message.interactive is required to - * use the Show - * view flow block.

- * - * @public - */ - SupportedMessagingContentTypes?: string[] | undefined; - - /** - *

Enable persistent chats. For more information about enabling persistent chat, and for - * example use cases and how to configure for them, see Enable persistent chat.

- * @public - */ - PersistentChat?: PersistentChat | undefined; - - /** - *

The unique identifier for an Amazon Connect contact. This identifier is related to the - * chat starting.

- * - *

You cannot provide data for both RelatedContactId and PersistentChat.

- * - * @public - */ - RelatedContactId?: string | undefined; - - /** - *

A set of system defined key-value pairs stored on individual contact segments using an - * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in - * flows.

- *

Attribute keys can include only alphanumeric, -, and _.

- *

This field can be used to show channel subtype, such as connect:Guide.

- * - *

The types application/vnd.amazonaws.connect.message.interactive and - * application/vnd.amazonaws.connect.message.interactive.response must be present in - * the SupportedMessagingContentTypes field of this API in order to set - * SegmentAttributes as \{ "connect:Subtype": \{"valueString" : "connect:Guide" - * \}\}.

- * - * @public - */ - SegmentAttributes?: Record | undefined; -} - /** * @public */ @@ -4708,36 +4535,36 @@ export interface StartContactStreamingResponse { } /** - *

+ *

The additional TO CC recipients information of inbound email.

* @public */ export interface InboundAdditionalRecipients { /** - *

+ *

The additional recipients information present in to list.

* @public */ ToAddresses?: EmailAddressInfo[] | undefined; /** - *

+ *

The additional recipients information present in cc list.

* @public */ CcAddresses?: EmailAddressInfo[] | undefined; } /** - *

+ *

Information about the email attachment files.

* @public */ export interface EmailAttachment { /** - *

+ *

A case-sensitive name of the attached file being uploaded.

* @public */ FileName: string | undefined; /** - *

+ *

The pre-signed URLs for the S3 bucket where the email attachment is stored.

* @public */ S3Url: string | undefined; @@ -4774,48 +4601,48 @@ export const EmailHeaderType = { export type EmailHeaderType = (typeof EmailHeaderType)[keyof typeof EmailHeaderType]; /** - *

+ *

Information about the raw email body content.

* @public */ export interface InboundRawMessage { /** - *

+ *

The email subject.

* @public */ Subject: string | undefined; /** - *

+ *

The email message body.

* @public */ Body: string | undefined; /** - *

+ *

Type of content, that is, text/plain or text/html.

* @public */ ContentType: string | undefined; /** - *

+ *

Headers present in inbound email.

* @public */ Headers?: Partial> | undefined; } /** - *

+ *

Information about email body content.

* @public */ export interface InboundEmailContent { /** - *

+ *

The message source type, that is, RAW.

* @public */ MessageSourceType: InboundMessageSourceType | undefined; /** - *

+ *

The raw email body content.

* @public */ RawMessage?: InboundRawMessage | undefined; @@ -4824,411 +4651,175 @@ export interface InboundEmailContent { /** * @public */ -export interface StartEmailContactRequest { +export interface StartEmailContactResponse { /** - *

+ *

The identifier of this contact within the Amazon Connect instance.

* @public */ - InstanceId: string | undefined; + ContactId?: string | undefined; +} +/** + * @public + */ +export interface StartOutboundChatContactResponse { /** - *

+ *

The identifier of this contact within the Amazon Connect instance.

* @public */ - FromEmailAddress: EmailAddressInfo | undefined; + ContactId?: string | undefined; +} +/** + * @public + */ +export interface StartOutboundEmailContactRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - DestinationEmailAddress: string | undefined; + InstanceId: string | undefined; /** - *

+ *

The identifier of the contact in this instance of Amazon Connect.

* @public */ - Description?: string | undefined; + ContactId: string | undefined; /** - *

+ *

The email address associated with the instance.

* @public */ - References?: Record | undefined; + FromEmailAddress?: EmailAddressInfo | undefined; /** - *

+ *

The email address of the customer.

* @public */ - Name?: string | undefined; + DestinationEmailAddress: EmailAddressInfo | undefined; /** - *

+ *

The addtional recipients address of email in CC.

* @public */ - EmailMessage: InboundEmailContent | undefined; + AdditionalRecipients?: OutboundAdditionalRecipients | undefined; /** - *

+ *

The email message body to be sent to the newly created email.

* @public */ - AdditionalRecipients?: InboundAdditionalRecipients | undefined; + EmailMessage: OutboundEmailContent | undefined; /** - *

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ - Attachments?: EmailAttachment[] | undefined; + ClientToken?: string | undefined; +} +/** + * @public + */ +export interface StartOutboundEmailContactResponse { /** - *

+ *

The identifier of the contact in this instance of Amazon Connect.

* @public */ - ContactFlowId?: string | undefined; + ContactId?: string | undefined; +} +/** + *

Outbound calls to the destination number are not allowed.

+ * @public + */ +export class DestinationNotAllowedException extends __BaseException { + readonly name: "DestinationNotAllowedException" = "DestinationNotAllowedException"; + readonly $fault: "client" = "client"; /** - *

+ *

The message about the outbound calls.

* @public */ - RelatedContactId?: string | undefined; - + Message?: string | undefined; /** - *

- * @public + * @internal */ - Attributes?: Record | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "DestinationNotAllowedException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, DestinationNotAllowedException.prototype); + this.Message = opts.Message; + } +} +/** + *

The contact is not permitted.

+ * @public + */ +export class OutboundContactNotPermittedException extends __BaseException { + readonly name: "OutboundContactNotPermittedException" = "OutboundContactNotPermittedException"; + readonly $fault: "client" = "client"; /** - *

+ *

The message about the contact.

* @public */ - SegmentAttributes?: Record | undefined; - + Message?: string | undefined; /** - *

- * @public + * @internal */ - ClientToken?: string | undefined; + constructor(opts: __ExceptionOptionType) { + super({ + name: "OutboundContactNotPermittedException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, OutboundContactNotPermittedException.prototype); + this.Message = opts.Message; + } } /** + *

Configuration of the answering machine detection.

* @public */ -export interface StartEmailContactResponse { +export interface AnswerMachineDetectionConfig { + /** + *

The flag to indicate if answer machine detection analysis needs to be performed for a voice + * call. If set to true, TrafficType must be set as CAMPAIGN. + *

+ * @public + */ + EnableAnswerMachineDetection?: boolean | undefined; + /** - *

+ *

Wait for the answering machine prompt.

* @public */ - ContactId?: string | undefined; + AwaitAnswerMachinePrompt?: boolean | undefined; } /** * @public */ -export interface StartOutboundChatContactRequest { +export interface StartOutboundVoiceContactRequest { /** - *

Information about the endpoint.

+ *

The name of a voice contact that is shown to an agent in the Contact Control Panel + * (CCP).

* @public */ - SourceEndpoint: Endpoint | undefined; + Name?: string | undefined; /** - *

Information about the endpoint.

+ *

A description of the voice contact that is shown to an agent in the Contact Control Panel + * (CCP).

* @public */ - DestinationEndpoint: Endpoint | undefined; - - /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the - * Amazon Resource Name (ARN) of the instance.

- * @public - */ - InstanceId: string | undefined; - - /** - *

A set of system defined key-value pairs stored on individual contact segments using an - * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in - * flows.

- *
    - *
  • - *

    Attribute keys can include only alphanumeric, -, and _.

    - *
    • - *
  • - *

    This field can be used to show channel subtype, such as connect:Guide and - * connect:SMS.

    - *
    • - *
- * @public - */ - SegmentAttributes: Record | undefined; - - /** - *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

- * @public - */ - Attributes?: Record | undefined; - - /** - *

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect - * console user interface, on the navigation menu go to Routing, Contact - * Flows. Choose the flow. On the flow page, under the name of the flow, choose - * Show additional flow information. The ContactFlowId is the last - * part of the ARN, shown here in bold:

- *
    - *
  • - *

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx - *

    - *
    • - *
- * @public - */ - ContactFlowId: string | undefined; - - /** - *

The total duration of the newly started chat session. If not specified, the chat session - * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum - * configurable time is 10,080 minutes (7 days).

- * @public - */ - ChatDurationInMinutes?: number | undefined; - - /** - *

The customer's details.

- * @public - */ - ParticipantDetails?: ParticipantDetails | undefined; - - /** - *

A chat message.

- * @public - */ - InitialSystemMessage?: ChatMessage | undefined; - - /** - *

The unique identifier for an Amazon Connect contact. This identifier is related to the - * contact starting.

- * @public - */ - RelatedContactId?: string | undefined; - - /** - *

The supported chat message content types. Supported types are:

- *
    - *
  • - *

    - * text/plain - *

    - *
    • - *
  • - *

    - * text/markdown - *

    - *
    • - *
  • - *

    - * application/json, - * application/vnd.amazonaws.connect.message.interactive - *

    - *
    • - *
  • - *

    - * application/vnd.amazonaws.connect.message.interactive.response - *

    - *
    • - *
- *

Content types must always contain text/plain. You can then put any other - * supported type in the list. For example, all the following lists are valid because they contain - * text/plain:

- *
    - *
  • - *

    - * [text/plain, text/markdown, application/json] - *

    - *
    • - *
  • - *

    - * [text/markdown, text/plain] - *

    - *
    • - *
  • - *

    - * [text/plain, application/json, - * application/vnd.amazonaws.connect.message.interactive.response] - *

    - *
    • - *
- * @public - */ - SupportedMessagingContentTypes?: string[] | undefined; - - /** - *

A unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. If not provided, the AWS SDK populates this field. For more information about - * idempotency, see Making - * retries safe with idempotent APIs. The token is valid for 7 days after creation. If a - * contact is already started, the contact ID is returned.

- * @public - */ - ClientToken?: string | undefined; -} - -/** - * @public - */ -export interface StartOutboundChatContactResponse { - /** - *

The identifier of this contact within the Amazon Connect instance.

- * @public - */ - ContactId?: string | undefined; -} - -/** - * @public - */ -export interface StartOutboundEmailContactRequest { - /** - *

- * @public - */ - InstanceId: string | undefined; - - /** - *

- * @public - */ - ContactId: string | undefined; - - /** - *

- * @public - */ - FromEmailAddress?: EmailAddressInfo | undefined; - - /** - *

- * @public - */ - DestinationEmailAddress: EmailAddressInfo | undefined; - - /** - *

- * @public - */ - AdditionalRecipients?: OutboundAdditionalRecipients | undefined; - - /** - *

- * @public - */ - EmailMessage: OutboundEmailContent | undefined; - - /** - *

- * @public - */ - ClientToken?: string | undefined; -} - -/** - * @public - */ -export interface StartOutboundEmailContactResponse { - /** - *

- * @public - */ - ContactId?: string | undefined; -} - -/** - *

Outbound calls to the destination number are not allowed.

- * @public - */ -export class DestinationNotAllowedException extends __BaseException { - readonly name: "DestinationNotAllowedException" = "DestinationNotAllowedException"; - readonly $fault: "client" = "client"; - /** - *

The message about the outbound calls.

- * @public - */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "DestinationNotAllowedException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, DestinationNotAllowedException.prototype); - this.Message = opts.Message; - } -} - -/** - *

The contact is not permitted.

- * @public - */ -export class OutboundContactNotPermittedException extends __BaseException { - readonly name: "OutboundContactNotPermittedException" = "OutboundContactNotPermittedException"; - readonly $fault: "client" = "client"; - /** - *

The message about the contact.

- * @public - */ - Message?: string | undefined; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "OutboundContactNotPermittedException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, OutboundContactNotPermittedException.prototype); - this.Message = opts.Message; - } -} - -/** - *

Configuration of the answering machine detection.

- * @public - */ -export interface AnswerMachineDetectionConfig { - /** - *

The flag to indicate if answer machine detection analysis needs to be performed for a voice - * call. If set to true, TrafficType must be set as CAMPAIGN. - *

- * @public - */ - EnableAnswerMachineDetection?: boolean | undefined; - - /** - *

Wait for the answering machine prompt.

- * @public - */ - AwaitAnswerMachinePrompt?: boolean | undefined; -} - -/** - * @public - */ -export interface StartOutboundVoiceContactRequest { - /** - *

The name of a voice contact that is shown to an agent in the Contact Control Panel - * (CCP).

- * @public - */ - Name?: string | undefined; - - /** - *

A description of the voice contact that is shown to an agent in the Contact Control Panel - * (CCP).

- * @public - */ - Description?: string | undefined; + Description?: string | undefined; /** *

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can @@ -5375,133 +4966,25 @@ export interface StartScreenSharingResponse {} /** * @public */ -export interface StartTaskContactRequest { +export interface StartTaskContactResponse { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The identifier of this contact within the Amazon Connect instance.

* @public */ - InstanceId: string | undefined; + ContactId?: string | undefined; +} +/** + * @public + */ +export interface StartWebRTCContactRequest { /** - *

The identifier of the previous chat, voice, or task contact. Any updates to user-defined - * attributes to task contacts linked using the same PreviousContactID will affect - * every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

+ *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

+ *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, -, and _ characters.

* @public */ - PreviousContactId?: string | undefined; - - /** - *

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, - * on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose - * Show additional flow information. The ContactFlowId is the last - * part of the ARN, shown here in bold:

- *

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx - *

- * @public - */ - ContactFlowId?: string | undefined; - - /** - *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

- *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys - * can include only alphanumeric, dash, and underscore characters.

- * @public - */ - Attributes?: Record | undefined; - - /** - *

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

- * @public - */ - Name: string | undefined; - - /** - *

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have - * the following reference types at the time of creation: URL | NUMBER | - * STRING | DATE | EMAIL. ATTACHMENT is not a - * supported reference type during task creation.

- * @public - */ - References?: Record | undefined; - - /** - *

A description of the task that is shown to an agent in the Contact Control Panel - * (CCP).

- * @public - */ - Description?: string | undefined; - - /** - *

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 - * Making retries safe with idempotent APIs.

- * @public - */ - ClientToken?: string | undefined; - - /** - *

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

- * @public - */ - ScheduledTime?: Date | undefined; - - /** - *

A unique identifier for the task template. For more information about task templates, see Create task templates in the - * Amazon Connect Administrator Guide.

- * @public - */ - TaskTemplateId?: string | undefined; - - /** - *

The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the - * flow that is defined on agent or queue quick connect. For more information about quick connects, - * see Create quick - * connects.

- * @public - */ - QuickConnectId?: string | undefined; - - /** - *

The contactId that is related to this contact. Linking - * tasks together by using RelatedContactID copies over contact attributes from the - * related task contact to the new task contact. All updates to user-defined attributes in the new - * task contact are limited to the individual contact ID, unlike what happens when tasks are linked - * by using PreviousContactID. There are no limits to the number of contacts that can - * be linked by using RelatedContactId.

- * @public - */ - RelatedContactId?: string | undefined; - - /** - *

- * @public - */ - SegmentAttributes?: Record | undefined; -} - -/** - * @public - */ -export interface StartTaskContactResponse { - /** - *

The identifier of this contact within the Amazon Connect instance.

- * @public - */ - ContactId?: string | undefined; -} - -/** - * @public - */ -export interface StartWebRTCContactRequest { - /** - *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

- *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys - * can include only alphanumeric, -, and _ characters.

- * @public - */ - Attributes?: Record | undefined; + Attributes?: Record | undefined; /** *

A unique, case-sensitive identifier that you provide to ensure the idempotency of the @@ -6213,48 +5696,6 @@ export interface UpdateAuthenticationProfileRequest { PeriodicSessionDuration?: number | undefined; } -/** - * @public - */ -export interface UpdateContactRequest { - /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

- * @public - */ - InstanceId: string | undefined; - - /** - *

The identifier of the contact. This is the identifier of the contact associated with the - * first interaction with your contact center.

- * @public - */ - ContactId: string | undefined; - - /** - *

The name of the contact.

- * @public - */ - Name?: string | undefined; - - /** - *

The description of the contact.

- * @public - */ - Description?: string | undefined; - - /** - *

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

- * @public - */ - References?: Record | undefined; - - /** - *

- * @public - */ - SegmentAttributes?: Record | undefined; -} - /** * @public */ @@ -6577,31 +6018,34 @@ export interface UpdateContactScheduleResponse {} */ export interface UpdateEmailAddressMetadataRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId: string | undefined; /** - *

+ *

The description of the email address.

* @public */ Description?: string | undefined; /** - *

+ *

The display name of email address.

* @public */ DisplayName?: string | undefined; /** - *

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ ClientToken?: string | undefined; @@ -6612,13 +6056,13 @@ export interface UpdateEmailAddressMetadataRequest { */ export interface UpdateEmailAddressMetadataResponse { /** - *

+ *

The identifier of the email address.

* @public */ EmailAddressId?: string | undefined; /** - *

+ *

The Amazon Resource Name (ARN) of the email address.

* @public */ EmailAddressArn?: string | undefined; @@ -6989,80 +6433,423 @@ export interface UpdatePhoneNumberRequest { * Making retries safe with idempotent APIs.

* @public */ - ClientToken?: string | undefined; + ClientToken?: string | undefined; +} + +/** + * @public + */ +export interface UpdatePhoneNumberResponse { + /** + *

A unique identifier for the phone number.

+ * @public + */ + PhoneNumberId?: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the phone number.

+ * @public + */ + PhoneNumberArn?: string | undefined; +} + +/** + * @public + */ +export interface UpdatePhoneNumberMetadataRequest { + /** + *

The Amazon Resource Name (ARN) or resource ID of the phone number.

+ * @public + */ + PhoneNumberId: string | undefined; + + /** + *

The description of the phone number.

+ * @public + */ + PhoneNumberDescription?: string | undefined; + + /** + *

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 + * Making retries safe with idempotent APIs.

+ * @public + */ + ClientToken?: string | undefined; +} + +/** + * @public + */ +export interface UpdatePredefinedAttributeRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource + * Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The name of the predefined attribute.

+ * @public + */ + Name: string | undefined; + + /** + *

The values of the predefined attribute.

+ * @public + */ + Values?: PredefinedAttributeValues | undefined; +} + +/** + * @public + */ +export interface UpdatePromptRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

A unique identifier for the prompt.

+ * @public + */ + PromptId: string | undefined; + + /** + *

The name of the prompt.

+ * @public + */ + Name?: string | undefined; + + /** + *

A description of the prompt.

+ * @public + */ + Description?: string | undefined; + + /** + *

The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the + * GetPromptFile + * API instead of providing S3 URIs.

+ * @public + */ + S3Uri?: string | undefined; +} + +/** + * @public + */ +export interface UpdatePromptResponse { + /** + *

The Amazon Resource Name (ARN) of the prompt.

+ * @public + */ + PromptARN?: string | undefined; + + /** + *

A unique identifier for the prompt.

+ * @public + */ + PromptId?: string | undefined; +} + +/** + * @public + */ +export interface UpdateQueueHoursOfOperationRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the queue.

+ * @public + */ + QueueId: string | undefined; + + /** + *

The identifier for the hours of operation.

+ * @public + */ + HoursOfOperationId: string | undefined; +} + +/** + * @public + */ +export interface UpdateQueueMaxContactsRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the queue.

+ * @public + */ + QueueId: string | undefined; + + /** + *

The maximum number of contacts that can be in the queue before it is considered full.

+ * @public + */ + MaxContacts?: number | undefined; +} + +/** + * @public + */ +export interface UpdateQueueNameRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the queue.

+ * @public + */ + QueueId: string | undefined; + + /** + *

The name of the queue.

+ * @public + */ + Name?: string | undefined; + + /** + *

The description of the queue.

+ * @public + */ + Description?: string | undefined; +} + +/** + * @public + */ +export interface UpdateQueueOutboundCallerConfigRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the queue.

+ * @public + */ + QueueId: string | undefined; + + /** + *

The outbound caller ID name, number, and outbound whisper flow.

+ * @public + */ + OutboundCallerConfig: OutboundCallerConfig | undefined; +} + +/** + *

A conditional check failed.

+ * @public + */ +export class ConditionalOperationFailedException extends __BaseException { + readonly name: "ConditionalOperationFailedException" = "ConditionalOperationFailedException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ConditionalOperationFailedException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ConditionalOperationFailedException.prototype); + this.Message = opts.Message; + } +} + +/** + * @public + */ +export interface UpdateQueueOutboundEmailConfigRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the queue.

+ * @public + */ + QueueId: string | undefined; + + /** + *

The outbound email address ID for a specified queue.

+ * @public + */ + OutboundEmailConfig: OutboundEmailConfig | undefined; +} + +/** + * @public + */ +export interface UpdateQueueStatusRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the queue.

+ * @public + */ + QueueId: string | undefined; + + /** + *

The status of the queue.

+ * @public + */ + Status: QueueStatus | undefined; +} + +/** + * @public + */ +export interface UpdateQuickConnectConfigRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the quick connect.

+ * @public + */ + QuickConnectId: string | undefined; + + /** + *

Information about the configuration settings for the quick connect.

+ * @public + */ + QuickConnectConfig: QuickConnectConfig | undefined; +} + +/** + * @public + */ +export interface UpdateQuickConnectNameRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier for the quick connect.

+ * @public + */ + QuickConnectId: string | undefined; + + /** + *

The name of the quick connect.

+ * @public + */ + Name?: string | undefined; + + /** + *

The description of the quick connect.

+ * @public + */ + Description?: string | undefined; } /** * @public */ -export interface UpdatePhoneNumberResponse { +export interface UpdateRoutingProfileAgentAvailabilityTimerRequest { /** - *

A unique identifier for the phone number.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - PhoneNumberId?: string | undefined; + InstanceId: string | undefined; /** - *

The Amazon Resource Name (ARN) of the phone number.

+ *

The identifier of the routing profile.

* @public */ - PhoneNumberArn?: string | undefined; + RoutingProfileId: string | undefined; + + /** + *

Whether agents with this routing profile will have their routing order calculated based on + * time since their last inbound contact or longest idle + * time.

+ * @public + */ + AgentAvailabilityTimer: AgentAvailabilityTimer | undefined; } /** * @public */ -export interface UpdatePhoneNumberMetadataRequest { +export interface UpdateRoutingProfileConcurrencyRequest { /** - *

The Amazon Resource Name (ARN) or resource ID of the phone number.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - PhoneNumberId: string | undefined; + InstanceId: string | undefined; /** - *

The description of the phone number.

+ *

The identifier of the routing profile.

* @public */ - PhoneNumberDescription?: string | undefined; + RoutingProfileId: string | undefined; /** - *

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 - * Making retries safe with idempotent APIs.

+ *

The channels that agents can handle in the Contact Control Panel (CCP).

* @public */ - ClientToken?: string | undefined; + MediaConcurrencies: MediaConcurrency[] | undefined; } /** * @public */ -export interface UpdatePredefinedAttributeRequest { +export interface UpdateRoutingProfileDefaultOutboundQueueRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource - * Name (ARN) of the instance.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

The name of the predefined attribute.

+ *

The identifier of the routing profile.

* @public */ - Name: string | undefined; + RoutingProfileId: string | undefined; /** - *

The values of the predefined attribute.

+ *

The identifier for the default outbound queue.

* @public */ - Values?: PredefinedAttributeValues | undefined; + DefaultOutboundQueueId: string | undefined; } /** * @public */ -export interface UpdatePromptRequest { +export interface UpdateRoutingProfileNameRequest { /** *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public @@ -7070,53 +6857,59 @@ export interface UpdatePromptRequest { InstanceId: string | undefined; /** - *

A unique identifier for the prompt.

+ *

The identifier of the routing profile.

* @public */ - PromptId: string | undefined; + RoutingProfileId: string | undefined; /** - *

The name of the prompt.

+ *

The name of the routing profile. Must not be more than 127 characters.

* @public */ Name?: string | undefined; /** - *

A description of the prompt.

+ *

The description of the routing profile. Must not be more than 250 characters.

* @public */ Description?: string | undefined; - - /** - *

The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the - * GetPromptFile - * API instead of providing S3 URIs.

- * @public - */ - S3Uri?: string | undefined; } /** * @public */ -export interface UpdatePromptResponse { +export interface UpdateRoutingProfileQueuesRequest { /** - *

The Amazon Resource Name (ARN) of the prompt.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - PromptARN?: string | undefined; + InstanceId: string | undefined; /** - *

A unique identifier for the prompt.

+ *

The identifier of the routing profile.

* @public */ - PromptId?: string | undefined; + RoutingProfileId: string | undefined; + + /** + *

The queues to be updated for this routing profile. + * Queues must first be associated to the routing + * profile. You can do this using AssociateRoutingProfileQueues.

+ * @public + */ + QueueConfigs: RoutingProfileQueueConfig[] | undefined; } /** * @public */ -export interface UpdateQueueHoursOfOperationRequest { +export interface UpdateRuleRequest { + /** + *

A unique identifier for the rule.

+ * @public + */ + RuleId: string | undefined; + /** *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public @@ -7124,45 +6917,56 @@ export interface UpdateQueueHoursOfOperationRequest { InstanceId: string | undefined; /** - *

The identifier for the queue.

+ *

The name of the rule. You can change the name only if TriggerEventSource is one + * of the following values: OnZendeskTicketCreate | + * OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate + *

* @public */ - QueueId: string | undefined; + Name: string | undefined; /** - *

The identifier for the hours of operation.

+ *

The conditions of the rule.

* @public */ - HoursOfOperationId: string | undefined; + Function: string | undefined; + + /** + *

A list of actions to be run when the rule is triggered.

+ * @public + */ + Actions: RuleAction[] | undefined; + + /** + *

The publish status of the rule.

+ * @public + */ + PublishStatus: RulePublishStatus | undefined; } /** * @public */ -export interface UpdateQueueMaxContactsRequest { +export interface UpdateSecurityProfileRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The description of the security profile.

* @public */ - InstanceId: string | undefined; + Description?: string | undefined; /** - *

The identifier for the queue.

+ *

The permissions granted to a security profile. For a list of valid permissions, see List of security + * profile permissions.

* @public */ - QueueId: string | undefined; + Permissions?: string[] | undefined; /** - *

The maximum number of contacts that can be in the queue before it is considered full.

+ *

The identifier for the security profle.

* @public */ - MaxContacts?: number | undefined; -} + SecurityProfileId: string | undefined; -/** - * @public - */ -export interface UpdateQueueNameRequest { /** *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public @@ -7170,1050 +6974,1067 @@ export interface UpdateQueueNameRequest { InstanceId: string | undefined; /** - *

The identifier for the queue.

+ *

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

* @public */ - QueueId: string | undefined; + AllowedAccessControlTags?: Record | undefined; /** - *

The name of the queue.

+ *

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

* @public */ - Name?: string | undefined; + TagRestrictedResources?: string[] | undefined; /** - *

The description of the queue.

+ *

A list of the third-party application's metadata.

* @public */ - Description?: string | undefined; + Applications?: Application[] | undefined; + + /** + *

The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

+ * @public + */ + HierarchyRestrictedResources?: string[] | undefined; + + /** + *

The identifier of the hierarchy group that a security profile uses to restrict access to + * resources in Amazon Connect.

+ * @public + */ + AllowedAccessControlHierarchyGroupId?: string | undefined; } /** * @public */ -export interface UpdateQueueOutboundCallerConfigRequest { +export interface UpdateTaskTemplateRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

A unique identifier for the task template.

* @public */ - InstanceId: string | undefined; + TaskTemplateId: string | undefined; /** - *

The identifier for the queue.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - QueueId: string | undefined; + InstanceId: string | undefined; /** - *

The outbound caller ID name, number, and outbound whisper flow.

+ *

The name of the task template.

* @public */ - OutboundCallerConfig: OutboundCallerConfig | undefined; -} + Name?: string | undefined; -/** - *

- * @public - */ -export class ConditionalOperationFailedException extends __BaseException { - readonly name: "ConditionalOperationFailedException" = "ConditionalOperationFailedException"; - readonly $fault: "client" = "client"; - Message?: string | undefined; /** - * @internal + *

The description of the task template.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ConditionalOperationFailedException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, ConditionalOperationFailedException.prototype); - this.Message = opts.Message; - } -} + Description?: string | undefined; -/** - * @public - */ -export interface UpdateQueueOutboundEmailConfigRequest { /** - *

+ *

The identifier of the flow that runs by default when a task is created by referencing this template.

* @public */ - InstanceId: string | undefined; + ContactFlowId?: string | undefined; /** - *

+ *

The ContactFlowId for the flow that will be run if this template is used to create a + * self-assigned task.

* @public */ - QueueId: string | undefined; + SelfAssignFlowId?: string | undefined; /** - *

+ *

Constraints that are applicable to the fields listed.

* @public */ - OutboundEmailConfig: OutboundEmailConfig | undefined; -} + Constraints?: TaskTemplateConstraints | undefined; -/** - * @public - */ -export interface UpdateQueueStatusRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The default values for fields when a task is created by referencing this template.

* @public */ - InstanceId: string | undefined; + Defaults?: TaskTemplateDefaults | undefined; /** - *

The identifier for the queue.

+ *

Marks a template as ACTIVE or INACTIVE for a task to refer to it. + * Tasks can only be created from ACTIVE templates. + * If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

* @public */ - QueueId: string | undefined; + Status?: TaskTemplateStatus | undefined; /** - *

The status of the queue.

+ *

Fields that are part of the template.

* @public */ - Status: QueueStatus | undefined; + Fields?: TaskTemplateField[] | undefined; } /** * @public */ -export interface UpdateQuickConnectConfigRequest { +export interface UpdateTaskTemplateResponse { /** *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - InstanceId: string | undefined; + InstanceId?: string | undefined; /** - *

The identifier for the quick connect.

+ *

The identifier of the task template resource.

* @public */ - QuickConnectId: string | undefined; + Id?: string | undefined; /** - *

Information about the configuration settings for the quick connect.

+ *

The Amazon Resource Name (ARN) for the task template resource.

* @public */ - QuickConnectConfig: QuickConnectConfig | undefined; -} + Arn?: string | undefined; -/** - * @public - */ -export interface UpdateQuickConnectNameRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The name of the task template.

* @public */ - InstanceId: string | undefined; + Name?: string | undefined; /** - *

The identifier for the quick connect.

+ *

The description of the task template.

* @public */ - QuickConnectId: string | undefined; + Description?: string | undefined; /** - *

The name of the quick connect.

+ *

The identifier of the flow that runs by default when a task is created by referencing this template.

* @public */ - Name?: string | undefined; + ContactFlowId?: string | undefined; /** - *

The description of the quick connect.

+ *

The ContactFlowId for the flow that will be run if this template is used to create a + * self-assigned task.

* @public */ - Description?: string | undefined; -} + SelfAssignFlowId?: string | undefined; -/** - * @public - */ -export interface UpdateRoutingProfileAgentAvailabilityTimerRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

Constraints that are applicable to the fields listed.

* @public */ - InstanceId: string | undefined; + Constraints?: TaskTemplateConstraints | undefined; /** - *

The identifier of the routing profile.

+ *

The default values for fields when a task is created by referencing this template.

* @public */ - RoutingProfileId: string | undefined; + Defaults?: TaskTemplateDefaults | undefined; /** - *

Whether agents with this routing profile will have their routing order calculated based on - * time since their last inbound contact or longest idle - * time.

+ *

Fields that are part of the template.

* @public */ - AgentAvailabilityTimer: AgentAvailabilityTimer | undefined; -} + Fields?: TaskTemplateField[] | undefined; -/** - * @public - */ -export interface UpdateRoutingProfileConcurrencyRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

Marks a template as ACTIVE or INACTIVE for a task to refer to it. + * Tasks can only be created from ACTIVE templates. + * If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

* @public */ - InstanceId: string | undefined; + Status?: TaskTemplateStatus | undefined; /** - *

The identifier of the routing profile.

+ *

The timestamp when the task template was last modified.

* @public */ - RoutingProfileId: string | undefined; + LastModifiedTime?: Date | undefined; /** - *

The channels that agents can handle in the Contact Control Panel (CCP).

+ *

The timestamp when the task template was created.

* @public */ - MediaConcurrencies: MediaConcurrency[] | undefined; + CreatedTime?: Date | undefined; } /** * @public */ -export interface UpdateRoutingProfileDefaultOutboundQueueRequest { +export interface UpdateTrafficDistributionRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The identifier of the traffic distribution group. + * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. + * The ARN must be provided if the call is from the replicated Region.

* @public */ - InstanceId: string | undefined; + Id: string | undefined; /** - *

The identifier of the routing profile.

+ *

The distribution of traffic between the instance and its replica(s).

* @public */ - RoutingProfileId: string | undefined; + TelephonyConfig?: TelephonyConfig | undefined; /** - *

The identifier for the default outbound queue.

+ *

The distribution that determines which Amazon Web Services Regions should be used to sign in + * agents in to both the instance and its replica(s).

* @public */ - DefaultOutboundQueueId: string | undefined; + SignInConfig?: SignInConfig | undefined; + + /** + *

The distribution of agents between the instance and its replica(s).

+ * @public + */ + AgentConfig?: AgentConfig | undefined; } /** * @public */ -export interface UpdateRoutingProfileNameRequest { - /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

- * @public - */ - InstanceId: string | undefined; +export interface UpdateTrafficDistributionResponse {} +/** + * @public + */ +export interface UpdateUserHierarchyRequest { /** - *

The identifier of the routing profile.

+ *

The identifier of the hierarchy group.

* @public */ - RoutingProfileId: string | undefined; + HierarchyGroupId?: string | undefined; /** - *

The name of the routing profile. Must not be more than 127 characters.

+ *

The identifier of the user account.

* @public */ - Name?: string | undefined; + UserId: string | undefined; /** - *

The description of the routing profile. Must not be more than 250 characters.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - Description?: string | undefined; + InstanceId: string | undefined; } /** * @public */ -export interface UpdateRoutingProfileQueuesRequest { +export interface UpdateUserHierarchyGroupNameRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The name of the hierarchy group. Must not be more than 100 characters.

* @public */ - InstanceId: string | undefined; + Name: string | undefined; /** - *

The identifier of the routing profile.

+ *

The identifier of the hierarchy group.

* @public */ - RoutingProfileId: string | undefined; + HierarchyGroupId: string | undefined; /** - *

The queues to be updated for this routing profile. - * Queues must first be associated to the routing - * profile. You can do this using AssociateRoutingProfileQueues.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - QueueConfigs: RoutingProfileQueueConfig[] | undefined; + InstanceId: string | undefined; } /** + *

Contains information about the hierarchy level to update.

* @public */ -export interface UpdateRuleRequest { +export interface HierarchyLevelUpdate { /** - *

A unique identifier for the rule.

+ *

The name of the user hierarchy level. Must not be more than 50 characters.

* @public */ - RuleId: string | undefined; + Name: string | undefined; +} +/** + *

Contains information about the level hierarchy to update.

+ * @public + */ +export interface HierarchyStructureUpdate { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The + * update + * for level one.

* @public */ - InstanceId: string | undefined; + LevelOne?: HierarchyLevelUpdate | undefined; /** - *

The name of the rule. You can change the name only if TriggerEventSource is one - * of the following values: OnZendeskTicketCreate | - * OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate - *

+ *

The update for level two.

* @public */ - Name: string | undefined; + LevelTwo?: HierarchyLevelUpdate | undefined; /** - *

The conditions of the rule.

+ *

The update for level three.

* @public */ - Function: string | undefined; + LevelThree?: HierarchyLevelUpdate | undefined; /** - *

A list of actions to be run when the rule is triggered.

+ *

The update for level four.

* @public */ - Actions: RuleAction[] | undefined; + LevelFour?: HierarchyLevelUpdate | undefined; /** - *

The publish status of the rule.

+ *

The update for level five.

* @public */ - PublishStatus: RulePublishStatus | undefined; + LevelFive?: HierarchyLevelUpdate | undefined; } /** * @public */ -export interface UpdateSecurityProfileRequest { +export interface UpdateUserHierarchyStructureRequest { /** - *

The description of the security profile.

+ *

The hierarchy levels to update.

* @public */ - Description?: string | undefined; + HierarchyStructure: HierarchyStructureUpdate | undefined; /** - *

The permissions granted to a security profile. For a list of valid permissions, see List of security - * profile permissions.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - Permissions?: string[] | undefined; + InstanceId: string | undefined; +} +/** + * @public + */ +export interface UpdateUserIdentityInfoRequest { /** - *

The identifier for the security profle.

+ *

The identity information for the user.

* @public */ - SecurityProfileId: string | undefined; + IdentityInfo: UserIdentityInfo | undefined; + + /** + *

The identifier of the user account.

+ * @public + */ + UserId: string | undefined; /** *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; +} +/** + * @public + */ +export interface UpdateUserPhoneConfigRequest { /** - *

The list of tags that a security profile uses to restrict access to resources in Amazon Connect.

+ *

Information about phone configuration settings for the user.

* @public */ - AllowedAccessControlTags?: Record | undefined; + PhoneConfig: UserPhoneConfig | undefined; /** - *

The list of resources that a security profile applies tag restrictions to in Amazon Connect.

+ *

The identifier of the user account.

* @public */ - TagRestrictedResources?: string[] | undefined; + UserId: string | undefined; /** - *

A list of the third-party application's metadata.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - Applications?: Application[] | undefined; + InstanceId: string | undefined; +} +/** + * @public + */ +export interface UpdateUserProficienciesRequest { /** - *

The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource + * Name (ARN) of the instance.

* @public */ - HierarchyRestrictedResources?: string[] | undefined; + InstanceId: string | undefined; /** - *

The identifier of the hierarchy group that a security profile uses to restrict access to - * resources in Amazon Connect.

+ *

The identifier of the user account.

* @public */ - AllowedAccessControlHierarchyGroupId?: string | undefined; + UserId: string | undefined; + + /** + *

The proficiencies to be updated for the user. Proficiencies must first be associated to the + * user. You can do this using AssociateUserProficiencies API.

+ * @public + */ + UserProficiencies: UserProficiency[] | undefined; } /** * @public */ -export interface UpdateTaskTemplateRequest { +export interface UpdateUserRoutingProfileRequest { /** - *

A unique identifier for the task template.

+ *

The identifier of the routing profile for the user.

* @public */ - TaskTemplateId: string | undefined; + RoutingProfileId: string | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The identifier of the user account.

* @public */ - InstanceId: string | undefined; + UserId: string | undefined; /** - *

The name of the task template.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - Name?: string | undefined; + InstanceId: string | undefined; +} +/** + * @public + */ +export interface UpdateUserSecurityProfilesRequest { /** - *

The description of the task template.

+ *

The identifiers of the security profiles for the user.

* @public */ - Description?: string | undefined; + SecurityProfileIds: string[] | undefined; /** - *

The identifier of the flow that runs by default when a task is created by referencing this template.

+ *

The identifier of the user account.

* @public */ - ContactFlowId?: string | undefined; + UserId: string | undefined; /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - SelfAssignFlowId?: string | undefined; + InstanceId: string | undefined; +} +/** + * @public + */ +export interface UpdateViewContentRequest { /** - *

Constraints that are applicable to the fields listed.

+ *

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.

* @public */ - Constraints?: TaskTemplateConstraints | undefined; + InstanceId: string | undefined; /** - *

The default values for fields when a task is created by referencing this template.

+ *

The identifier of the view. Both ViewArn and ViewId can be + * used.

* @public */ - Defaults?: TaskTemplateDefaults | undefined; + ViewId: string | undefined; /** - *

Marks a template as ACTIVE or INACTIVE for a task to refer to it. - * Tasks can only be created from ACTIVE templates. - * If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

+ *

Indicates the view status as either SAVED or PUBLISHED. The + * PUBLISHED status will initiate validation on the content.

* @public */ - Status?: TaskTemplateStatus | undefined; + Status: ViewStatus | undefined; /** - *

Fields that are part of the template.

+ *

View content containing all content necessary to render a view except for runtime input data + * and the runtime input schema, which is auto-generated by this operation.

+ *

The total uncompressed content has a maximum file size of 400kB.

* @public */ - Fields?: TaskTemplateField[] | undefined; + Content: ViewInputContent | undefined; } /** * @public */ -export interface UpdateTaskTemplateResponse { +export interface UpdateViewContentResponse { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

A view resource object. Contains metadata and content necessary to render the view.

* @public */ - InstanceId?: string | undefined; + View?: View | undefined; +} +/** + * @public + */ +export interface UpdateViewMetadataRequest { /** - *

The identifier of the task template resource.

+ *

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.

* @public */ - Id?: string | undefined; + InstanceId: string | undefined; /** - *

The Amazon Resource Name (ARN) for the task template resource.

+ *

The identifier of the view. Both ViewArn and ViewId can be + * used.

* @public */ - Arn?: string | undefined; + ViewId: string | undefined; /** - *

The name of the task template.

+ *

The name of the view.

* @public */ Name?: string | undefined; /** - *

The description of the task template.

+ *

The description of the view.

* @public */ Description?: string | undefined; +} - /** - *

The identifier of the flow that runs by default when a task is created by referencing this template.

- * @public - */ - ContactFlowId?: string | undefined; +/** + * @public + */ +export interface UpdateViewMetadataResponse {} +/** + *

A value for a segment attribute. This is structured as a map where the key is + * valueString and the value is a string.

+ * @public + */ +export interface SegmentAttributeValue { /** - *

+ *

The value of a segment attribute.

* @public */ - SelfAssignFlowId?: string | undefined; + ValueString?: string | undefined; /** - *

Constraints that are applicable to the fields listed.

+ *

The value of a segment attribute.

* @public */ - Constraints?: TaskTemplateConstraints | undefined; + ValueMap?: Record | undefined; /** - *

The default values for fields when a task is created by referencing this template.

+ *

The value of a segment attribute.

* @public */ - Defaults?: TaskTemplateDefaults | undefined; + ValueInteger?: number | undefined; +} - /** - *

Fields that are part of the template.

- * @public - */ - Fields?: TaskTemplateField[] | undefined; +/** + *

Information about an item from an evaluation form. The item must be either a section or a + * question.

+ * @public + */ +export type EvaluationFormItem = + | EvaluationFormItem.QuestionMember + | EvaluationFormItem.SectionMember + | EvaluationFormItem.$UnknownMember; +/** + * @public + */ +export namespace EvaluationFormItem { /** - *

Marks a template as ACTIVE or INACTIVE for a task to refer to it. - * Tasks can only be created from ACTIVE templates. - * If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

+ *

The information of the section.

* @public */ - Status?: TaskTemplateStatus | undefined; + export interface SectionMember { + Section: EvaluationFormSection; + Question?: never; + $unknown?: never; + } /** - *

The timestamp when the task template was last modified.

+ *

The information of the question.

* @public */ - LastModifiedTime?: Date | undefined; + export interface QuestionMember { + Section?: never; + Question: EvaluationFormQuestion; + $unknown?: never; + } /** - *

The timestamp when the task template was created.

* @public */ - CreatedTime?: Date | undefined; + export interface $UnknownMember { + Section?: never; + Question?: never; + $unknown: [string, any]; + } + + export interface Visitor { + Section: (value: EvaluationFormSection) => T; + Question: (value: EvaluationFormQuestion) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: EvaluationFormItem, visitor: Visitor): T => { + if (value.Section !== undefined) return visitor.Section(value.Section); + if (value.Question !== undefined) return visitor.Question(value.Question); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** + *

Information about a section from an evaluation form. A section can contain sections and/or + * questions. Evaluation forms can only contain sections and subsections (two level nesting).

* @public */ -export interface UpdateTrafficDistributionRequest { +export interface EvaluationFormSection { /** - *

The identifier of the traffic distribution group. - * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. - * The ARN must be provided if the call is from the replicated Region.

+ *

The title of the section.

* @public */ - Id: string | undefined; + Title: string | undefined; /** - *

The distribution of traffic between the instance and its replica(s).

+ *

The identifier of the section. An identifier must be unique within the evaluation + * form.

* @public */ - TelephonyConfig?: TelephonyConfig | undefined; + RefId: string | undefined; /** - *

The distribution that determines which Amazon Web Services Regions should be used to sign in - * agents in to both the instance and its replica(s).

+ *

The instructions of the section.

* @public */ - SignInConfig?: SignInConfig | undefined; + Instructions?: string | undefined; /** - *

The distribution of agents between the instance and its replica(s).

+ *

The items of the section.

* @public */ - AgentConfig?: AgentConfig | undefined; -} + Items: EvaluationFormItem[] | undefined; -/** - * @public - */ -export interface UpdateTrafficDistributionResponse {} + /** + *

The scoring weight of the section.

+ * @public + */ + Weight?: number | undefined; +} /** + *

The search criteria to be used to return agent statuses.

* @public */ -export interface UpdateUserHierarchyRequest { +export interface AgentStatusSearchCriteria { /** - *

The identifier of the hierarchy group.

+ *

A list of conditions which would be applied together with an OR + * condition.

* @public */ - HierarchyGroupId?: string | undefined; + OrConditions?: AgentStatusSearchCriteria[] | undefined; /** - *

The identifier of the user account.

+ *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are name, + * description, state, type, displayOrder, + * and resourceID.

+ * * @public */ - UserId: string | undefined; + AndConditions?: AgentStatusSearchCriteria[] | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are name, + * description, state, type, displayOrder, + * and resourceID.

+ * * @public */ - InstanceId: string | undefined; + StringCondition?: StringCondition | undefined; } /** + *

The search criteria to be used to return flow modules.

* @public */ -export interface UpdateUserHierarchyGroupNameRequest { +export interface ContactFlowModuleSearchCriteria { /** - *

The name of the hierarchy group. Must not be more than 100 characters.

+ *

A list of conditions which would be applied together with an OR + * condition.

* @public */ - Name: string | undefined; + OrConditions?: ContactFlowModuleSearchCriteria[] | undefined; /** - *

The identifier of the hierarchy group.

+ *

A list of conditions which would be applied together with an AND + * condition.

* @public */ - HierarchyGroupId: string | undefined; + AndConditions?: ContactFlowModuleSearchCriteria[] | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

A leaf node condition which can be used to specify a string condition.

* @public */ - InstanceId: string | undefined; + StringCondition?: StringCondition | undefined; } /** - *

Contains information about the hierarchy level to update.

+ *

The search criteria to be used to return flows.

* @public */ -export interface HierarchyLevelUpdate { +export interface ContactFlowSearchCriteria { /** - *

The name of the user hierarchy level. Must not be more than 50 characters.

+ *

A list of conditions which would be applied together with an OR + * condition.

* @public */ - Name: string | undefined; -} + OrConditions?: ContactFlowSearchCriteria[] | undefined; -/** - *

Contains information about the level hierarchy to update.

- * @public - */ -export interface HierarchyStructureUpdate { /** - *

The - * update - * for level one.

+ *

A list of conditions which would be applied together with an AND + * condition.

* @public */ - LevelOne?: HierarchyLevelUpdate | undefined; + AndConditions?: ContactFlowSearchCriteria[] | undefined; /** - *

The update for level two.

+ *

A leaf node condition which can be used to specify a string condition.

* @public */ - LevelTwo?: HierarchyLevelUpdate | undefined; + StringCondition?: StringCondition | undefined; /** - *

The update for level three.

+ *

The type of flow.

* @public */ - LevelThree?: HierarchyLevelUpdate | undefined; + TypeCondition?: ContactFlowType | undefined; /** - *

The update for level four.

+ *

The state of the flow.

* @public */ - LevelFour?: HierarchyLevelUpdate | undefined; + StateCondition?: ContactFlowState | undefined; /** - *

The update for level five.

+ *

The status of the flow.

* @public */ - LevelFive?: HierarchyLevelUpdate | undefined; + StatusCondition?: ContactFlowStatus | undefined; } /** * @public */ -export interface UpdateUserHierarchyStructureRequest { +export interface CreateContactRequest { /** - *

The hierarchy levels to update.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - HierarchyStructure: HierarchyStructureUpdate | undefined; + InstanceId: string | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ - InstanceId: string | undefined; -} + ClientToken?: string | undefined; -/** - * @public - */ -export interface UpdateUserIdentityInfoRequest { /** - *

The identity information for the user.

+ *

The identifier of the contact in this instance of Amazon Connect.

* @public */ - IdentityInfo: UserIdentityInfo | undefined; + RelatedContactId?: string | undefined; /** - *

The identifier of the user account.

+ *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

+ *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, dash, and underscore characters.

* @public */ - UserId: string | undefined; + Attributes?: Record | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have + * the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | + * ATTACHMENT.

+ * @public + */ + References?: Record | undefined; + + /** + *

The channel for the contact

+ * @public + */ + Channel: Channel | undefined; + + /** + *

Indicates how the contact was initiated.

* @public */ - InstanceId: string | undefined; -} + InitiationMethod: ContactInitiationMethod | undefined; -/** - * @public - */ -export interface UpdateUserPhoneConfigRequest { /** - *

Information about phone configuration settings for the user.

+ *

Number of minutes the contact will be active for before expiring

* @public */ - PhoneConfig: UserPhoneConfig | undefined; + ExpiryDurationInMinutes?: number | undefined; /** - *

The identifier of the user account.

+ *

User details for the contact

* @public */ - UserId: string | undefined; + UserInfo?: UserInfo | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

Initial state of the contact when it's created

* @public */ - InstanceId: string | undefined; -} + InitiateAs?: InitiateAs | undefined; -/** - * @public - */ -export interface UpdateUserProficienciesRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource - * Name (ARN) of the instance.

+ *

The name of a the contact.

* @public */ - InstanceId: string | undefined; + Name?: string | undefined; /** - *

The identifier of the user account.

+ *

A description of the contact.

* @public */ - UserId: string | undefined; + Description?: string | undefined; /** - *

The proficiencies to be updated for the user. Proficiencies must first be associated to the - * user. You can do this using AssociateUserProficiencies API.

+ *

A set of system defined key-value pairs stored on individual contact segments (unique + * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. + * They can be accessed in flows.

+ *

Attribute keys can include only alphanumeric, -, and _.

+ *

This field can be used to set Segment Contact Expiry as a duration in minutes.

+ * + *

To set contact expiry, a ValueMap must be specified containing the integer number of + * minutes the contact will be active for before expiring, with SegmentAttributes like + * \{ "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": + * 135\}\}\}\}.

+ * * @public */ - UserProficiencies: UserProficiency[] | undefined; + SegmentAttributes?: Record | undefined; } /** * @public */ -export interface UpdateUserRoutingProfileRequest { +export interface CreateEvaluationFormRequest { /** - *

The identifier of the routing profile for the user.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - RoutingProfileId: string | undefined; + InstanceId: string | undefined; /** - *

The identifier of the user account.

+ *

A title of the evaluation form.

* @public */ - UserId: string | undefined; + Title: string | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

The description of the evaluation form.

* @public */ - InstanceId: string | undefined; -} + Description?: string | undefined; -/** - * @public - */ -export interface UpdateUserSecurityProfilesRequest { /** - *

The identifiers of the security profiles for the user.

+ *

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

* @public */ - SecurityProfileIds: string[] | undefined; + Items: EvaluationFormItem[] | undefined; /** - *

The identifier of the user account.

+ *

A scoring strategy of the evaluation form.

* @public */ - UserId: string | undefined; + ScoringStrategy?: EvaluationFormScoringStrategy | undefined; /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ - InstanceId: string | undefined; + ClientToken?: string | undefined; } /** + *

The search criteria to be used to return email addresses.

* @public */ -export interface UpdateViewContentRequest { - /** - *

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.

- * @public - */ - InstanceId: string | undefined; - +export interface EmailAddressSearchCriteria { /** - *

The identifier of the view. Both ViewArn and ViewId can be - * used.

+ *

A list of conditions which would be applied together with an OR condition.

* @public */ - ViewId: string | undefined; + OrConditions?: EmailAddressSearchCriteria[] | undefined; /** - *

Indicates the view status as either SAVED or PUBLISHED. The - * PUBLISHED status will initiate validation on the content.

+ *

A list of conditions which would be applied together with an AND condition.

* @public */ - Status: ViewStatus | undefined; + AndConditions?: EmailAddressSearchCriteria[] | undefined; /** - *

View content containing all content necessary to render a view except for runtime input data - * and the runtime input schema, which is auto-generated by this operation.

- *

The total uncompressed content has a maximum file size of 400kB.

+ *

A leaf node condition which can be used to specify a string condition.

* @public */ - Content: ViewInputContent | undefined; + StringCondition?: StringCondition | undefined; } /** + *

Information about the evaluation form.

* @public */ -export interface UpdateViewContentResponse { +export interface EvaluationForm { /** - *

A view resource object. Contains metadata and content necessary to render the view.

+ *

The unique identifier for the evaluation form.

* @public */ - View?: View | undefined; -} + EvaluationFormId: string | undefined; -/** - * @public - */ -export interface UpdateViewMetadataRequest { /** - *

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of - * the instance.

+ *

A version of the evaluation form.

* @public */ - InstanceId: string | undefined; + EvaluationFormVersion: number | undefined; /** - *

The identifier of the view. Both ViewArn and ViewId can be - * used.

+ *

The flag indicating whether the evaluation form is locked for changes.

* @public */ - ViewId: string | undefined; + Locked: boolean | undefined; /** - *

The name of the view.

+ *

The Amazon Resource Name (ARN) for the evaluation form resource.

* @public */ - Name?: string | undefined; + EvaluationFormArn: string | undefined; /** - *

The description of the view.

+ *

A title of the evaluation form.

* @public */ - Description?: string | undefined; -} - -/** - * @public - */ -export interface UpdateViewMetadataResponse {} - -/** - *

Information about an item from an evaluation form. The item must be either a section or a - * question.

- * @public - */ -export type EvaluationFormItem = - | EvaluationFormItem.QuestionMember - | EvaluationFormItem.SectionMember - | EvaluationFormItem.$UnknownMember; + Title: string | undefined; -/** - * @public - */ -export namespace EvaluationFormItem { /** - *

The information of the section.

+ *

The description of the evaluation form.

* @public */ - export interface SectionMember { - Section: EvaluationFormSection; - Question?: never; - $unknown?: never; - } + Description?: string | undefined; /** - *

The information of the question.

+ *

The status of the evaluation form.

* @public */ - export interface QuestionMember { - Section?: never; - Question: EvaluationFormQuestion; - $unknown?: never; - } + Status: EvaluationFormVersionStatus | undefined; /** + *

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

* @public */ - export interface $UnknownMember { - Section?: never; - Question?: never; - $unknown: [string, any]; - } - - export interface Visitor { - Section: (value: EvaluationFormSection) => T; - Question: (value: EvaluationFormQuestion) => T; - _: (name: string, value: any) => T; - } + Items: EvaluationFormItem[] | undefined; - export const visit = (value: EvaluationFormItem, visitor: Visitor): T => { - if (value.Section !== undefined) return visitor.Section(value.Section); - if (value.Question !== undefined) return visitor.Question(value.Question); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + /** + *

A scoring strategy of the evaluation form.

+ * @public + */ + ScoringStrategy?: EvaluationFormScoringStrategy | undefined; -/** - *

Information about a section from an evaluation form. A section can contain sections and/or - * questions. Evaluation forms can only contain sections and subsections (two level nesting).

- * @public - */ -export interface EvaluationFormSection { /** - *

The title of the section.

+ *

The timestamp for when the evaluation form was created.

* @public */ - Title: string | undefined; + CreatedTime: Date | undefined; /** - *

The identifier of the section. An identifier must be unique within the evaluation - * form.

+ *

The Amazon Resource Name (ARN) of the user who created the evaluation form.

* @public */ - RefId: string | undefined; + CreatedBy: string | undefined; /** - *

The instructions of the section.

+ *

The timestamp for when the evaluation form was last updated.

* @public */ - Instructions?: string | undefined; + LastModifiedTime: Date | undefined; /** - *

The items of the section.

+ *

The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

* @public */ - Items: EvaluationFormItem[] | undefined; + LastModifiedBy: string | undefined; /** - *

The scoring weight of the section.

+ *

The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.

* @public */ - Weight?: number | undefined; + Tags?: Record | undefined; } /** - *

The search criteria to be used to return agent statuses.

+ *

Information about an evaluation form used in a contact evaluation.

* @public */ -export interface AgentStatusSearchCriteria { +export interface EvaluationFormContent { /** - *

A list of conditions which would be applied together with an OR - * condition.

+ *

A version of the evaluation form.

* @public */ - OrConditions?: AgentStatusSearchCriteria[] | undefined; + EvaluationFormVersion: number | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

- * - *

The currently supported values for FieldName are name, - * description, state, type, displayOrder, - * and resourceID.

- * + *

The unique identifier for the evaluation form.

* @public */ - AndConditions?: AgentStatusSearchCriteria[] | undefined; + EvaluationFormId: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

- * - *

The currently supported values for FieldName are name, - * description, state, type, displayOrder, - * and resourceID.

- * + *

The Amazon Resource Name (ARN) for the evaluation form resource.

* @public */ - StringCondition?: StringCondition | undefined; -} + EvaluationFormArn: string | undefined; -/** - *

The search criteria to be used to return flow modules.

- * @public - */ -export interface ContactFlowModuleSearchCriteria { /** - *

A list of conditions which would be applied together with an OR - * condition.

+ *

A title of the evaluation form.

* @public */ - OrConditions?: ContactFlowModuleSearchCriteria[] | undefined; + Title: string | undefined; /** - *

A list of conditions which would be applied together with an AND - * condition.

+ *

The description of the evaluation form.

* @public */ - AndConditions?: ContactFlowModuleSearchCriteria[] | undefined; + Description?: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

+ *

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

* @public */ - StringCondition?: StringCondition | undefined; + Items: EvaluationFormItem[] | undefined; + + /** + *

A scoring strategy of the evaluation form.

+ * @public + */ + ScoringStrategy?: EvaluationFormScoringStrategy | undefined; } /** @@ -8470,22 +8291,6 @@ export const InboundEmailContentFilterSensitiveLog = (obj: InboundEmailContent): ...(obj.RawMessage && { RawMessage: InboundRawMessageFilterSensitiveLog(obj.RawMessage) }), }); -/** - * @internal - */ -export const StartEmailContactRequestFilterSensitiveLog = (obj: StartEmailContactRequest): any => ({ - ...obj, - ...(obj.FromEmailAddress && { FromEmailAddress: EmailAddressInfoFilterSensitiveLog(obj.FromEmailAddress) }), - ...(obj.DestinationEmailAddress && { DestinationEmailAddress: SENSITIVE_STRING }), - ...(obj.Description && { Description: SENSITIVE_STRING }), - ...(obj.Name && { Name: SENSITIVE_STRING }), - ...(obj.EmailMessage && { EmailMessage: InboundEmailContentFilterSensitiveLog(obj.EmailMessage) }), - ...(obj.AdditionalRecipients && { - AdditionalRecipients: InboundAdditionalRecipientsFilterSensitiveLog(obj.AdditionalRecipients), - }), - ...(obj.Attachments && { Attachments: SENSITIVE_STRING }), -}); - /** * @internal */ @@ -8510,15 +8315,6 @@ export const StartOutboundVoiceContactRequestFilterSensitiveLog = (obj: StartOut ...(obj.Description && { Description: SENSITIVE_STRING }), }); -/** - * @internal - */ -export const StartTaskContactRequestFilterSensitiveLog = (obj: StartTaskContactRequest): any => ({ - ...obj, - ...(obj.Name && { Name: SENSITIVE_STRING }), - ...(obj.Description && { Description: SENSITIVE_STRING }), -}); - /** * @internal */ @@ -8551,15 +8347,6 @@ export const StartWebRTCContactResponseFilterSensitiveLog = (obj: StartWebRTCCon ...(obj.ConnectionData && { ConnectionData: ConnectionDataFilterSensitiveLog(obj.ConnectionData) }), }); -/** - * @internal - */ -export const UpdateContactRequestFilterSensitiveLog = (obj: UpdateContactRequest): any => ({ - ...obj, - ...(obj.Name && { Name: SENSITIVE_STRING }), - ...(obj.Description && { Description: SENSITIVE_STRING }), -}); - /** * @internal */ @@ -8600,3 +8387,12 @@ export const UpdateViewMetadataRequestFilterSensitiveLog = (obj: UpdateViewMetad ...obj, ...(obj.Name && { Name: SENSITIVE_STRING }), }); + +/** + * @internal + */ +export const CreateContactRequestFilterSensitiveLog = (obj: CreateContactRequest): any => ({ + ...obj, + ...(obj.Name && { Name: SENSITIVE_STRING }), + ...(obj.Description && { Description: SENSITIVE_STRING }), +}); diff --git a/clients/client-connect/src/models/models_3.ts b/clients/client-connect/src/models/models_3.ts index 4137b349d7d3..f12ab7f3e60d 100644 --- a/clients/client-connect/src/models/models_3.ts +++ b/clients/client-connect/src/models/models_3.ts @@ -7,24 +7,21 @@ import { AgentStatusSearchFilter, Campaign, Channel, - ContactFlowStatus, - ContactFlowType, ContactInitiationMethod, + Endpoint, EvaluationFormScoringStrategy, - SegmentAttributeValue, + Reference, StringCondition, } from "./models_0"; import { AnsweringMachineDetectionStatus, AttributeCondition, - ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, - EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, @@ -34,14 +31,28 @@ import { import { AgentStatusSearchCriteria, + ChatMessage, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, + ContactFlowSearchCriteria, ContactFlowSearchFilter, + EmailAddressInfo, + EmailAddressInfoFilterSensitiveLog, + EmailAddressSearchCriteria, EmailAddressSearchFilter, + EmailAttachment, + EvaluationForm, + EvaluationFormContent, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchFilter, + InboundAdditionalRecipients, + InboundAdditionalRecipientsFilterSensitiveLog, + InboundEmailContent, + InboundEmailContentFilterSensitiveLog, ListCondition, + ParticipantDetails, + PersistentChat, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, @@ -49,494 +60,797 @@ import { RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, + SegmentAttributeValue, UserHierarchyGroupSearchFilter, UserSearchFilter, } from "./models_2"; /** - *

The search criteria to be used to return contact flows.

+ *

A tagged union to specify expression for a routing step.

+ * @public + */ +export interface Expression { + /** + *

An object to specify the predefined attribute condition.

+ * @public + */ + AttributeCondition?: AttributeCondition | undefined; + + /** + *

List of routing expressions which will be AND-ed together.

+ * @public + */ + AndExpression?: Expression[] | undefined; + + /** + *

List of routing expressions which will be OR-ed together.

+ * @public + */ + OrExpression?: Expression[] | undefined; +} + +/** + *

The search criteria to be used to return hours of operations.

+ * @public + */ +export interface HoursOfOperationSearchCriteria { + /** + *

A list of conditions which would be applied together with an OR condition.

+ * @public + */ + OrConditions?: HoursOfOperationSearchCriteria[] | undefined; + + /** + *

A list of conditions which would be applied together with an AND condition.

+ * @public + */ + AndConditions?: HoursOfOperationSearchCriteria[] | undefined; + + /** + *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are name, + * description, timezone, and resourceID.

+ * + * @public + */ + StringCondition?: StringCondition | undefined; +} + +/** + *

The search criteria to be used to return predefined attributes.

* @public */ -export interface ContactFlowSearchCriteria { +export interface PredefinedAttributeSearchCriteria { /** *

A list of conditions which would be applied together with an OR * condition.

* @public */ - OrConditions?: ContactFlowSearchCriteria[] | undefined; + OrConditions?: PredefinedAttributeSearchCriteria[] | undefined; /** *

A list of conditions which would be applied together with an AND * condition.

* @public */ - AndConditions?: ContactFlowSearchCriteria[] | undefined; + AndConditions?: PredefinedAttributeSearchCriteria[] | undefined; /** *

A leaf node condition which can be used to specify a string condition.

* @public */ StringCondition?: StringCondition | undefined; +} +/** + *

The search criteria to be used to return prompts.

+ * @public + */ +export interface PromptSearchCriteria { /** - *

The type of flow.

+ *

A list of conditions which would be applied together with an OR condition.

* @public */ - TypeCondition?: ContactFlowType | undefined; + OrConditions?: PromptSearchCriteria[] | undefined; /** - *

The state of the flow.

+ *

A list of conditions which would be applied together with an AND condition.

* @public */ - StateCondition?: ContactFlowState | undefined; + AndConditions?: PromptSearchCriteria[] | undefined; /** - *

The status of the flow.

+ *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are name, + * description, and resourceID.

+ * * @public */ - StatusCondition?: ContactFlowStatus | undefined; + StringCondition?: StringCondition | undefined; } /** + *

The search criteria to be used to return queues.

+ * + *

The name and description fields support "contains" queries with + * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths + * outside of this range will throw invalid results.

+ * * @public */ -export interface CreateEvaluationFormRequest { +export interface QueueSearchCriteria { /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ *

A list of conditions which would be applied together with an OR condition.

* @public */ - InstanceId: string | undefined; + OrConditions?: QueueSearchCriteria[] | undefined; /** - *

A title of the evaluation form.

+ *

A list of conditions which would be applied together with an AND condition.

* @public */ - Title: string | undefined; + AndConditions?: QueueSearchCriteria[] | undefined; /** - *

The description of the evaluation form.

+ *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are name, + * description, and resourceID.

+ * * @public */ - Description?: string | undefined; + StringCondition?: StringCondition | undefined; /** - *

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

+ *

The type of queue.

* @public */ - Items: EvaluationFormItem[] | undefined; + QueueTypeCondition?: SearchableQueueType | undefined; +} +/** + *

The search criteria to be used to return quick connects.

+ * @public + */ +export interface QuickConnectSearchCriteria { /** - *

A scoring strategy of the evaluation form.

+ *

A list of conditions which would be applied together with an OR condition.

* @public */ - ScoringStrategy?: EvaluationFormScoringStrategy | undefined; + OrConditions?: QuickConnectSearchCriteria[] | undefined; /** - *

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 - * Making retries safe with idempotent APIs.

+ *

A list of conditions which would be applied together with an AND condition.

* @public */ - ClientToken?: string | undefined; + AndConditions?: QuickConnectSearchCriteria[] | undefined; + + /** + *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are name, + * description, and resourceID.

+ * + * @public + */ + StringCondition?: StringCondition | undefined; } /** - *

+ *

The search criteria to be used to return routing profiles.

+ * + *

The name and description fields support "contains" queries with + * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths + * outside of this range will throw invalid results.

+ * * @public */ -export interface EmailAddressSearchCriteria { +export interface RoutingProfileSearchCriteria { /** - *

+ *

A list of conditions which would be applied together with an OR condition.

* @public */ - OrConditions?: EmailAddressSearchCriteria[] | undefined; + OrConditions?: RoutingProfileSearchCriteria[] | undefined; /** - *

+ *

A list of conditions which would be applied together with an AND condition.

* @public */ - AndConditions?: EmailAddressSearchCriteria[] | undefined; + AndConditions?: RoutingProfileSearchCriteria[] | undefined; /** *

A leaf node condition which can be used to specify a string condition.

+ * + *

The currently supported values for FieldName are + * associatedQueueIds, name, description, and + * resourceID.

+ * * @public */ StringCondition?: StringCondition | undefined; } /** - *

Information about the evaluation form.

+ *

The search criteria to be used to return security profiles.

+ * + *

The name field support "contains" queries with a minimum of 2 characters and + * maximum of 25 characters. Any queries with character lengths outside of this range will throw + * invalid results.

+ * * @public */ -export interface EvaluationForm { +export interface SecurityProfileSearchCriteria { /** - *

The unique identifier for the evaluation form.

+ *

A list of conditions which would be applied together with an OR condition.

* @public */ - EvaluationFormId: string | undefined; + OrConditions?: SecurityProfileSearchCriteria[] | undefined; /** - *

A version of the evaluation form.

+ *

A list of conditions which would be applied together with an AND condition.

* @public */ - EvaluationFormVersion: number | undefined; + AndConditions?: SecurityProfileSearchCriteria[] | undefined; /** - *

The flag indicating whether the evaluation form is locked for changes.

+ *

A leaf node condition which can be used to specify a string condition.

* @public */ - Locked: boolean | undefined; + StringCondition?: StringCondition | undefined; +} +/** + * @public + */ +export interface StartChatContactRequest { /** - *

The Amazon Resource Name (ARN) for the evaluation form resource.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - EvaluationFormArn: string | undefined; + InstanceId: string | undefined; /** - *

A title of the evaluation form.

+ *

The identifier of the flow for initiating the chat. + * To + * see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, + * under the name of the flow, choose Show additional flow + * information. The ContactFlowId is the last part of the ARN, shown here in bold:

+ *

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx + *

* @public */ - Title: string | undefined; + ContactFlowId: string | undefined; /** - *

The description of the evaluation form.

+ *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

+ *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, dash, and underscore characters.

* @public */ - Description?: string | undefined; + Attributes?: Record | undefined; /** - *

The status of the evaluation form.

+ *

Information identifying the participant.

* @public */ - Status: EvaluationFormVersionStatus | undefined; + ParticipantDetails: ParticipantDetails | undefined; /** - *

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

+ *

The initial message to be sent to the newly created chat. If you have a Lex bot in your + * flow, the initial message is not delivered to the Lex bot.

* @public */ - Items: EvaluationFormItem[] | undefined; + InitialMessage?: ChatMessage | undefined; /** - *

A scoring strategy of the evaluation form.

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ - ScoringStrategy?: EvaluationFormScoringStrategy | undefined; + ClientToken?: string | undefined; /** - *

The timestamp for when the evaluation form was created.

+ *

The total duration of the newly started chat session. If not specified, the chat session + * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum + * configurable time is 10,080 minutes (7 days).

* @public */ - CreatedTime: Date | undefined; + ChatDurationInMinutes?: number | undefined; /** - *

The Amazon Resource Name (ARN) of the user who created the evaluation form.

+ *

The supported chat message content types. Supported types are text/plain, + * text/markdown, application/json, + * application/vnd.amazonaws.connect.message.interactive, and + * application/vnd.amazonaws.connect.message.interactive.response.

+ *

Content types must always contain text/plain. You can then put any other + * supported type in the list. For example, all the following lists are valid because they contain + * text/plain: [text/plain, text/markdown, application/json], + * [text/markdown, text/plain], [text/plain, application/json, + * application/vnd.amazonaws.connect.message.interactive.response].

+ * + *

The type application/vnd.amazonaws.connect.message.interactive is required to + * use the Show + * view flow block.

+ * * @public */ - CreatedBy: string | undefined; + SupportedMessagingContentTypes?: string[] | undefined; /** - *

The timestamp for when the evaluation form was last updated.

+ *

Enable persistent chats. For more information about enabling persistent chat, and for + * example use cases and how to configure for them, see Enable persistent chat.

* @public */ - LastModifiedTime: Date | undefined; + PersistentChat?: PersistentChat | undefined; /** - *

The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

+ *

The unique identifier for an Amazon Connect contact. This identifier is related to the + * chat starting.

+ * + *

You cannot provide data for both RelatedContactId and PersistentChat.

+ * * @public */ - LastModifiedBy: string | undefined; + RelatedContactId?: string | undefined; /** - *

The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.

+ *

A set of system defined key-value pairs stored on individual contact segments using an + * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in + * flows.

+ *

Attribute keys can include only alphanumeric, -, and _.

+ *

This field can be used to show channel subtype, such as connect:Guide.

+ * + *

The types application/vnd.amazonaws.connect.message.interactive and + * application/vnd.amazonaws.connect.message.interactive.response must be present in + * the SupportedMessagingContentTypes field of this API in order to set + * SegmentAttributes as \{ "connect:Subtype": \{"valueString" : "connect:Guide" + * \}\}.

+ * * @public */ - Tags?: Record | undefined; + SegmentAttributes?: Record | undefined; } /** - *

Information about an evaluation form used in a contact evaluation.

* @public */ -export interface EvaluationFormContent { +export interface StartEmailContactRequest { /** - *

A version of the evaluation form.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - EvaluationFormVersion: number | undefined; + InstanceId: string | undefined; /** - *

The unique identifier for the evaluation form.

+ *

The email address of the customer.

* @public */ - EvaluationFormId: string | undefined; + FromEmailAddress: EmailAddressInfo | undefined; /** - *

The Amazon Resource Name (ARN) for the evaluation form resource.

+ *

The email address associated with the instance.

* @public */ - EvaluationFormArn: string | undefined; + DestinationEmailAddress: string | undefined; /** - *

A title of the evaluation form.

+ *

A description of the email contact.

* @public */ - Title: string | undefined; + Description?: string | undefined; /** - *

The description of the evaluation form.

+ *

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can + * have the following reference types at the time of creation: URL | + * NUMBER | STRING | DATE. EMAIL | + * EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during + * email creation.

* @public */ - Description?: string | undefined; + References?: Record | undefined; /** - *

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

+ *

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

* @public */ - Items: EvaluationFormItem[] | undefined; + Name?: string | undefined; /** - *

A scoring strategy of the evaluation form.

+ *

The email message body to be sent to the newly created email.

* @public */ - ScoringStrategy?: EvaluationFormScoringStrategy | undefined; + EmailMessage: InboundEmailContent | undefined; + + /** + *

The addtional recipients address of the email.

+ * @public + */ + AdditionalRecipients?: InboundAdditionalRecipients | undefined; + + /** + *

List of S3 presigned URLs of email attachments and their file name.

+ * @public + */ + Attachments?: EmailAttachment[] | undefined; + + /** + *

The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, + * on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose + * Show additional flow information. The ContactFlowId is the last + * part of the ARN, shown here in bold:

+ *

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx + *

+ * @public + */ + ContactFlowId?: string | undefined; + + /** + *

The contactId that is related to this contact. Linking emails together by using + * RelatedContactID copies over contact attributes from the related email contact to + * the new email contact. All updates to user-defined attributes in the new email contact are + * limited to the individual contact ID. There are no limits to the number of contacts that can be + * linked by using RelatedContactId.

+ * @public + */ + RelatedContactId?: string | undefined; + + /** + *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

+ *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, dash, and underscore characters.

+ * @public + */ + Attributes?: Record | undefined; + + /** + *

A set of system defined key-value pairs stored on individual contact segments using an + * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in + * flows.

+ *

Attribute keys can include only alphanumeric, -, and _.

+ *

This field can be used to show channel subtype, such as connect:Guide.

+ * + *

To set contact expiry, a ValueMap must be specified containing the integer + * number of minutes the contact will be active for before expiring, with + * SegmentAttributes like \{ "connect:ContactExpiry": \{"ValueMap" : \{ + * "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}.

+ * + * @public + */ + SegmentAttributes?: Record | undefined; + + /** + *

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 + * Making retries safe with idempotent APIs.

+ * @public + */ + ClientToken?: string | undefined; } -/** - *

A tagged union to specify expression for a routing step.

- * @public - */ -export interface Expression { +/** + * @public + */ +export interface StartOutboundChatContactRequest { + /** + *

Information about the endpoint.

+ * @public + */ + SourceEndpoint: Endpoint | undefined; + + /** + *

Information about the endpoint.

+ * @public + */ + DestinationEndpoint: Endpoint | undefined; + + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the + * Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

A set of system defined key-value pairs stored on individual contact segments using an + * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in + * flows.

+ *
    + *
  • + *

    Attribute keys can include only alphanumeric, -, and _.

    + *
    • + *
  • + *

    This field can be used to show channel subtype, such as connect:Guide and + * connect:SMS.

    + *
    • + *
+ * @public + */ + SegmentAttributes: Record | undefined; + + /** + *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

+ * @public + */ + Attributes?: Record | undefined; + /** - *

An object to specify the predefined attribute condition.

+ *

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect + * console user interface, on the navigation menu go to Routing, Contact + * Flows. Choose the flow. On the flow page, under the name of the flow, choose + * Show additional flow information. The ContactFlowId is the last + * part of the ARN, shown here in bold:

+ *
    + *
  • + *

    arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx + *

    + *
    • + *
* @public */ - AttributeCondition?: AttributeCondition | undefined; + ContactFlowId: string | undefined; /** - *

List of routing expressions which will be AND-ed together.

+ *

The total duration of the newly started chat session. If not specified, the chat session + * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum + * configurable time is 10,080 minutes (7 days).

* @public */ - AndExpression?: Expression[] | undefined; + ChatDurationInMinutes?: number | undefined; /** - *

List of routing expressions which will be OR-ed together.

+ *

The customer's details.

* @public */ - OrExpression?: Expression[] | undefined; -} + ParticipantDetails?: ParticipantDetails | undefined; -/** - *

The search criteria to be used to return hours of operations.

- * @public - */ -export interface HoursOfOperationSearchCriteria { /** - *

A list of conditions which would be applied together with an OR condition.

+ *

A chat message.

* @public */ - OrConditions?: HoursOfOperationSearchCriteria[] | undefined; + InitialSystemMessage?: ChatMessage | undefined; /** - *

A list of conditions which would be applied together with an AND condition.

+ *

The unique identifier for an Amazon Connect contact. This identifier is related to the + * contact starting.

* @public */ - AndConditions?: HoursOfOperationSearchCriteria[] | undefined; + RelatedContactId?: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

- * - *

The currently supported values for FieldName are name, - * description, timezone, and resourceID.

- * + *

The supported chat message content types. Supported types are:

+ *
    + *
  • + *

    + * text/plain + *

    + *
    • + *
  • + *

    + * text/markdown + *

    + *
    • + *
  • + *

    + * application/json, + * application/vnd.amazonaws.connect.message.interactive + *

    + *
    • + *
  • + *

    + * application/vnd.amazonaws.connect.message.interactive.response + *

    + *
    • + *
+ *

Content types must always contain text/plain. You can then put any other + * supported type in the list. For example, all the following lists are valid because they contain + * text/plain:

+ *
    + *
  • + *

    + * [text/plain, text/markdown, application/json] + *

    + *
    • + *
  • + *

    + * [text/markdown, text/plain] + *

    + *
    • + *
  • + *

    + * [text/plain, application/json, + * application/vnd.amazonaws.connect.message.interactive.response] + *

    + *
    • + *
+ * @public + */ + SupportedMessagingContentTypes?: string[] | undefined; + + /** + *

A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the AWS SDK populates this field. For more information about + * idempotency, see Making + * retries safe with idempotent APIs. The token is valid for 7 days after creation. If a + * contact is already started, the contact ID is returned.

* @public */ - StringCondition?: StringCondition | undefined; + ClientToken?: string | undefined; } /** - *

The search criteria to be used to return predefined attributes.

* @public */ -export interface PredefinedAttributeSearchCriteria { +export interface StartTaskContactRequest { /** - *

A list of conditions which would be applied together with an OR - * condition.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - OrConditions?: PredefinedAttributeSearchCriteria[] | undefined; + InstanceId: string | undefined; /** - *

A list of conditions which would be applied together with an AND - * condition.

+ *

The identifier of the previous chat, voice, or task contact. Any updates to user-defined + * attributes to task contacts linked using the same PreviousContactID will affect + * every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

* @public */ - AndConditions?: PredefinedAttributeSearchCriteria[] | undefined; + PreviousContactId?: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

+ *

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, + * on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose + * Show additional flow information. The ContactFlowId is the last + * part of the ARN, shown here in bold:

+ *

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx + *

* @public */ - StringCondition?: StringCondition | undefined; -} + ContactFlowId?: string | undefined; -/** - *

The search criteria to be used to return prompts.

- * @public - */ -export interface PromptSearchCriteria { /** - *

A list of conditions which would be applied together with an OR condition.

+ *

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

+ *

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys + * can include only alphanumeric, dash, and underscore characters.

* @public */ - OrConditions?: PromptSearchCriteria[] | undefined; + Attributes?: Record | undefined; /** - *

A list of conditions which would be applied together with an AND condition.

+ *

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

* @public */ - AndConditions?: PromptSearchCriteria[] | undefined; + Name: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

- * - *

The currently supported values for FieldName are name, - * description, and resourceID.

- * + *

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have + * the following reference types at the time of creation: URL | NUMBER | + * STRING | DATE | EMAIL. ATTACHMENT is not a + * supported reference type during task creation.

* @public */ - StringCondition?: StringCondition | undefined; -} + References?: Record | undefined; -/** - *

The search criteria to be used to return queues.

- * - *

The name and description fields support "contains" queries with - * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths - * outside of this range will throw invalid results.

- * - * @public - */ -export interface QueueSearchCriteria { /** - *

A list of conditions which would be applied together with an OR condition.

+ *

A description of the task that is shown to an agent in the Contact Control Panel + * (CCP).

* @public */ - OrConditions?: QueueSearchCriteria[] | undefined; + Description?: string | undefined; /** - *

A list of conditions which would be applied together with an AND condition.

+ *

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 + * Making retries safe with idempotent APIs.

* @public */ - AndConditions?: QueueSearchCriteria[] | undefined; + ClientToken?: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

- * - *

The currently supported values for FieldName are name, - * description, and resourceID.

- * + *

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

* @public */ - StringCondition?: StringCondition | undefined; + ScheduledTime?: Date | undefined; /** - *

The type of queue.

+ *

A unique identifier for the task template. For more information about task templates, see Create task templates in the + * Amazon Connect Administrator Guide.

* @public */ - QueueTypeCondition?: SearchableQueueType | undefined; -} + TaskTemplateId?: string | undefined; -/** - *

The search criteria to be used to return quick connects.

- * @public - */ -export interface QuickConnectSearchCriteria { /** - *

A list of conditions which would be applied together with an OR condition.

+ *

The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the + * flow that is defined on agent or queue quick connect. For more information about quick connects, + * see Create quick + * connects.

* @public */ - OrConditions?: QuickConnectSearchCriteria[] | undefined; + QuickConnectId?: string | undefined; /** - *

A list of conditions which would be applied together with an AND condition.

+ *

The contactId that is related to this contact. Linking + * tasks together by using RelatedContactID copies over contact attributes from the + * related task contact to the new task contact. All updates to user-defined attributes in the new + * task contact are limited to the individual contact ID, unlike what happens when tasks are linked + * by using PreviousContactID. There are no limits to the number of contacts that can + * be linked by using RelatedContactId.

* @public */ - AndConditions?: QuickConnectSearchCriteria[] | undefined; + RelatedContactId?: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

+ *

A set of system defined key-value pairs stored on individual contact segments (unique + * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. + * They can be accessed in flows.

+ *

Attribute keys can include only alphanumeric, -, and _.

+ *

This field can be used to set Contact Expiry as a duration in minutes and set a UserId for + * the User who created a task.

* - *

The currently supported values for FieldName are name, - * description, and resourceID.

+ *

To set contact expiry, a ValueMap must be specified containing the integer number of + * minutes the contact will be active for before expiring, with SegmentAttributes like + * \{ "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": + * 135\}\}\}\}.

+ *

To set the created by user, a valid AgentResourceId must be supplied, with + * SegmentAttributes like \{ "connect:CreatedByUser" \{ "ValueString": + * "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}. + *

* * @public */ - StringCondition?: StringCondition | undefined; + SegmentAttributes?: Record | undefined; } /** - *

The search criteria to be used to return routing profiles.

- * - *

The name and description fields support "contains" queries with - * a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths - * outside of this range will throw invalid results.

- * * @public */ -export interface RoutingProfileSearchCriteria { +export interface UpdateContactRequest { /** - *

A list of conditions which would be applied together with an OR condition.

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ - OrConditions?: RoutingProfileSearchCriteria[] | undefined; + InstanceId: string | undefined; /** - *

A list of conditions which would be applied together with an AND condition.

+ *

The identifier of the contact. This is the identifier of the contact associated with the + * first interaction with your contact center.

* @public */ - AndConditions?: RoutingProfileSearchCriteria[] | undefined; + ContactId: string | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

- * - *

The currently supported values for FieldName are - * associatedQueueIds, name, description, and - * resourceID.

- * + *

The name of the contact.

* @public */ - StringCondition?: StringCondition | undefined; -} + Name?: string | undefined; -/** - *

The search criteria to be used to return security profiles.

- * - *

The name field support "contains" queries with a minimum of 2 characters and - * maximum of 25 characters. Any queries with character lengths outside of this range will throw - * invalid results.

- * - * @public - */ -export interface SecurityProfileSearchCriteria { /** - *

A list of conditions which would be applied together with an OR condition.

+ *

The description of the contact.

* @public */ - OrConditions?: SecurityProfileSearchCriteria[] | undefined; + Description?: string | undefined; /** - *

A list of conditions which would be applied together with an AND condition.

+ *

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

* @public */ - AndConditions?: SecurityProfileSearchCriteria[] | undefined; + References?: Record | undefined; /** - *

A leaf node condition which can be used to specify a string condition.

+ *

A set of system defined key-value pairs stored on individual contact segments (unique + * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. + * They can be accessed in flows.

+ *

Attribute keys can include only alphanumeric, -, and _.

+ *

This field can be used to show channel subtype, such as connect:Guide.

+ *

Currently Contact Expiry is the only segment attribute which can be updated by using the + * UpdateContact API.

* @public */ - StringCondition?: StringCondition | undefined; + SegmentAttributes?: Record | undefined; } /** @@ -791,7 +1105,7 @@ export interface SearchContactFlowModulesRequest { SearchFilter?: ContactFlowModuleSearchFilter | undefined; /** - *

The search criteria to be used to return contact flow modules.

+ *

The search criteria to be used to return flow modules.

* *

The name and description fields support "contains" queries with a * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths @@ -849,31 +1163,32 @@ export interface SearchContactFlowsRequest { */ export interface SearchEmailAddressesRequest { /** - *

+ *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

* @public */ InstanceId: string | undefined; /** - *

+ *

The maximum number of results to return per page.

* @public */ MaxResults?: number | undefined; /** - *

+ *

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.

* @public */ NextToken?: string | undefined; /** - *

+ *

The search criteria to be used to return email addresses.

* @public */ SearchCriteria?: EmailAddressSearchCriteria | undefined; /** - *

+ *

Filters to be applied to search results.

* @public */ SearchFilter?: EmailAddressSearchFilter | undefined; @@ -1295,6 +1610,46 @@ export interface RoutingCriteriaInput { Steps?: RoutingCriteriaInputStep[] | undefined; } +/** + * @public + */ +export interface UpdateContactRoutingDataRequest { + /** + *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

+ * @public + */ + InstanceId: string | undefined; + + /** + *

The identifier of the contact in this instance of Amazon Connect.

+ * @public + */ + ContactId: string | undefined; + + /** + *

The number of seconds to add or subtract from the contact's routing age. Contacts are routed + * to agents on a first-come, first-serve basis. This means that changing their amount of time in + * queue compared to others also changes their position in queue.

+ * @public + */ + QueueTimeAdjustmentSeconds?: number | undefined; + + /** + *

Priority of the contact in the queue. The default priority for new contacts is 5. You can + * raise the priority of a contact compared to other contacts in the queue by assigning them a + * higher priority, such as 1 or 2.

+ * @public + */ + QueuePriority?: number | undefined; + + /** + *

Updates the routing criteria on the contact. These properties can be used to change how a + * contact is routed within the queue.

+ * @public + */ + RoutingCriteria?: RoutingCriteriaInput | undefined; +} + /** *

Contains information about a contact.

* @public @@ -1325,7 +1680,8 @@ export interface Contact { PreviousContactId?: string | undefined; /** - *

+ *

This is the root contactId which is used as a unique identifier for all subsequent contacts + * in a contact tree.

* @public */ ContactAssociationId?: string | undefined; @@ -1435,13 +1791,16 @@ export interface Contact { WisdomInfo?: WisdomInfo | undefined; /** - *

+ *

The customer or external third party participant endpoint.

* @public */ CustomerEndpoint?: EndpointInfo | undefined; /** - *

+ *

The system endpoint. For INBOUND, this is the phone number or email address + * that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is + * the outbound caller ID number assigned to the outbound queue that is used to dial the customer. + * For callback, this shows up as Softphone for calls handled by agents with softphone.

* @public */ SystemEndpoint?: EndpointInfo | undefined; @@ -1520,7 +1879,7 @@ export interface Contact { DisconnectDetails?: DisconnectDetails | undefined; /** - *

+ *

List of additional email addresses for an email contact.

* @public */ AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined; @@ -1539,53 +1898,47 @@ export interface Contact { /** * @public */ -export interface UpdateContactRoutingDataRequest { - /** - *

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

- * @public - */ - InstanceId: string | undefined; - - /** - *

The identifier of the contact in this instance of Amazon Connect.

- * @public - */ - ContactId: string | undefined; - +export interface DescribeContactResponse { /** - *

The number of seconds to add or subtract from the contact's routing age. Contacts are routed - * to agents on a first-come, first-serve basis. This means that changing their amount of time in - * queue compared to others also changes their position in queue.

+ *

Information about the contact.

* @public */ - QueueTimeAdjustmentSeconds?: number | undefined; + Contact?: Contact | undefined; +} - /** - *

Priority of the contact in the queue. The default priority for new contacts is 5. You can - * raise the priority of a contact compared to other contacts in the queue by assigning them a - * higher priority, such as 1 or 2.

- * @public - */ - QueuePriority?: number | undefined; +/** + * @internal + */ +export const StartEmailContactRequestFilterSensitiveLog = (obj: StartEmailContactRequest): any => ({ + ...obj, + ...(obj.FromEmailAddress && { FromEmailAddress: EmailAddressInfoFilterSensitiveLog(obj.FromEmailAddress) }), + ...(obj.DestinationEmailAddress && { DestinationEmailAddress: SENSITIVE_STRING }), + ...(obj.Description && { Description: SENSITIVE_STRING }), + ...(obj.Name && { Name: SENSITIVE_STRING }), + ...(obj.EmailMessage && { EmailMessage: InboundEmailContentFilterSensitiveLog(obj.EmailMessage) }), + ...(obj.AdditionalRecipients && { + AdditionalRecipients: InboundAdditionalRecipientsFilterSensitiveLog(obj.AdditionalRecipients), + }), + ...(obj.Attachments && { Attachments: SENSITIVE_STRING }), +}); - /** - *

Updates the routing criteria on the contact. These properties can be used to change how a - * contact is routed within the queue.

- * @public - */ - RoutingCriteria?: RoutingCriteriaInput | undefined; -} +/** + * @internal + */ +export const StartTaskContactRequestFilterSensitiveLog = (obj: StartTaskContactRequest): any => ({ + ...obj, + ...(obj.Name && { Name: SENSITIVE_STRING }), + ...(obj.Description && { Description: SENSITIVE_STRING }), +}); /** - * @public + * @internal */ -export interface DescribeContactResponse { - /** - *

Information about the contact.

- * @public - */ - Contact?: Contact | undefined; -} +export const UpdateContactRequestFilterSensitiveLog = (obj: UpdateContactRequest): any => ({ + ...obj, + ...(obj.Name && { Name: SENSITIVE_STRING }), + ...(obj.Description && { Description: SENSITIVE_STRING }), +}); /** * @internal diff --git a/clients/client-connect/src/protocols/Aws_restJson1.ts b/clients/client-connect/src/protocols/Aws_restJson1.ts index 1ab0a22b4b5a..d3f6a26b5464 100644 --- a/clients/client-connect/src/protocols/Aws_restJson1.ts +++ b/clients/client-connect/src/protocols/Aws_restJson1.ts @@ -880,7 +880,6 @@ import { RuleAction, RuleTriggerEventSource, S3Config, - SegmentAttributeValue, SendNotificationActionDefinition, ServiceQuotaExceededException, SingleSelectQuestionRuleCategoryAutomation, @@ -965,6 +964,7 @@ import { QuickConnectSummary, RealTimeContactAnalysisSegmentAttachments, RealTimeContactAnalysisSegmentEvent, + RealTimeContactAnalysisSegmentTranscript, RealTimeContactAnalysisSegmentType, RealTimeContactAnalysisTimeData, RoutingProfile, @@ -995,6 +995,7 @@ import { ContactAnalysis, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, + ContactFlowSearchCriteria, ContactFlowSearchFilter, ContactNotFoundException, ContactSearchSummary, @@ -1005,10 +1006,13 @@ import { DestinationNotAllowedException, DisconnectReason, EmailAddressInfo, + EmailAddressSearchCriteria, EmailAddressSearchFilter, EmailAttachment, EmailHeaderType, EvaluationAnswerInput, + EvaluationForm, + EvaluationFormContent, EvaluationFormItem, EvaluationFormSection, HierarchyGroupCondition, @@ -1035,7 +1039,6 @@ import { QueueSearchFilter, QuickConnectSearchFilter, RealtimeContactAnalysisSegment, - RealTimeContactAnalysisSegmentTranscript, ResourceTagsSearchCriteria, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, @@ -1050,6 +1053,7 @@ import { SecurityKey, SecurityProfilesSearchFilter, SecurityProfileSummary, + SegmentAttributeValue, Sort, SourceCampaign, TagSearchCondition, @@ -1067,10 +1071,6 @@ import { } from "../models/models_2"; import { Contact, - ContactFlowSearchCriteria, - EmailAddressSearchCriteria, - EvaluationForm, - EvaluationFormContent, Expression, HoursOfOperationSearchCriteria, PredefinedAttributeSearchCriteria, @@ -1666,7 +1666,7 @@ export const se_CreateContactCommand = async ( Name: [], References: (_) => _json(_), RelatedContactId: [], - SegmentAttributes: (_) => _json(_), + SegmentAttributes: (_) => se_SegmentAttributes(_, context), UserInfo: (_) => _json(_), }) ); @@ -5503,7 +5503,7 @@ export const se_StartChatContactCommand = async ( ParticipantDetails: (_) => _json(_), PersistentChat: (_) => _json(_), RelatedContactId: [], - SegmentAttributes: (_) => _json(_), + SegmentAttributes: (_) => se_SegmentAttributes(_, context), SupportedMessagingContentTypes: (_) => _json(_), }) ); @@ -5614,7 +5614,7 @@ export const se_StartEmailContactCommand = async ( Name: [], References: (_) => _json(_), RelatedContactId: [], - SegmentAttributes: (_) => _json(_), + SegmentAttributes: (_) => se_SegmentAttributes(_, context), }) ); b.m("PUT").h(headers).b(body); @@ -5645,7 +5645,7 @@ export const se_StartOutboundChatContactCommand = async ( InstanceId: [], ParticipantDetails: (_) => _json(_), RelatedContactId: [], - SegmentAttributes: (_) => _json(_), + SegmentAttributes: (_) => se_SegmentAttributes(_, context), SourceEndpoint: (_) => _json(_), SupportedMessagingContentTypes: (_) => _json(_), }) @@ -5767,7 +5767,7 @@ export const se_StartTaskContactCommand = async ( References: (_) => _json(_), RelatedContactId: [], ScheduledTime: (_) => _.getTime() / 1_000, - SegmentAttributes: (_) => _json(_), + SegmentAttributes: (_) => se_SegmentAttributes(_, context), TaskTemplateId: [], }) ); @@ -6115,7 +6115,7 @@ export const se_UpdateContactCommand = async ( Description: [], Name: [], References: (_) => _json(_), - SegmentAttributes: (_) => _json(_), + SegmentAttributes: (_) => se_SegmentAttributes(_, context), }) ); b.m("POST").h(headers).b(body); @@ -14227,9 +14227,42 @@ const se_SecurityProfileSearchCriteria = (input: SecurityProfileSearchCriteria, // se_SecurityProfilesSearchFilter omitted. -// se_SegmentAttributes omitted. +/** + * serializeAws_restJson1SegmentAttributes + */ +const se_SegmentAttributes = (input: Record, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: Record, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + acc[key] = se_SegmentAttributeValue(value, context); + return acc; + }, {}); +}; + +/** + * serializeAws_restJson1SegmentAttributeValue + */ +const se_SegmentAttributeValue = (input: SegmentAttributeValue, context: __SerdeContext): any => { + return take(input, { + ValueInteger: [], + ValueMap: (_) => se_SegmentAttributeValueMap(_, context), + ValueString: [], + }); +}; -// se_SegmentAttributeValue omitted. +/** + * serializeAws_restJson1SegmentAttributeValueMap + */ +const se_SegmentAttributeValueMap = (input: Record, context: __SerdeContext): any => { + return Object.entries(input).reduce((acc: Record, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + acc[key] = se_SegmentAttributeValue(value, context); + return acc; + }, {}); +}; // se_SendNotificationActionDefinition omitted. @@ -14748,7 +14781,7 @@ const de_Contact = (output: any, context: __SerdeContext): Contact => { RelatedContactId: __expectString, RoutingCriteria: (_: any) => de_RoutingCriteria(_, context), ScheduledTimestamp: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), - SegmentAttributes: _json, + SegmentAttributes: (_: any) => de_SegmentAttributes(_, context), SystemEndpoint: _json, Tags: _json, TotalPauseCount: __expectInt32, @@ -14767,7 +14800,6 @@ const de_ContactFlow = (output: any, context: __SerdeContext): ContactFlow => { Description: __expectString, FlowContentSha256: __expectString, Id: __expectString, - IsDefault: __expectBoolean, LastModifiedRegion: __expectString, LastModifiedTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), Name: __expectString, @@ -16449,9 +16481,42 @@ const de_SecurityProfileSummaryList = (output: any, context: __SerdeContext): Se return retVal; }; -// de_SegmentAttributes omitted. +/** + * deserializeAws_restJson1SegmentAttributes + */ +const de_SegmentAttributes = (output: any, context: __SerdeContext): Record => { + return Object.entries(output).reduce((acc: Record, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + acc[key as string] = de_SegmentAttributeValue(value, context); + return acc; + }, {} as Record); +}; + +/** + * deserializeAws_restJson1SegmentAttributeValue + */ +const de_SegmentAttributeValue = (output: any, context: __SerdeContext): SegmentAttributeValue => { + return take(output, { + ValueInteger: __expectInt32, + ValueMap: (_: any) => de_SegmentAttributeValueMap(_, context), + ValueString: __expectString, + }) as any; +}; -// de_SegmentAttributeValue omitted. +/** + * deserializeAws_restJson1SegmentAttributeValueMap + */ +const de_SegmentAttributeValueMap = (output: any, context: __SerdeContext): Record => { + return Object.entries(output).reduce((acc: Record, [key, value]: [string, any]) => { + if (value === null) { + return acc; + } + acc[key as string] = de_SegmentAttributeValue(value, context); + return acc; + }, {} as Record); +}; // de_SendNotificationActionDefinition omitted. diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 8f5a7228e1c2..32cf0d391f11 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -237,18 +237,18 @@ "ToList": { "target": "com.amazonaws.connect#EmailRecipientsList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of additional TO email recipients for an email contact.

" } }, "CcList": { "target": "com.amazonaws.connect#EmailRecipientsList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of additional CC email recipients for an email contact.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of additional email addresses for an email contact.

" } }, "com.amazonaws.connect#AfterContactWorkTimeLimit": { @@ -3749,60 +3749,60 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" } }, "ContactArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the contact

" } }, "InitiationTimestamp": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The date and time this contact was initiated, in UTC time.

" } }, "DisconnectTimestamp": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The timestamp when the customer endpoint disconnected from Amazon Connect.

" } }, "InitialContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

If this contact is related to other contacts, this is the ID of the initial contact.

" } }, "PreviousContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

If this contact is not the first contact, this is the ID of the previous contact.

" } }, "RelatedContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The contactId that is related to this contact.

" } }, "InitiationMethod": { "target": "com.amazonaws.connect#ContactInitiationMethod", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Indicates how the contact was initiated.

" } }, "Channel": { "target": "com.amazonaws.connect#Channel", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

How the contact reached your contact center.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Contact summary of a contact in contact tree associated with unique identifier.

" } }, "com.amazonaws.connect#AssociatedContactSummaryList": { @@ -4011,7 +4011,7 @@ "Arn": { "target": "com.amazonaws.connect#ReferenceArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the attachment reference.

" } } }, @@ -4625,7 +4625,7 @@ "AssociatedResourceArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.

\n \n

This value must be a valid ARN.

\n ", + "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. The supported resources are\n Cases and Email.

\n \n

This value must be a valid ARN.

\n ", "smithy.api#httpQuery": "associatedResourceArn", "smithy.api#required": {} } @@ -5388,7 +5388,7 @@ "AssociatedResourceArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.

\n \n

This value must be a valid ARN.

\n ", + "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. The supported resources are\n Cases and Email.

\n \n

This value must be a valid ARN.

\n ", "smithy.api#httpQuery": "associatedResourceArn", "smithy.api#required": {} } @@ -5444,7 +5444,7 @@ } }, "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

A conditional check failed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -5518,7 +5518,7 @@ "ContactAssociationId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

This is the root contactId which is used as a unique identifier for all subsequent contacts\n in a contact tree.

" } }, "InitiationMethod": { @@ -5620,13 +5620,13 @@ "CustomerEndpoint": { "target": "com.amazonaws.connect#EndpointInfo", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The customer or external third party participant endpoint.

" } }, "SystemEndpoint": { "target": "com.amazonaws.connect#EndpointInfo", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The system endpoint. For INBOUND, this is the phone number or email address\n that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is\n the outbound caller ID number assigned to the outbound queue that is used to dial the customer.\n For callback, this shows up as Softphone for calls handled by agents with softphone.

" } }, "QueueTimeAdjustmentSeconds": { @@ -5695,7 +5695,7 @@ "AdditionalEmailRecipients": { "target": "com.amazonaws.connect#AdditionalEmailRecipients", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of additional email addresses for an email contact.

" } }, "SegmentAttributes": { @@ -5720,7 +5720,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that defines search criteria for contacts using analysis outputs from Amazon\n Connect Contact Lens.

" + "smithy.api#documentation": "

A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.

" } }, "com.amazonaws.connect#ContactDataRequest": { @@ -5829,7 +5829,7 @@ "Status": { "target": "com.amazonaws.connect#ContactFlowStatus", "traits": { - "smithy.api#documentation": "

The status of the contact flow.

" + "smithy.api#documentation": "

The status of the flow.

" } }, "Description": { @@ -5850,13 +5850,6 @@ "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" } }, - "IsDefault": { - "target": "com.amazonaws.connect#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Amazon Connect includes a set of default flows that have already been published. It uses\n them to power your contact center.

" - } - }, "FlowContentSha256": { "target": "com.amazonaws.connect#FlowContentSha256", "traits": { @@ -5878,13 +5871,13 @@ "LastModifiedTime": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the contact flow was last modified.

" + "smithy.api#documentation": "

The time at which the flow was last modified.

" } }, "LastModifiedRegion": { "target": "com.amazonaws.connect#RegionName", "traits": { - "smithy.api#documentation": "

The region in which the contact flow was last modified

" + "smithy.api#documentation": "

The region in which the flow was last modified

" } } }, @@ -6184,7 +6177,7 @@ } }, "traits": { - "smithy.api#documentation": "

The search criteria to be used to return contact flows.

" + "smithy.api#documentation": "

The search criteria to be used to return flows.

" } }, "com.amazonaws.connect#ContactFlowSearchFilter": { @@ -6274,7 +6267,7 @@ "ContactFlowStatus": { "target": "com.amazonaws.connect#ContactFlowStatus", "traits": { - "smithy.api#documentation": "

The status of the contact flow.

" + "smithy.api#documentation": "

The status of the flow.

" } } }, @@ -6382,7 +6375,7 @@ } }, "traits": { - "smithy.api#documentation": "

A summary of a contact flow version's metadata.

" + "smithy.api#documentation": "

A summary of a flow version's metadata.

" } }, "com.amazonaws.connect#ContactFlowVersionSummaryList": { @@ -6578,7 +6571,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#ContactSearchSummarySegmentAttributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Set of segment attributes for a contact.

" } } }, @@ -6632,12 +6625,12 @@ "ValueString": { "target": "com.amazonaws.connect#SegmentAttributeValueString", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The value of a segment attribute represented as a string.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The value of a segment attribute. This is structured as a map with a single key-value pair.\n The key 'valueString' indicates that the attribute type is a string, and its corresponding value\n is the actual string value of the segment attribute.

" } }, "com.amazonaws.connect#ContactSearchSummarySegmentAttributes": { @@ -7033,7 +7026,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Creates a new contact.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/create-contact", @@ -7397,83 +7390,83 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", "smithy.api#idempotencyToken": {} } }, "RelatedContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" } }, "Attributes": { "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" } }, "References": { "target": "com.amazonaws.connect#ContactReferences", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have\n the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL |\n ATTACHMENT.

" } }, "Channel": { "target": "com.amazonaws.connect#Channel", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The channel for the contact

", "smithy.api#required": {} } }, "InitiationMethod": { "target": "com.amazonaws.connect#ContactInitiationMethod", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Indicates how the contact was initiated.

", "smithy.api#required": {} } }, "ExpiryDurationInMinutes": { "target": "com.amazonaws.connect#ExpiryDurationInMinutes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Number of minutes the contact will be active for before expiring

" } }, "UserInfo": { "target": "com.amazonaws.connect#UserInfo", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

User details for the contact

" } }, "InitiateAs": { "target": "com.amazonaws.connect#InitiateAs", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Initial state of the contact when it's created

" } }, "Name": { "target": "com.amazonaws.connect#Name", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The name of a the contact.

" } }, "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A description of the contact.

" } }, "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to set Segment Contact Expiry as a duration in minutes.

\n \n

To set contact expiry, a ValueMap must be specified containing the integer number of\n minutes the contact will be active for before expiring, with SegmentAttributes like\n { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\":\n 135}}}}.

\n " } } }, @@ -7487,13 +7480,13 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" } }, "ContactArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created contact.

" } } }, @@ -7542,7 +7535,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Create new email address in the specified Amazon Connect instance. For more information\n about email addresses, see Create email addresses in the\n Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/email-addresses/{InstanceId}", @@ -7556,13 +7549,13 @@ "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The description of the email address.

" } }, "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7570,26 +7563,26 @@ "EmailAddress": { "target": "com.amazonaws.connect#EmailAddress", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.

", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.connect#EmailAddressDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The display name of email address

" } }, "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" } }, "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

" } } }, @@ -7603,13 +7596,13 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the email address.

" } }, "EmailAddressArn": { "target": "com.amazonaws.connect#EmailAddressArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the email address.

" } } }, @@ -8477,7 +8470,7 @@ "OutboundEmailConfig": { "target": "com.amazonaws.connect#OutboundEmailConfig", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The outbound email address ID for a specified queue.

" } }, "HoursOfOperationId": { @@ -9086,7 +9079,7 @@ "SelfAssignFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The ContactFlowId for the flow that will be run if this template is used to create a\n self-assigned task.

" } }, "Constraints": { @@ -10701,7 +10694,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Deletes email address from the specified Amazon Connect instance.

", "smithy.api#http": { "method": "DELETE", "uri": "/email-addresses/{InstanceId}/{EmailAddressId}", @@ -10715,7 +10708,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10723,7 +10716,7 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the email address.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12215,7 +12208,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

\n

In the response, Status indicates the flow status as either\n SAVED or PUBLISHED. The PUBLISHED status will initiate\n validation on the content. SAVED does not initiate validation of the content.\n SAVED | PUBLISHED\n

", + "smithy.api#documentation": "

Describes the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

\n

In the response, Status indicates the flow status as either\n SAVED or PUBLISHED. The PUBLISHED status will initiate\n validation on the content. SAVED does not initiate validation of the content.\n SAVED | PUBLISHED\n

", "smithy.api#http": { "method": "GET", "uri": "/contact-flows/{InstanceId}/{ContactFlowId}", @@ -12252,7 +12245,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified flow module.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

", + "smithy.api#documentation": "

Describes the specified flow module.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

", "smithy.api#http": { "method": "GET", "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}", @@ -12403,7 +12396,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Describe email address form the specified Amazon Connect instance.

", "smithy.api#http": { "method": "GET", "uri": "/email-addresses/{InstanceId}/{EmailAddressId}", @@ -12417,7 +12410,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12425,7 +12418,7 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the email address.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12441,49 +12434,49 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the email address.

" } }, "EmailAddressArn": { "target": "com.amazonaws.connect#EmailAddressArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the email address.

" } }, "EmailAddress": { "target": "com.amazonaws.connect#EmailAddress", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.

" } }, "DisplayName": { "target": "com.amazonaws.connect#EmailAddressDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The display name of email address

" } }, "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The description of the email address.

" } }, "CreateTimestamp": { "target": "com.amazonaws.connect#ISO8601Datetime", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The email address creation timestamp in ISO 8601 Datetime.

" } }, "ModifiedTimestamp": { "target": "com.amazonaws.connect#ISO8601Datetime", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The email address last modification timestamp in ISO 8601 Datetime.

" } }, "Tags": { "target": "com.amazonaws.connect#TagMap", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"Tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" } } }, @@ -15077,19 +15070,19 @@ "EmailAddress": { "target": "com.amazonaws.connect#EmailAddress", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.

", "smithy.api#required": {} } }, "DisplayName": { "target": "com.amazonaws.connect#EmailAddressDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The display name of email address.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Contains information about a source or destination email address

" } }, "com.amazonaws.connect#EmailAddressList": { @@ -15104,36 +15097,36 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the email address.

" } }, "EmailAddressArn": { "target": "com.amazonaws.connect#EmailAddressArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the email address.

" } }, "EmailAddress": { "target": "com.amazonaws.connect#EmailAddress", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The email address with the instance, in [^\\s@]+@[^\\s@]+\\.[^\\s@]+ format.

" } }, "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The description of the email address.

" } }, "DisplayName": { "target": "com.amazonaws.connect#EmailAddressDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The display name of email address.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Contains information about an email address for a contact center.

" } }, "com.amazonaws.connect#EmailAddressRecipientList": { @@ -15160,13 +15153,13 @@ "OrConditions": { "target": "com.amazonaws.connect#EmailAddressSearchConditionList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an OR condition.

" } }, "AndConditions": { "target": "com.amazonaws.connect#EmailAddressSearchConditionList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A list of conditions which would be applied together with an AND condition.

" } }, "StringCondition": { @@ -15174,7 +15167,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The search criteria to be used to return email addresses.

" } }, "com.amazonaws.connect#EmailAddressSearchFilter": { @@ -15185,7 +15178,7 @@ } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Filters to be applied to search results.

" } }, "com.amazonaws.connect#EmailAttachment": { @@ -15194,20 +15187,20 @@ "FileName": { "target": "com.amazonaws.connect#FileName", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

A case-sensitive name of the attached file being uploaded.

", "smithy.api#required": {} } }, "S3Url": { "target": "com.amazonaws.connect#PreSignedAttachmentUrl", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The pre-signed URLs for the S3 bucket where the email attachment is stored.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the email attachment files.

" } }, "com.amazonaws.connect#EmailAttachments": { @@ -15291,18 +15284,18 @@ "Name": { "target": "com.amazonaws.connect#ReferenceKey", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The name of the email message reference

" } }, "Arn": { "target": "com.amazonaws.connect#ReferenceArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the email message reference

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the reference when the referenceType is EMAIL_MESSAGE.\n Otherwise, null.

" } }, "com.amazonaws.connect#EmailRecipient": { @@ -15311,18 +15304,18 @@ "Address": { "target": "com.amazonaws.connect#EndpointAddress", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Address of the email recipient.

\n

Type: String

\n

Length Constraints: Minimum length of 1. Maximum length of 256.

" } }, "DisplayName": { "target": "com.amazonaws.connect#EndpointDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Display name of the email recipient.

\n

Type: String

\n

Length Constraints: Minimum length of 1. Maximum length of 256.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the email recipient

" } }, "com.amazonaws.connect#EmailRecipientsList": { @@ -15442,24 +15435,24 @@ "Type": { "target": "com.amazonaws.connect#EndpointType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Type of endpoint.

" } }, "Address": { "target": "com.amazonaws.connect#EndpointAddress", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Address of the endpoint.

" } }, "DisplayName": { "target": "com.amazonaws.connect#EndpointDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Display name of the endpoint.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the endpoint.

" } }, "com.amazonaws.connect#EndpointType": { @@ -17439,7 +17432,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Connect instance.

", + "smithy.api#documentation": "

The unique identifier of the Amazon Connect instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17462,7 +17455,7 @@ "AssociatedResourceArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.

\n \n

This value must be a valid ARN.

\n ", + "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. The supported resources are\n Cases and Email.

\n \n

This value must be a valid ARN.

\n ", "smithy.api#httpQuery": "associatedResourceArn", "smithy.api#required": {} } @@ -18461,7 +18454,7 @@ "SelfAssignFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

ContactFlowId for the flow that will be run if this template is used to create a\n self-assigned task

" } }, "Constraints": { @@ -19773,18 +19766,18 @@ "ToAddresses": { "target": "com.amazonaws.connect#EmailAddressRecipientList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The additional recipients information present in to list.

" } }, "CcAddresses": { "target": "com.amazonaws.connect#EmailAddressRecipientList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The additional recipients information present in cc list.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The additional TO CC recipients information of inbound email.

" } }, "com.amazonaws.connect#InboundCallsEnabled": { @@ -19796,19 +19789,19 @@ "MessageSourceType": { "target": "com.amazonaws.connect#InboundMessageSourceType", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The message source type, that is, RAW.

", "smithy.api#required": {} } }, "RawMessage": { "target": "com.amazonaws.connect#InboundRawMessage", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The raw email body content.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about email body content.

" } }, "com.amazonaws.connect#InboundMessageSourceType": { @@ -19828,33 +19821,33 @@ "Subject": { "target": "com.amazonaws.connect#InboundSubject", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email subject.

", "smithy.api#required": {} } }, "Body": { "target": "com.amazonaws.connect#Body", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email message body.

", "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.connect#EmailMessageContentType", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Type of content, that is, text/plain or text/html.

", "smithy.api#required": {} } }, "Headers": { "target": "com.amazonaws.connect#EmailHeaders", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Headers present in inbound email.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the raw email body content.

" } }, "com.amazonaws.connect#InboundSubject": { @@ -21204,7 +21197,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Provides information about contact tree, a list of associated contacts with a unique\n identifier.

", "smithy.api#http": { "method": "GET", "uri": "/contact/associated/{InstanceId}", @@ -21218,7 +21211,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -21226,7 +21219,7 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", "smithy.api#httpQuery": "contactId", "smithy.api#required": {} } @@ -21234,14 +21227,14 @@ "MaxResults": { "target": "com.amazonaws.connect#ListAssociatedContactsRequestMaxResults", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The maximum number of results to return per page.

\n

The maximum number of results to return per page. The default MaxResult size is 25.

\n

Valid Range: Minimum value of 1. Maximum value of 100.

", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } } @@ -21265,13 +21258,13 @@ "ContactSummaryList": { "target": "com.amazonaws.connect#AssociatedContactSummaryList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of the contact summary for all the contacts in contact tree associated with unique\n identifier.

" } }, "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } } }, @@ -26433,12 +26426,12 @@ "CcEmailAddresses": { "target": "com.amazonaws.connect#EmailAddressRecipientList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The additional CC email address recipients information.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The additional recipients information of outbound email.

" } }, "com.amazonaws.connect#OutboundCallerConfig": { @@ -26505,12 +26498,12 @@ "OutboundEmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the email address.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The outbound email address Id.

" } }, "com.amazonaws.connect#OutboundEmailContent": { @@ -26519,25 +26512,25 @@ "MessageSourceType": { "target": "com.amazonaws.connect#OutboundMessageSourceType", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The message source type, that is, RAW or TEMPLATE.

", "smithy.api#required": {} } }, "TemplatedMessageConfig": { "target": "com.amazonaws.connect#TemplatedMessageConfig", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about template message configuration.

" } }, "RawMessage": { "target": "com.amazonaws.connect#OutboundRawMessage", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The raw email body content.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about email body content.

" } }, "com.amazonaws.connect#OutboundMessageSourceType": { @@ -26563,27 +26556,27 @@ "Subject": { "target": "com.amazonaws.connect#OutboundSubject", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email subject.

", "smithy.api#required": {} } }, "Body": { "target": "com.amazonaws.connect#Body", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email message body.

", "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.connect#EmailMessageContentType", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Type of content, that is, text/plain or text/html.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the raw email body content.

" } }, "com.amazonaws.connect#OutboundRequestId": { @@ -26613,7 +26606,7 @@ } }, "traits": { - "smithy.api#documentation": "

Thrown for analyzed content when requested OutputType was not enabled for a given contact.\n For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction\n policy set in Contact flow.

", + "smithy.api#documentation": "

Thrown for analyzed content when requested OutputType was not enabled for a given contact.\n For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction\n policy set in the flow.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -29317,7 +29310,7 @@ "OutboundEmailConfig": { "target": "com.amazonaws.connect#OutboundEmailConfig", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The outbound email address ID for a specified queue.

" } }, "HoursOfOperationId": { @@ -30694,19 +30687,19 @@ "Status": { "target": "com.amazonaws.connect#ReferenceStatus", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Status of the attachment reference type.

" } }, "Arn": { "target": "com.amazonaws.connect#ReferenceArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reference

" } }, "StatusReason": { "target": "com.amazonaws.connect#ReferenceStatusReason", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Relevant details why the reference was not successfully created.

" } } }, @@ -30810,7 +30803,7 @@ "EmailMessage": { "target": "com.amazonaws.connect#EmailMessageReference", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the reference when the referenceType is EMAIL_MESSAGE.\n Otherwise, null.

" } }, "String": { @@ -32644,7 +32637,7 @@ "SearchCriteria": { "target": "com.amazonaws.connect#ContactFlowModuleSearchCriteria", "traits": { - "smithy.api#documentation": "

The search criteria to be used to return contact flow modules.

\n \n

The name and description fields support \"contains\" queries with a\n minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will result in invalid results.

\n " + "smithy.api#documentation": "

The search criteria to be used to return flow modules.

\n \n

The name and description fields support \"contains\" queries with a\n minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will result in invalid results.

\n " } } }, @@ -32658,7 +32651,7 @@ "ContactFlowModules": { "target": "com.amazonaws.connect#ContactFlowModuleSearchSummaryList", "traits": { - "smithy.api#documentation": "

The search criteria to be used to return contact flow modules.

" + "smithy.api#documentation": "

The search criteria to be used to return flow modules.

" } }, "NextToken": { @@ -32670,7 +32663,7 @@ "ApproximateTotalCount": { "target": "com.amazonaws.connect#ApproximateTotalCount", "traits": { - "smithy.api#documentation": "

The total number of contact flows which matched your search query.

" + "smithy.api#documentation": "

The total number of flows which matched your search query.

" } } }, @@ -32704,7 +32697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Searches the contact flows in an Amazon Connect instance, with optional\n filtering.

", + "smithy.api#documentation": "

Searches the flows in an Amazon Connect instance, with optional filtering.

", "smithy.api#http": { "method": "POST", "uri": "/search-contact-flows", @@ -32775,7 +32768,7 @@ "ApproximateTotalCount": { "target": "com.amazonaws.connect#ApproximateTotalCount", "traits": { - "smithy.api#documentation": "

The total number of contact flows which matched your search query.

" + "smithy.api#documentation": "

The total number of flows which matched your search query.

" } } }, @@ -33019,7 +33012,7 @@ "SearchableSegmentAttributes": { "target": "com.amazonaws.connect#SearchableSegmentAttributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The search criteria based on searchable segment attributes of a contact.

" } } }, @@ -33056,7 +33049,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Searches email address in an instance, with optional filtering.

", "smithy.api#http": { "method": "POST", "uri": "/search-email-addresses", @@ -33070,32 +33063,32 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.connect#MaxResult100", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The maximum number of results to return per page.

" } }, "NextToken": { "target": "com.amazonaws.connect#NextToken2500", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

" } }, "SearchCriteria": { "target": "com.amazonaws.connect#EmailAddressSearchCriteria", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The search criteria to be used to return email addresses.

" } }, "SearchFilter": { "target": "com.amazonaws.connect#EmailAddressSearchFilter", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Filters to be applied to search results.

" } } }, @@ -33109,19 +33102,19 @@ "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

If there are additional results, this is the token for the next set of results.

" } }, "EmailAddresses": { "target": "com.amazonaws.connect#EmailAddressList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of email addresses matching SearchFilter and SearchCriteria

" } }, "ApproximateTotalCount": { "target": "com.amazonaws.connect#ApproximateTotalCount", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The total number of email addresses which matched your search query.

" } } }, @@ -34364,7 +34357,7 @@ } }, "traits": { - "smithy.api#documentation": "

The search criteria based on user-defned contact attribute key and values to search\n on.

" + "smithy.api#documentation": "

The search criteria based on user-defined contact attribute key and values to search\n on.

" } }, "com.amazonaws.connect#SearchableContactAttributesCriteriaList": { @@ -34429,19 +34422,19 @@ "Criteria": { "target": "com.amazonaws.connect#SearchableSegmentAttributesCriteriaList", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The list of criteria based on searchable segment attributes.

", "smithy.api#required": {} } }, "MatchType": { "target": "com.amazonaws.connect#SearchContactsMatchType", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The match type combining search criteria using multiple searchable segment\n attributes.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The search criteria based on searchable segment attributes of a contact

" } }, "com.amazonaws.connect#SearchableSegmentAttributesCriteria": { @@ -34450,20 +34443,20 @@ "Key": { "target": "com.amazonaws.connect#SearchableSegmentAttributeKey", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The key containing a searchable segment attribute.

", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.connect#SearchableSegmentAttributeValueList", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The list of values to search for within a searchable segment attribute.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The search criteria based on searchable segment attribute key and values to search\n on.

" } }, "com.amazonaws.connect#SearchableSegmentAttributesCriteriaList": { @@ -34801,12 +34794,36 @@ "traits": { "smithy.api#documentation": "

The value of a segment attribute.

" } + }, + "ValueMap": { + "target": "com.amazonaws.connect#SegmentAttributeValueMap", + "traits": { + "smithy.api#documentation": "

The value of a segment attribute.

" + } + }, + "ValueInteger": { + "target": "com.amazonaws.connect#SegmentAttributeValueInteger", + "traits": { + "smithy.api#documentation": "

The value of a segment attribute.

" + } } }, "traits": { "smithy.api#documentation": "

A value for a segment attribute. This is structured as a map where the key is\n valueString and the value is a string.

" } }, + "com.amazonaws.connect#SegmentAttributeValueInteger": { + "type": "integer" + }, + "com.amazonaws.connect#SegmentAttributeValueMap": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#SegmentAttributeName" + }, + "value": { + "target": "com.amazonaws.connect#SegmentAttributeValue" + } + }, "com.amazonaws.connect#SegmentAttributeValueString": { "type": "string", "traits": { @@ -34994,7 +35011,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Send outbound email for outbound campaigns. For more information about outbound campaigns,\n see Set up Amazon Connect outbound campaigns.

\n \n

Only the Amazon Connect outbound campaigns service principal is allowed to assume a\n role in your account and call this API.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/instance/{InstanceId}/outbound-email", @@ -35008,7 +35025,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -35016,47 +35033,47 @@ "FromEmailAddress": { "target": "com.amazonaws.connect#EmailAddressInfo", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address to be used for sending email.

", "smithy.api#required": {} } }, "DestinationEmailAddress": { "target": "com.amazonaws.connect#EmailAddressInfo", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address to send the email to.

", "smithy.api#required": {} } }, "AdditionalRecipients": { "target": "com.amazonaws.connect#OutboundAdditionalRecipients", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The additional recipients address of the email in CC.

" } }, "EmailMessage": { "target": "com.amazonaws.connect#OutboundEmailContent", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email message body to be sent to the newly created email.

", "smithy.api#required": {} } }, "TrafficType": { "target": "com.amazonaws.connect#TrafficType", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Denotes the class of traffic.

", "smithy.api#required": {} } }, "SourceCampaign": { "target": "com.amazonaws.connect#SourceCampaign", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A Campaign object need for Campaign traffic type.

" } }, "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", "smithy.api#idempotencyToken": {} } } @@ -35094,12 +35111,12 @@ "AttachedFileServiceQuotaExceededExceptionReason": { "target": "com.amazonaws.connect#AttachedFileServiceQuotaExceededExceptionReason", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Total file size of all files or total number of files exceeds the service quota

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The reason for the exception.

" } }, "com.amazonaws.connect#SignInConfig": { @@ -35306,18 +35323,18 @@ "CampaignId": { "target": "com.amazonaws.connect#CampaignId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A unique identifier for a campaign.

" } }, "OutboundRequestId": { "target": "com.amazonaws.connect#OutboundRequestId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A unique identifier for a each request part of same campaign.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the campaign.

" } }, "com.amazonaws.connect#SourceId": { @@ -35381,7 +35398,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a pre-signed Amazon S3 URL in response for uploading your content.

\n \n

You may only use this API to upload attachments to an Amazon Connect Case.

\n ", + "smithy.api#documentation": "

Provides a pre-signed Amazon S3 URL in response for uploading your content.

\n \n

You may only use this API to upload attachments to an Amazon Connect Case or\n Amazon Connect\n Email.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/attached-files/{InstanceId}", @@ -35430,14 +35447,14 @@ "FileUseCaseType": { "target": "com.amazonaws.connect#FileUseCaseType", "traits": { - "smithy.api#documentation": "

The use case for the file.

", + "smithy.api#documentation": "

The use case for the file.

\n \n

Only ATTACHMENTS are supported.

\n ", "smithy.api#required": {} } }, "AssociatedResourceArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.

\n \n

This value must be a valid ARN.

\n ", + "smithy.api#documentation": "

The resource to which the attached file is (being) uploaded to. The supported resources are\n Cases and Email.

\n \n

This value must be a valid ARN.

\n ", "smithy.api#httpQuery": "associatedResourceArn", "smithy.api#required": {} } @@ -35551,7 +35568,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the\n flow page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", + "smithy.api#documentation": "

The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page,\n under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

", "smithy.api#required": {} } }, @@ -35937,7 +35954,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Creates an inbound email contact and initiates a flow to start the email contact for the\n customer. Response of this API provides the ContactId of the email contact created.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/email", @@ -35951,89 +35968,89 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#required": {} } }, "FromEmailAddress": { "target": "com.amazonaws.connect#EmailAddressInfo", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address of the customer.

", "smithy.api#required": {} } }, "DestinationEmailAddress": { "target": "com.amazonaws.connect#EmailAddress", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address associated with the instance.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A description of the email contact.

" } }, "References": { "target": "com.amazonaws.connect#ContactReferences", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can\n have the following reference types at the time of creation: URL |\n NUMBER | STRING | DATE. EMAIL |\n EMAIL_MESSAGE |ATTACHMENT are not a supported reference type during\n email creation.

" } }, "Name": { "target": "com.amazonaws.connect#Name", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

" } }, "EmailMessage": { "target": "com.amazonaws.connect#InboundEmailContent", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email message body to be sent to the newly created email.

", "smithy.api#required": {} } }, "AdditionalRecipients": { "target": "com.amazonaws.connect#InboundAdditionalRecipients", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The addtional recipients address of the email.

" } }, "Attachments": { "target": "com.amazonaws.connect#EmailAttachments", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of S3 presigned URLs of email attachments and their file name.

" } }, "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website,\n on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" } }, "RelatedContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The contactId that is related to this contact. Linking emails together by using\n RelatedContactID copies over contact attributes from the related email contact to\n the new email contact. All updates to user-defined attributes in the new email contact are\n limited to the individual contact ID. There are no limits to the number of contacts that can be\n linked by using RelatedContactId.

" } }, "Attributes": { "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

\n

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.

" } }, "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in\n flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n \n

To set contact expiry, a ValueMap must be specified containing the integer\n number of minutes the contact will be active for before expiring, with\n SegmentAttributes like { \"connect:ContactExpiry\": {\"ValueMap\" : {\n \"ExpiryDuration\": { \"ValueInteger\":135}}}}.

\n " } }, "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", "smithy.api#idempotencyToken": {} } } @@ -36048,7 +36065,7 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of this contact within the Amazon Connect instance.

" } } }, @@ -36220,7 +36237,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Initiates a flow to send an agent reply or outbound email contact (created from the\n CreateContact API) to a customer.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/outbound-email", @@ -36234,47 +36251,47 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#required": {} } }, "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

", "smithy.api#required": {} } }, "FromEmailAddress": { "target": "com.amazonaws.connect#EmailAddressInfo", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The email address associated with the instance.

" } }, "DestinationEmailAddress": { "target": "com.amazonaws.connect#EmailAddressInfo", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email address of the customer.

", "smithy.api#required": {} } }, "AdditionalRecipients": { "target": "com.amazonaws.connect#OutboundAdditionalRecipients", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The addtional recipients address of email in CC.

" } }, "EmailMessage": { "target": "com.amazonaws.connect#OutboundEmailContent", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The email message body to be sent to the newly created email.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

", "smithy.api#idempotencyToken": {} } } @@ -36289,7 +36306,7 @@ "ContactId": { "target": "com.amazonaws.connect#ContactId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the contact in this instance of Amazon Connect.

" } } }, @@ -36576,7 +36593,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,\n on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" + "smithy.api#documentation": "

The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,\n on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose\n Show additional flow information. The ContactFlowId is the last\n part of the ARN, shown here in bold:

\n

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n

" } }, "Attributes": { @@ -36638,7 +36655,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to set Contact Expiry as a duration in minutes and set a UserId for\n the User who created a task.

\n \n

To set contact expiry, a ValueMap must be specified containing the integer number of\n minutes the contact will be active for before expiring, with SegmentAttributes like\n { \"connect:ContactExpiry\": {\"ValueMap\" : { \"ExpiryDuration\": { \"ValueInteger\":\n 135}}}}.

\n

To set the created by user, a valid AgentResourceId must be supplied, with\n SegmentAttributes like { \"connect:CreatedByUser\" { \"ValueString\":\n \"arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"}}}.\n

\n " } } }, @@ -37561,7 +37578,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

Some of the supported resource types are agents, routing profiles, queues, quick connects,\n contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task\n templates. For a complete list, see Tagging resources in Amazon Connect.

\n

For sample policies that use tags, see Amazon Connect\n Identity-Based Policy Examples in the Amazon Connect Administrator\n Guide.

", + "smithy.api#documentation": "

Adds the specified tags to the specified resource.

\n

Some of the supported resource types are agents, routing profiles, queues, quick connects,\n flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates.\n For a complete list, see Tagging resources in Amazon Connect.

\n

For sample policies that use tags, see Amazon Connect\n Identity-Based Policy Examples in the Amazon Connect Administrator\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -38126,18 +38143,18 @@ "CustomAttributes": { "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

An object that specifies the custom attributes values to use for variables in the message\n template. This object contains different categories of key-value pairs. Each key defines a\n variable or placeholder in the message template.

" } }, "CustomerProfileAttributes": { "target": "com.amazonaws.connect#CustomerProfileAttributesSerialized", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

An object that specifies the customer profile attributes values to use for variables in the\n message template. This object contains different categories of key-value pairs. Each key defines\n a variable or placeholder in the message template.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about the template attributes.

" } }, "com.amazonaws.connect#TemplateId": { @@ -38155,27 +38172,27 @@ "KnowledgeBaseId": { "target": "com.amazonaws.connect#MessageTemplateKnowledgeBaseId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain\n the ARN.

", "smithy.api#required": {} } }, "MessageTemplateId": { "target": "com.amazonaws.connect#MessageTemplateId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the message template Id.

", "smithy.api#required": {} } }, "TemplateAttributes": { "target": "com.amazonaws.connect#TemplateAttributes", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Information about template attributes, that is, CustomAttributes or\n CustomerProfileAttributes.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Information about template message configuration.

" } }, "com.amazonaws.connect#Threshold": { @@ -39294,7 +39311,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

", + "smithy.api#documentation": "

Updates the specified flow.

\n

You can also create and update flows using the Amazon Connect\n Flow language.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

", "smithy.api#http": { "method": "POST", "uri": "/contact-flows/{InstanceId}/{ContactFlowId}/content", @@ -39455,7 +39472,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates specified flow module for the specified Amazon Connect instance.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

", + "smithy.api#documentation": "

Updates specified flow module for the specified Amazon Connect instance.

\n

Use the $SAVED alias in the request to describe the SAVED content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is\n published, $SAVED needs to be supplied to view saved content that has not been\n published.

", "smithy.api#http": { "method": "POST", "uri": "/contact-flow-modules/{InstanceId}/{ContactFlowModuleId}/content", @@ -39710,7 +39727,7 @@ "SegmentAttributes": { "target": "com.amazonaws.connect#SegmentAttributes", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A set of system defined key-value pairs stored on individual contact segments (unique\n contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.\n They can be accessed in flows.

\n

Attribute keys can include only alphanumeric, -, and _.

\n

This field can be used to show channel subtype, such as connect:Guide.

\n

Currently Contact Expiry is the only segment attribute which can be updated by using the\n UpdateContact API.

" } } }, @@ -39916,7 +39933,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Updates an email address metadata. For more information about email addresses, see Create email\n addresses in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/email-addresses/{InstanceId}/{EmailAddressId}", @@ -39930,7 +39947,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -39938,7 +39955,7 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the email address.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -39946,19 +39963,19 @@ "Description": { "target": "com.amazonaws.connect#Description", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The description of the email address.

" } }, "DisplayName": { "target": "com.amazonaws.connect#EmailAddressDisplayName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The display name of email address.

" } }, "ClientToken": { "target": "com.amazonaws.connect#ClientToken", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.

" } } }, @@ -39972,13 +39989,13 @@ "EmailAddressId": { "target": "com.amazonaws.connect#EmailAddressId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The identifier of the email address.

" } }, "EmailAddressArn": { "target": "com.amazonaws.connect#EmailAddressArn", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the email address.

" } } }, @@ -41073,7 +41090,7 @@ } ], "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Updates the outbound email address Id for a specified queue.

", "smithy.api#http": { "method": "POST", "uri": "/queues/{InstanceId}/{QueueId}/outbound-email-config", @@ -41087,7 +41104,7 @@ "InstanceId": { "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -41095,7 +41112,7 @@ "QueueId": { "target": "com.amazonaws.connect#QueueId", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The identifier for the queue.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -41103,7 +41120,7 @@ "OutboundEmailConfig": { "target": "com.amazonaws.connect#OutboundEmailConfig", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The outbound email address ID for a specified queue.

", "smithy.api#required": {} } } @@ -41920,7 +41937,7 @@ "SelfAssignFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The ContactFlowId for the flow that will be run if this template is used to create a\n self-assigned task.

" } }, "Constraints": { @@ -41994,7 +42011,7 @@ "SelfAssignFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The ContactFlowId for the flow that will be run if this template is used to create a\n self-assigned task.

" } }, "Constraints": { @@ -43268,12 +43285,12 @@ "UserId": { "target": "com.amazonaws.connect#AgentResourceId", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The user identifier for the contact.

" } } }, "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The user details for the contact.

" } }, "com.amazonaws.connect#UserNotFoundException": {