From aa53886739c6929e8e49d620ca9699e688e7270b Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 23 Oct 2024 19:52:04 +0000 Subject: [PATCH] feat(client-connect): Amazon Connect Service Feature: Add support to start screen sharing for a web calling contact. --- clients/client-connect/README.md | 10 +- clients/client-connect/src/Connect.ts | 23 ++++ clients/client-connect/src/ConnectClient.ts | 3 + ...iateTrafficDistributionGroupUserCommand.ts | 3 +- .../CreateTrafficDistributionGroupCommand.ts | 2 +- .../src/commands/DescribeContactCommand.ts | 2 + ...iateTrafficDistributionGroupUserCommand.ts | 3 +- .../src/commands/GetMetricDataV2Command.ts | 3 +- .../commands/ListTagsForResourceCommand.ts | 3 +- .../src/commands/StartScreenSharingCommand.ts | 111 ++++++++++++++++ .../src/commands/StartWebRTCContactCommand.ts | 2 + clients/client-connect/src/commands/index.ts | 1 + clients/client-connect/src/models/models_0.ts | 81 +++++------- clients/client-connect/src/models/models_1.ts | 112 +++++++++++----- clients/client-connect/src/models/models_2.ts | 44 ++++++- .../src/protocols/Aws_restJson1.ts | 44 ++++++- codegen/sdk-codegen/aws-models/connect.json | 121 ++++++++++++++++-- 17 files changed, 462 insertions(+), 106 deletions(-) create mode 100644 clients/client-connect/src/commands/StartScreenSharingCommand.ts diff --git a/clients/client-connect/README.md b/clients/client-connect/README.md index 128efc9116ed7..7fc9eb3cf0d77 100644 --- a/clients/client-connect/README.md +++ b/clients/client-connect/README.md @@ -33,7 +33,7 @@ a list of Amazon Connect endpoints, see void ): void; + /** + * @see {@link StartScreenSharingCommand} + */ + startScreenSharing( + args: StartScreenSharingCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startScreenSharing( + args: StartScreenSharingCommandInput, + cb: (err: any, data?: StartScreenSharingCommandOutput) => void + ): void; + startScreenSharing( + args: StartScreenSharingCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartScreenSharingCommandOutput) => void + ): void; + /** * @see {@link StartTaskContactCommand} */ diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts index d68e1293b744e..c33bf70875f8d 100644 --- a/clients/client-connect/src/ConnectClient.ts +++ b/clients/client-connect/src/ConnectClient.ts @@ -589,6 +589,7 @@ import { StartOutboundVoiceContactCommandInput, StartOutboundVoiceContactCommandOutput, } from "./commands/StartOutboundVoiceContactCommand"; +import { StartScreenSharingCommandInput, StartScreenSharingCommandOutput } from "./commands/StartScreenSharingCommand"; import { StartTaskContactCommandInput, StartTaskContactCommandOutput } from "./commands/StartTaskContactCommand"; import { StartWebRTCContactCommandInput, StartWebRTCContactCommandOutput } from "./commands/StartWebRTCContactCommand"; import { StopContactCommandInput, StopContactCommandOutput } from "./commands/StopContactCommand"; @@ -983,6 +984,7 @@ export type ServiceInputTypes = | StartContactStreamingCommandInput | StartOutboundChatContactCommandInput | StartOutboundVoiceContactCommandInput + | StartScreenSharingCommandInput | StartTaskContactCommandInput | StartWebRTCContactCommandInput | StopContactCommandInput @@ -1244,6 +1246,7 @@ export type ServiceOutputTypes = | StartContactStreamingCommandOutput | StartOutboundChatContactCommandOutput | StartOutboundVoiceContactCommandOutput + | StartScreenSharingCommandOutput | StartTaskContactCommandOutput | StartWebRTCContactCommandOutput | StopContactCommandOutput diff --git a/clients/client-connect/src/commands/AssociateTrafficDistributionGroupUserCommand.ts b/clients/client-connect/src/commands/AssociateTrafficDistributionGroupUserCommand.ts index e0c1fdfb249d9..cacde6e7c69e7 100644 --- a/clients/client-connect/src/commands/AssociateTrafficDistributionGroupUserCommand.ts +++ b/clients/client-connect/src/commands/AssociateTrafficDistributionGroupUserCommand.ts @@ -37,7 +37,8 @@ export interface AssociateTrafficDistributionGroupUserCommandOutput __MetadataBearer {} /** - *

Associates an agent with a traffic distribution group.

+ *

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is + * created.

* @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/CreateTrafficDistributionGroupCommand.ts b/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts index 8dc130037b010..dd8b869415019 100644 --- a/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts +++ b/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts @@ -33,7 +33,7 @@ export interface CreateTrafficDistributionGroupCommandOutput __MetadataBearer {} /** - *

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

+ *

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

* *

The SignInConfig distribution is available only on a * default TrafficDistributionGroup (see the IsDefault parameter in the diff --git a/clients/client-connect/src/commands/DescribeContactCommand.ts b/clients/client-connect/src/commands/DescribeContactCommand.ts index 8547c7908454a..3cbb2eeb52e56 100644 --- a/clients/client-connect/src/commands/DescribeContactCommand.ts +++ b/clients/client-connect/src/commands/DescribeContactCommand.ts @@ -90,6 +90,7 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _ * // }, * // Capabilities: { // ParticipantCapabilities * // Video: "SEND", + * // ScreenShare: "SEND", * // }, * // }, * // InitiationTimestamp: new Date("TIMESTAMP"), @@ -172,6 +173,7 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _ * // }, * // Capabilities: { * // Video: "SEND", + * // ScreenShare: "SEND", * // }, * // }, * // Campaign: { // Campaign diff --git a/clients/client-connect/src/commands/DisassociateTrafficDistributionGroupUserCommand.ts b/clients/client-connect/src/commands/DisassociateTrafficDistributionGroupUserCommand.ts index 3eab8aa1499ce..178ee6d8b3d8c 100644 --- a/clients/client-connect/src/commands/DisassociateTrafficDistributionGroupUserCommand.ts +++ b/clients/client-connect/src/commands/DisassociateTrafficDistributionGroupUserCommand.ts @@ -37,7 +37,8 @@ export interface DisassociateTrafficDistributionGroupUserCommandOutput __MetadataBearer {} /** - *

Disassociates an agent from a traffic distribution group.

+ *

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is + * created.

* @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/GetMetricDataV2Command.ts b/clients/client-connect/src/commands/GetMetricDataV2Command.ts index 0dd4e6da139df..e218cd94bb0f7 100644 --- a/clients/client-connect/src/commands/GetMetricDataV2Command.ts +++ b/clients/client-connect/src/commands/GetMetricDataV2Command.ts @@ -33,7 +33,8 @@ export interface GetMetricDataV2CommandOutput extends GetMetricDataV2Response, _ * GetMetricDataV2 offers more features than GetMetricData, the previous * version of this API. It has new metrics, offers filtering at a metric level, and offers the * ability to filter and group data by channels, queues, routing profiles, agents, and agent - * hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

+ * hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It + * does not support agent queues.

*

For a description of the historical metrics that are supported by * GetMetricDataV2 and GetMetricData, see Historical metrics * definitions in the Amazon Connect Administrator Guide.

diff --git a/clients/client-connect/src/commands/ListTagsForResourceCommand.ts b/clients/client-connect/src/commands/ListTagsForResourceCommand.ts index 0d715f31b3c4e..a7781fdca885c 100644 --- a/clients/client-connect/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-connect/src/commands/ListTagsForResourceCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_1"; +import { ListTagsForResourceRequest } from "../models/models_1"; +import { ListTagsForResourceResponse } from "../models/models_2"; import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/StartScreenSharingCommand.ts b/clients/client-connect/src/commands/StartScreenSharingCommand.ts new file mode 100644 index 0000000000000..d345c9f58c898 --- /dev/null +++ b/clients/client-connect/src/commands/StartScreenSharingCommand.ts @@ -0,0 +1,111 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { StartScreenSharingRequest, StartScreenSharingResponse } from "../models/models_2"; +import { de_StartScreenSharingCommand, se_StartScreenSharingCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartScreenSharingCommand}. + */ +export interface StartScreenSharingCommandInput extends StartScreenSharingRequest {} +/** + * @public + * + * The output of {@link StartScreenSharingCommand}. + */ +export interface StartScreenSharingCommandOutput extends StartScreenSharingResponse, __MetadataBearer {} + +/** + *

Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, + * video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, StartScreenSharingCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, StartScreenSharingCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // StartScreenSharingRequest + * ClientToken: "STRING_VALUE", + * InstanceId: "STRING_VALUE", // required + * ContactId: "STRING_VALUE", // required + * }; + * const command = new StartScreenSharingCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param StartScreenSharingCommandInput - {@link StartScreenSharingCommandInput} + * @returns {@link StartScreenSharingCommandOutput} + * @see {@link StartScreenSharingCommandInput} for command's `input` shape. + * @see {@link StartScreenSharingCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

You do not have sufficient permissions to perform this action.

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

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

+ * + * @throws {@link InvalidParameterException} (client fault) + *

One or more of the specified parameters are not valid.

+ * + * @throws {@link InvalidRequestException} (client fault) + *

The request is not valid.

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

The specified resource was not found.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The throttling limit has been exceeded.

+ * + * @throws {@link ConnectServiceException} + *

Base exception class for all service exceptions from Connect service.

+ * + * @public + */ +export class StartScreenSharingCommand extends $Command + .classBuilder< + StartScreenSharingCommandInput, + StartScreenSharingCommandOutput, + ConnectClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonConnectService", "StartScreenSharing", {}) + .n("ConnectClient", "StartScreenSharingCommand") + .f(void 0, void 0) + .ser(se_StartScreenSharingCommand) + .de(de_StartScreenSharingCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartScreenSharingRequest; + output: {}; + }; + sdk: { + input: StartScreenSharingCommandInput; + output: StartScreenSharingCommandOutput; + }; + }; +} diff --git a/clients/client-connect/src/commands/StartWebRTCContactCommand.ts b/clients/client-connect/src/commands/StartWebRTCContactCommand.ts index ad91257ad8a03..36b160631baea 100644 --- a/clients/client-connect/src/commands/StartWebRTCContactCommand.ts +++ b/clients/client-connect/src/commands/StartWebRTCContactCommand.ts @@ -51,9 +51,11 @@ export interface StartWebRTCContactCommandOutput extends StartWebRTCContactRespo * AllowedCapabilities: { // AllowedCapabilities * Customer: { // ParticipantCapabilities * Video: "SEND", + * ScreenShare: "SEND", * }, * Agent: { * Video: "SEND", + * ScreenShare: "SEND", * }, * }, * ParticipantDetails: { // ParticipantDetails diff --git a/clients/client-connect/src/commands/index.ts b/clients/client-connect/src/commands/index.ts index 28765dabb0c7a..1c9d10067a90f 100644 --- a/clients/client-connect/src/commands/index.ts +++ b/clients/client-connect/src/commands/index.ts @@ -196,6 +196,7 @@ export * from "./StartContactRecordingCommand"; export * from "./StartContactStreamingCommand"; export * from "./StartOutboundChatContactCommand"; export * from "./StartOutboundVoiceContactCommand"; +export * from "./StartScreenSharingCommand"; export * from "./StartTaskContactCommand"; export * from "./StartWebRTCContactCommand"; export * from "./StopContactCommand"; diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts index 1a7d40166cdc6..fbe73a8c64afc 100644 --- a/clients/client-connect/src/models/models_0.ts +++ b/clients/client-connect/src/models/models_0.ts @@ -449,6 +449,19 @@ export interface AgentHierarchyGroups { L5Ids?: string[]; } +/** + * @public + * @enum + */ +export const ScreenShareCapability = { + SEND: "SEND", +} as const; + +/** + * @public + */ +export type ScreenShareCapability = (typeof ScreenShareCapability)[keyof typeof ScreenShareCapability]; + /** * @public * @enum @@ -463,17 +476,24 @@ export const VideoCapability = { export type VideoCapability = (typeof VideoCapability)[keyof typeof VideoCapability]; /** - *

The configuration for the allowed capabilities for participants present over the - * call.

+ *

The configuration for the allowed video and screen sharing capabilities for participants present over the + * call. For more information, see Set up in-app, web, + * video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

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

The configuration having the video sharing capabilities for participants over the + *

The configuration having the video and screen sharing capabilities for participants over the * call.

* @public */ Video?: VideoCapability; + + /** + *

The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.

+ * @public + */ + ScreenShare?: ScreenShareCapability; } /** @@ -573,8 +593,9 @@ export interface AgentInfo { DeviceInfo?: DeviceInfo; /** - *

The configuration for the allowed capabilities for participants present over the - * call.

+ *

The configuration for the allowed video and screen sharing capabilities for participants present over the + * call. For more information, see Set up in-app, web, + * video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

* @public */ Capabilities?: ParticipantCapabilities; @@ -1772,8 +1793,7 @@ export interface AssociateSecurityKeyResponse { export interface AssociateTrafficDistributionGroupUserRequest { /** *

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.

+ * This can be the ID or the ARN of the traffic distribution group.

* @public */ TrafficDistributionGroupId: string | undefined; @@ -5453,8 +5473,7 @@ export interface CreateTrafficDistributionGroupRequest { export interface CreateTrafficDistributionGroupResponse { /** *

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.

+ * This can be the ID or the ARN of the traffic distribution group.

* @public */ Id?: string; @@ -6589,8 +6608,7 @@ export interface DeleteTaskTemplateResponse {} export interface DeleteTrafficDistributionGroupRequest { /** *

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.

+ * This can be the ID or the ARN of the traffic distribution group.

* @public */ TrafficDistributionGroupId: string | undefined; @@ -6961,8 +6979,9 @@ export interface Customer { DeviceInfo?: DeviceInfo; /** - *

The configuration for the allowed capabilities for participants present over the - * call.

+ *

The configuration for the allowed video and screen sharing capabilities for participants present over the + * call. For more information, see Set up in-app, web, + * video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

* @public */ Capabilities?: ParticipantCapabilities; @@ -7078,42 +7097,6 @@ export interface MatchCriteria { AgentsCriteria?: AgentsCriteria; } -/** - *

An object to specify the predefined attribute condition.

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

The name of predefined attribute.

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

The value of predefined attribute.

- * @public - */ - Value?: string; - - /** - *

The proficiency level of the condition.

- * @public - */ - ProficiencyLevel?: number; - - /** - *

An object to define AgentsCriteria.

- * @public - */ - MatchCriteria?: MatchCriteria; - - /** - *

The operator of the condition.

- * @public - */ - ComparisonOperator?: string; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts index deeb9248bc5d6..9cc179b8255f7 100644 --- a/clients/client-connect/src/models/models_1.ts +++ b/clients/client-connect/src/models/models_1.ts @@ -32,6 +32,7 @@ import { LexBot, LexV2Bot, ListFlowAssociationResourceType, + MatchCriteria, MediaConcurrency, OutboundCallerConfig, ParticipantRole, @@ -58,6 +59,42 @@ import { VocabularyState, } from "./models_0"; +/** + *

An object to specify the predefined attribute condition.

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

The name of predefined attribute.

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

The value of predefined attribute.

+ * @public + */ + Value?: string; + + /** + *

The proficiency level of the condition.

+ * @public + */ + ProficiencyLevel?: number; + + /** + *

An object to define AgentsCriteria.

+ * @public + */ + MatchCriteria?: MatchCriteria; + + /** + *

The operator of the condition.

+ * @public + */ + ComparisonOperator?: string; +} + /** * @public * @enum @@ -3025,8 +3062,7 @@ export interface DisassociateSecurityKeyRequest { export interface DisassociateTrafficDistributionGroupUserRequest { /** *

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.

+ * This can be the ID or the ARN of the traffic distribution group.

* @public */ TrafficDistributionGroupId: string | undefined; @@ -4626,35 +4662,52 @@ export interface IntervalDetails { export interface MetricFilterV2 { /** *

The key to use for filtering data.

- *

Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON. - * These are the same values as the InitiationMethod and DisconnectReason - * in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide. - *

+ *

Valid metric filter keys:

+ * * @public */ MetricFilterKey?: string; /** - *

The values to use for filtering data.

- *

Valid metric filter values for INITIATION_METHOD: INBOUND | - * OUTBOUND | TRANSFER | QUEUE_TRANSFER | - * CALLBACK | API | WEBRTC_API | MONITOR | - * DISCONNECT | EXTERNAL_OUTBOUND - *

- *

Valid metric filter values for DISCONNECT_REASON: - * CUSTOMER_DISCONNECT | AGENT_DISCONNECT | - * THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED | - * CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | - * API - *

+ *

The values to use for filtering data. Values for metric-level filters can be either a fixed + * set of values or a customized list, depending on the use case.

+ *

For valid values of metric-level filters INITIATION_METHOD, + * DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.

+ *

For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description + * for the Flow outcome metric in the Amazon Connect Administrator + * Guide.

* @public */ MetricFilterValues?: string[]; /** - *

The flag to use to filter on requested metric filter values or to not filter on requested - * metric filter values. By default the negate is false, which indicates to filter on - * the requested metric filter.

+ *

If set to true, the API response contains results that filter out the results matched + * by the metric-level filters condition. By default, Negate is set to false.

* @public */ Negate?: boolean; @@ -5016,7 +5069,7 @@ export interface GetMetricDataV2Request { *

UI name: Average agent API connecting time *

* - *

The Negate key in Metric Level Filters is not applicable for this + *

The Negate key in metric-level filters is not applicable for this * metric.

* * @@ -5383,7 +5436,7 @@ export interface GetMetricDataV2Request { *

Unit: Count

*

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, * Q in Connect

- *

Threshold: For ThresholdValue enter any whole number from 1 to 604800 + *

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 * (inclusive), in seconds. For Comparison, you can use LT (for "Less * than") or LTE (for "Less than equal").

*

UI name: Contacts resolved in X @@ -5636,7 +5689,7 @@ export interface GetMetricDataV2Request { *

UI name: Agent API connecting time *

* - *

The Negate key in Metric Level Filters is not applicable for this + *

The Negate key in metric-level filters is not applicable for this * metric.

* * @@ -9856,17 +9909,6 @@ export interface ListTagsForResourceRequest { resourceArn: string | undefined; } -/** - * @public - */ -export interface ListTagsForResourceResponse { - /** - *

Information about the tags.

- * @public - */ - tags?: Record; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_2.ts b/clients/client-connect/src/models/models_2.ts index 4ce7c186d6ee1..9869851f824cf 100644 --- a/clients/client-connect/src/models/models_2.ts +++ b/clients/client-connect/src/models/models_2.ts @@ -14,7 +14,6 @@ import { AllowedCapabilities, AnsweringMachineDetectionStatus, Application, - AttributeCondition, Campaign, Channel, ContactFlowStatus, @@ -70,6 +69,7 @@ import { } from "./models_0"; import { + AttributeCondition, ContactFlow, ContactFlowModule, ContactFlowModuleState, @@ -99,6 +99,17 @@ import { WisdomInfo, } from "./models_1"; +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + *

Information about the tags.

+ * @public + */ + tags?: Record; +} + /** * @public */ @@ -3892,6 +3903,37 @@ export interface StartOutboundVoiceContactResponse { ContactId?: string; } +/** + * @public + */ +export interface StartScreenSharingRequest { + /** + *

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; + + /** + *

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; +} + +/** + * @public + */ +export interface StartScreenSharingResponse {} + /** * @public */ diff --git a/clients/client-connect/src/protocols/Aws_restJson1.ts b/clients/client-connect/src/protocols/Aws_restJson1.ts index c67e4db0d32f6..de05439981c78 100644 --- a/clients/client-connect/src/protocols/Aws_restJson1.ts +++ b/clients/client-connect/src/protocols/Aws_restJson1.ts @@ -572,6 +572,7 @@ import { StartOutboundVoiceContactCommandInput, StartOutboundVoiceContactCommandOutput, } from "../commands/StartOutboundVoiceContactCommand"; +import { StartScreenSharingCommandInput, StartScreenSharingCommandOutput } from "../commands/StartScreenSharingCommand"; import { StartTaskContactCommandInput, StartTaskContactCommandOutput } from "../commands/StartTaskContactCommand"; import { StartWebRTCContactCommandInput, StartWebRTCContactCommandOutput } from "../commands/StartWebRTCContactCommand"; import { StopContactCommandInput, StopContactCommandOutput } from "../commands/StopContactCommand"; @@ -770,7 +771,6 @@ import { AllowedCapabilities, Application, AssignContactCategoryActionDefinition, - AttributeCondition, AudioQualityMetricsInfo, AuthenticationProfile, Campaign, @@ -871,6 +871,7 @@ import { ViewInputContent, } from "../models/models_0"; import { + AttributeCondition, AuthenticationProfileSummary, ContactFilter, ContactFlowNotPublishedException, @@ -5372,6 +5373,30 @@ export const se_StartOutboundVoiceContactCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1StartScreenSharingCommand + */ +export const se_StartScreenSharingCommand = async ( + input: StartScreenSharingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/contact/screen-sharing"); + let body: any; + body = JSON.stringify( + take(input, { + ClientToken: [true, (_) => _ ?? generateIdempotencyToken()], + ContactId: [], + InstanceId: [], + }) + ); + b.m("PUT").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1StartTaskContactCommand */ @@ -10942,6 +10967,23 @@ export const de_StartOutboundVoiceContactCommand = async ( return contents; }; +/** + * deserializeAws_restJson1StartScreenSharingCommand + */ +export const de_StartScreenSharingCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + await collectBody(output.body, context); + return contents; +}; + /** * deserializeAws_restJson1StartTaskContactCommand */ diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 40ddf1db8630a..245849ab1e534 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -1460,6 +1460,9 @@ { "target": "com.amazonaws.connect#StartOutboundVoiceContact" }, + { + "target": "com.amazonaws.connect#StartScreenSharing" + }, { "target": "com.amazonaws.connect#StartTaskContact" }, @@ -3570,7 +3573,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates an agent with a traffic distribution group.

", + "smithy.api#documentation": "

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is\n created.

", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", @@ -3585,7 +3588,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The identifier of the traffic distribution group.\nThis can be the ID or the ARN of the traffic distribution group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8463,7 +8466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

\n \n

The SignInConfig distribution is available only on a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.

\n \n

For more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

\n \n

The SignInConfig distribution is available only on a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.

\n \n

For more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution-group", @@ -8518,7 +8521,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupId", "traits": { - "smithy.api#documentation": "

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

" + "smithy.api#documentation": "

The identifier of the traffic distribution group.\nThis can be the ID or the ARN of the traffic distribution group.

" } }, "Arn": { @@ -10697,7 +10700,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The identifier of the traffic distribution group.\nThis can be the ID or the ARN of the traffic distribution group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13819,7 +13822,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disassociates an agent from a traffic distribution group.

", + "smithy.api#documentation": "

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is\n created.

", "smithy.api#http": { "method": "DELETE", "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", @@ -13834,7 +13837,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "

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

", + "smithy.api#documentation": "

The identifier of the traffic distribution group.\nThis can be the ID or the ARN of the traffic distribution group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16884,7 +16887,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets metric data from the specified Amazon Connect instance.

\n

\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals.

\n

For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator Guide.

", + "smithy.api#documentation": "

Gets metric data from the specified Amazon Connect instance.

\n

\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It\n does not support agent queues.

\n

For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator Guide.

", "smithy.api#http": { "method": "POST", "uri": "/metrics/data", @@ -16943,7 +16946,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator\n Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Abandonment rate\n

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherent time\n

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent answer rate\n

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Non-adherent time\n

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n non-response\n

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n

UI name: Agent non-response without customer abandons\n

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Occupancy\n

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherence\n

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Scheduled time\n

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average queue abandon time\n

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average active time\n

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average after contact work time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Average agent API connecting time\n

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n \n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average agent pause time\n

\n
\n
AVG_CASE_RELATED_CONTACTS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average contacts per case\n

\n
\n
AVG_CASE_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average case resolution time\n

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average contact duration\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average conversation duration\n

\n
\n
AVG_DIALS_PER_MINUTE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile

\n

UI name: Average dials per minute\n

\n
\n
AVG_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Average flow time\n

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent greeting time\n

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n

UI name: Average handle time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer hold time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer hold time all contacts\n

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average holds\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interruptions\n

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interruption time\n

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average non-talk time\n

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average queue answer time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Average resolution time\n

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average talk time\n

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent talk time\n

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer talk time\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Campaign

\n

UI name: Average wait time after customer connection\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Percent

\n

Valid groupings and filters: Campaign, Agent

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X rate\n

\n
\n
CASES_CREATED
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases created\n

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts created\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: API contacts handled\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts handled (connected to agent timestamp)\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts hold disconnect\n

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold agent disconnect\n

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold customer disconnect\n

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts put on hold\n

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out external\n

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out internal\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts queued\n

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n

UI name: Contacts queued (enqueue timestamp)\n

\n
\n
CONTACTS_REMOVED_FROM_QUEUE_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts removed from queue in X seconds\n

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts resolved in X\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out by agent\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out queue\n

\n
\n
CURRENT_CASES
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Current cases\n

\n
\n
DELIVERY_ATTEMPTS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status,\n Disconnect Reason

\n

UI name: Delivery attempts\n

\n
\n
DELIVERY_ATTEMPT_DISPOSITION_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Percent

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason

\n \n

Answering Machine Detection Status and Disconnect Reason are valid filters but not valid\n groupings.

\n \n

UI name: Delivery attempt disposition rate\n

\n
\n
FLOWS_OUTCOME
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome\n

\n
\n
FLOWS_STARTED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows started\n

\n
\n
HUMAN_ANSWERED_CALLS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

UI name: Human answered\n

\n
\n
MAX_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Maximum flow time\n

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Maximum queued time\n

\n
\n
MIN_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Minimum flow time\n

\n
\n
PERCENT_CASES_FIRST_CONTACT_RESOLVED
\n
\n

Unit: Percent

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved on first contact\n

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_FLOWS_OUTCOME
\n
\n

Unit: Percent

\n

Valid metric filter key: FLOWS_OUTCOME_TYPE\n

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome percentage.

\n \n

The FLOWS_OUTCOME_TYPE is not a valid grouping.

\n \n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Non-talk\n time percent\n

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Talk time\n percent\n

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Agent\n talk time percent\n

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Customer talk time percent\n

\n
\n
REOPENED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases reopened\n

\n
\n
RESOLVED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved\n

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Service level X\n

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: After\n contact work time\n

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent API connecting time\n

\n \n

The Negate key in Metric Level Filters is not applicable for this\n metric.

\n \n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Metric filter:

\n
    \n
  • \n

    Valid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n

    \n
    • \n
\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: Contact abandoned\n

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts abandoned in X seconds\n

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts answered in X seconds\n

\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact flow time\n

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent on contact time\n

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contact disconnected\n

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Error status time\n

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact handle time\n

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Customer hold time\n

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent idle time\n

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Agent interaction and hold time\n

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent interaction time\n

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Non-Productive Time\n

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Online time\n

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Callback attempts\n

\n
\n
", + "smithy.api#documentation": "

The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator\n Guide.

\n
\n
ABANDONMENT_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Abandonment rate\n

\n
\n
AGENT_ADHERENT_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherent time\n

\n
\n
AGENT_ANSWER_RATE
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent answer rate\n

\n
\n
AGENT_NON_ADHERENT_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Non-adherent time\n

\n
\n
AGENT_NON_RESPONSE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent\n non-response\n

\n
\n
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

Data for this metric is available starting from October 1, 2023 0:00:00 GMT.

\n

UI name: Agent non-response without customer abandons\n

\n
\n
AGENT_OCCUPANCY
\n
\n

Unit: Percentage

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Occupancy\n

\n
\n
AGENT_SCHEDULE_ADHERENCE
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Adherence\n

\n
\n
AGENT_SCHEDULED_TIME
\n
\n

This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Scheduled time\n

\n
\n
AVG_ABANDON_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average queue abandon time\n

\n
\n
AVG_ACTIVE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average active time\n

\n
\n
AVG_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average after contact work time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_AGENT_CONNECTING_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Average agent API connecting time\n

\n \n

The Negate key in metric-level filters is not applicable for this\n metric.

\n \n
\n
AVG_AGENT_PAUSE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Average agent pause time\n

\n
\n
AVG_CASE_RELATED_CONTACTS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average contacts per case\n

\n
\n
AVG_CASE_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Average case resolution time\n

\n
\n
AVG_CONTACT_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average contact duration\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_CONVERSATION_DURATION
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average conversation duration\n

\n
\n
AVG_DIALS_PER_MINUTE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile

\n

UI name: Average dials per minute\n

\n
\n
AVG_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Average flow time\n

\n
\n
AVG_GREETING_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent greeting time\n

\n
\n
AVG_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression

\n

UI name: Average handle time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer hold time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_HOLD_TIME_ALL_CONTACTS
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer hold time all contacts\n

\n
\n
AVG_HOLDS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average holds\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction and customer hold time\n

\n
\n
AVG_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interaction time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_INTERRUPTIONS_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interruptions\n

\n
\n
AVG_INTERRUPTION_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent interruption time\n

\n
\n
AVG_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average non-talk time\n

\n
\n
AVG_QUEUE_ANSWER_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average queue answer time\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
AVG_RESOLUTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Average resolution time\n

\n
\n
AVG_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average talk time\n

\n
\n
AVG_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average agent talk time\n

\n
\n
AVG_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Average customer talk time\n

\n
\n
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Seconds

\n

Valid groupings and filters: Campaign

\n

UI name: Average wait time after customer connection\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X\n

\n
\n
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Percent

\n

Valid groupings and filters: Campaign, Agent

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).

\n

UI name: Campaign contacts abandoned after X rate\n

\n
\n
CASES_CREATED
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases created\n

\n
\n
CONTACTS_CREATED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts created\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: API contacts handled\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
\n
\n

Unit: Count

\n

Valid metric filter key: INITIATION_METHOD\n

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts handled (connected to agent timestamp)\n

\n
\n
CONTACTS_HOLD_ABANDONS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts hold disconnect\n

\n
\n
CONTACTS_ON_HOLD_AGENT_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold agent disconnect\n

\n
\n
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts hold customer disconnect\n

\n
\n
CONTACTS_PUT_ON_HOLD
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts put on hold\n

\n
\n
CONTACTS_TRANSFERRED_OUT_EXTERNAL
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out external\n

\n
\n
CONTACTS_TRANSFERRED_OUT_INTERNAL
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contacts transferred out internal\n

\n
\n
CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts queued\n

\n
\n
CONTACTS_QUEUED_BY_ENQUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype

\n

UI name: Contacts queued (enqueue timestamp)\n

\n
\n
CONTACTS_REMOVED_FROM_QUEUE_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts removed from queue in X seconds\n

\n
\n
CONTACTS_RESOLVED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts resolved in X\n

\n
\n
CONTACTS_TRANSFERRED_OUT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out\n

\n \n

Feature is a valid filter but not a valid grouping.

\n \n
\n
CONTACTS_TRANSFERRED_OUT_BY_AGENT
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out by agent\n

\n
\n
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contacts transferred out queue\n

\n
\n
CURRENT_CASES
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Current cases\n

\n
\n
DELIVERY_ATTEMPTS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns\n analytics.

\n

Unit: Count

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Campaign, Agent, Queue, Routing Profile, Answering Machine Detection Status,\n Disconnect Reason

\n

UI name: Delivery attempts\n

\n
\n
DELIVERY_ATTEMPT_DISPOSITION_RATE
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Percent

\n

Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n DISCONNECT_REASON\n

\n

Valid groupings and filters: Campaign, Agent, Answering Machine Detection Status, Disconnect Reason

\n \n

Answering Machine Detection Status and Disconnect Reason are valid filters but not valid\n groupings.

\n \n

UI name: Delivery attempt disposition rate\n

\n
\n
FLOWS_OUTCOME
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome\n

\n
\n
FLOWS_STARTED
\n
\n

Unit: Count

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows started\n

\n
\n
HUMAN_ANSWERED_CALLS
\n
\n

This metric is available only for contacts analyzed by outbound campaigns analytics, and\n with the answering machine detection enabled.

\n

Unit: Count

\n

Valid groupings and filters: Campaign, Agent

\n

UI name: Human answered\n

\n
\n
MAX_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Maximum flow time\n

\n
\n
MAX_QUEUED_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Maximum queued time\n

\n
\n
MIN_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Minimum flow time\n

\n
\n
PERCENT_CASES_FIRST_CONTACT_RESOLVED
\n
\n

Unit: Percent

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved on first contact\n

\n
\n
PERCENT_CONTACTS_STEP_EXPIRED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_CONTACTS_STEP_JOINED
\n
\n

Unit: Percent

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
PERCENT_FLOWS_OUTCOME
\n
\n

Unit: Percent

\n

Valid metric filter key: FLOWS_OUTCOME_TYPE\n

\n

Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp

\n

UI name: Flows outcome percentage.

\n \n

The FLOWS_OUTCOME_TYPE is not a valid grouping.

\n \n
\n
PERCENT_NON_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Non-talk\n time percent\n

\n
\n
PERCENT_TALK_TIME
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Talk time\n percent\n

\n
\n
PERCENT_TALK_TIME_AGENT
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Agent\n talk time percent\n

\n
\n
PERCENT_TALK_TIME_CUSTOMER
\n
\n

This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.

\n

Unit: Percentage

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Customer talk time percent\n

\n
\n
REOPENED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases reopened\n

\n
\n
RESOLVED_CASE_ACTIONS
\n
\n

Unit: Count

\n

Required filter key: CASE_TEMPLATE_ARN

\n

Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS

\n

UI name: Cases resolved\n

\n
\n
SERVICE_LEVEL
\n
\n

You can include up to 20 SERVICE_LEVEL metrics in a request.

\n

Unit: Percent

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Service level X\n

\n
\n
STEP_CONTACTS_QUEUED
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, RoutingStepExpression

\n

UI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.

\n
\n
SUM_AFTER_CONTACT_WORK_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: After\n contact work time\n

\n
\n
SUM_CONNECTING_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent API connecting time\n

\n \n

The Negate key in metric-level filters is not applicable for this\n metric.

\n \n
\n
CONTACTS_ABANDONED
\n
\n

Unit: Count

\n

Metric filter:

\n
    \n
  • \n

    Valid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n

    \n
    • \n
\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect

\n

UI name: Contact abandoned\n

\n
\n
SUM_CONTACTS_ABANDONED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts abandoned in X seconds\n

\n
\n
SUM_CONTACTS_ANSWERED_IN_X
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

Threshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").

\n

UI name: Contacts answered in X seconds\n

\n
\n
SUM_CONTACT_FLOW_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact flow time\n

\n
\n
SUM_CONTACT_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent on contact time\n

\n
\n
SUM_CONTACTS_DISCONNECTED
\n
\n

Valid metric filter key: DISCONNECT_REASON\n

\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect

\n

UI name: Contact disconnected\n

\n
\n
SUM_ERROR_STATUS_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Error status time\n

\n
\n
SUM_HANDLE_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Contact handle time\n

\n
\n
SUM_HOLD_TIME
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Customer hold time\n

\n
\n
SUM_IDLE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent idle time\n

\n
\n
SUM_INTERACTION_AND_HOLD_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect

\n

UI name: Agent interaction and hold time\n

\n
\n
SUM_INTERACTION_TIME
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy

\n

UI name: Agent interaction time\n

\n
\n
SUM_NON_PRODUCTIVE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Non-Productive Time\n

\n
\n
SUM_ONLINE_TIME_AGENT
\n
\n

Unit: Seconds

\n

Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy

\n

UI name: Online time\n

\n
\n
SUM_RETRY_CALLBACK_ATTEMPTS
\n
\n

Unit: Count

\n

Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect

\n

UI name: Callback attempts\n

\n
\n
", "smithy.api#required": {} } }, @@ -24198,20 +24201,20 @@ "MetricFilterKey": { "target": "com.amazonaws.connect#String", "traits": { - "smithy.api#documentation": "

The key to use for filtering data.

\n

Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON.\n These are the same values as the InitiationMethod and DisconnectReason\n in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator Guide.\n

" + "smithy.api#documentation": "

The key to use for filtering data.

\n

Valid metric filter keys:

\n
    \n
  • \n

    ANSWERING_MACHINE_DETECTION_STATUS

    \n
    • \n
  • \n

    CASE_STATUS

    \n
    • \n
  • \n

    DISCONNECT_REASON

    \n
    • \n
  • \n

    FLOWS_ACTION_IDENTIFIER

    \n
    • \n
  • \n

    FLOWS_NEXT_ACTION_IDENTIFIER

    \n
    • \n
  • \n

    FLOWS_OUTCOME_TYPE

    \n
    • \n
  • \n

    FLOWS_RESOURCE_TYPE

    \n
    • \n
  • \n

    INITIATION_METHOD

    \n
    • \n
" } }, "MetricFilterValues": { "target": "com.amazonaws.connect#MetricFilterValueList", "traits": { - "smithy.api#documentation": "

The values to use for filtering data.

\n

Valid metric filter values for INITIATION_METHOD: INBOUND |\n OUTBOUND | TRANSFER | QUEUE_TRANSFER |\n CALLBACK | API | WEBRTC_API | MONITOR |\n DISCONNECT | EXTERNAL_OUTBOUND\n

\n

Valid metric filter values for DISCONNECT_REASON:\n CUSTOMER_DISCONNECT | AGENT_DISCONNECT |\n THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED |\n CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED |\n API\n

" + "smithy.api#documentation": "

The values to use for filtering data. Values for metric-level filters can be either a fixed\n set of values or a customized list, depending on the use case.

\n

For valid values of metric-level filters INITIATION_METHOD,\n DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.

\n

For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description\n for the Flow outcome metric in the Amazon Connect Administrator\n Guide.

" } }, "Negate": { "target": "com.amazonaws.connect#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

The flag to use to filter on requested metric filter values or to not filter on requested\n metric filter values. By default the negate is false, which indicates to filter on\n the requested metric filter.

" + "smithy.api#documentation": "

If set to true, the API response contains results that filter out the results matched\n by the metric-level filters condition. By default, Negate is set to false.

" } } }, @@ -24866,12 +24869,18 @@ "Video": { "target": "com.amazonaws.connect#VideoCapability", "traits": { - "smithy.api#documentation": "

The configuration having the video sharing capabilities for participants over the\n call.

" + "smithy.api#documentation": "

The configuration having the video and screen sharing capabilities for participants over the\n call.

" + } + }, + "ScreenShare": { + "target": "com.amazonaws.connect#ScreenShareCapability", + "traits": { + "smithy.api#documentation": "

The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration for the allowed capabilities for participants present over the\n call.

" + "smithy.api#documentation": "

The configuration for the allowed video and screen sharing capabilities for participants present over the\n call. For more information, see Set up in-app, web,\n video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

" } }, "com.amazonaws.connect#ParticipantDetails": { @@ -30472,6 +30481,17 @@ "smithy.api#pattern": "^s3://\\S+/.+|https://\\\\S+\\\\.s3\\\\.\\\\S+\\\\.amazonaws\\\\.com/\\\\S+$" } }, + "com.amazonaws.connect#ScreenShareCapability": { + "type": "enum", + "members": { + "SEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND" + } + } + } + }, "com.amazonaws.connect#SearchAgentStatuses": { "type": "operation", "input": { @@ -33957,6 +33977,79 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#StartScreenSharing": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#StartScreenSharingRequest" + }, + "output": { + "target": "com.amazonaws.connect#StartScreenSharingResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web,\n video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/contact/screen-sharing", + "code": 200 + } + } + }, + "com.amazonaws.connect#StartScreenSharingRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "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": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "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": "

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

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#StartScreenSharingResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#StartTaskContact": { "type": "operation", "input": {