From 226e9c6fef555fcea844cff6fc002d5d3c052d9e Mon Sep 17 00:00:00 2001
From: awstools
* Amazon Connect
- * data types
+ * data types
*
* Amazon Connect
- * data types
+ * data types
* Searches AgentStatuses in an Amazon Connect instance, with optional filtering. Request processing failed because of an error or failure with the service. One or more of the specified parameters are not valid. The request is not valid. The specified resource was not found. The throttling limit has been exceeded. Base exception class for all service exceptions from Connect service. Searches UserHierarchyGroups in an Amazon Connect instance, with optional
+ * filtering. The UserHierarchyGroup with Request processing failed because of an error or failure with the service. One or more of the specified parameters are not valid. The request is not valid. The specified resource was not found. The throttling limit has been exceeded. Base exception class for all service exceptions from Connect service.
* Amazon Connect
- * data types
+ * data types
* Can be used to define a list of preferred agents to target the contact within the queue.
- * Note that agents must have the queue in their routing profile in order to be offered the
- * contact.
+SearchAgentStatuses
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchAgentStatusesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchAgentStatusesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchAgentStatusesCommandOutput/)
+
@@ -1706,6 +1713,14 @@ SearchSecurityProfiles
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchSecurityProfilesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchSecurityProfilesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchSecurityProfilesCommandOutput/)
+
+SearchUserHierarchyGroups
+
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchUserHierarchyGroupsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchUserHierarchyGroupsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchUserHierarchyGroupsCommandOutput/)
+
diff --git a/clients/client-connect/src/Connect.ts b/clients/client-connect/src/Connect.ts
index b088625409e3..5e7fc0fbfe95 100644
--- a/clients/client-connect/src/Connect.ts
+++ b/clients/client-connect/src/Connect.ts
@@ -807,6 +807,11 @@ import {
ResumeContactRecordingCommandInput,
ResumeContactRecordingCommandOutput,
} from "./commands/ResumeContactRecordingCommand";
+import {
+ SearchAgentStatusesCommand,
+ SearchAgentStatusesCommandInput,
+ SearchAgentStatusesCommandOutput,
+} from "./commands/SearchAgentStatusesCommand";
import {
SearchAvailablePhoneNumbersCommand,
SearchAvailablePhoneNumbersCommandInput,
@@ -867,6 +872,11 @@ import {
SearchSecurityProfilesCommandInput,
SearchSecurityProfilesCommandOutput,
} from "./commands/SearchSecurityProfilesCommand";
+import {
+ SearchUserHierarchyGroupsCommand,
+ SearchUserHierarchyGroupsCommandInput,
+ SearchUserHierarchyGroupsCommandOutput,
+} from "./commands/SearchUserHierarchyGroupsCommand";
import { SearchUsersCommand, SearchUsersCommandInput, SearchUsersCommandOutput } from "./commands/SearchUsersCommand";
import {
SearchVocabulariesCommand,
@@ -1363,6 +1373,7 @@ const commands = {
ReplicateInstanceCommand,
ResumeContactCommand,
ResumeContactRecordingCommand,
+ SearchAgentStatusesCommand,
SearchAvailablePhoneNumbersCommand,
SearchContactFlowModulesCommand,
SearchContactFlowsCommand,
@@ -1375,6 +1386,7 @@ const commands = {
SearchResourceTagsCommand,
SearchRoutingProfilesCommand,
SearchSecurityProfilesCommand,
+ SearchUserHierarchyGroupsCommand,
SearchUsersCommand,
SearchVocabulariesCommand,
SendChatIntegrationEventCommand,
@@ -4165,6 +4177,23 @@ export interface Connect {
cb: (err: any, data?: ResumeContactRecordingCommandOutput) => void
): void;
+ /**
+ * @see {@link SearchAgentStatusesCommand}
+ */
+ searchAgentStatuses(
+ args: SearchAgentStatusesCommandInput,
+ options?: __HttpHandlerOptions
+ ): Promise
*
diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts
index 88824e6a7db6..a4a3ee161a84 100644
--- a/clients/client-connect/src/ConnectClient.ts
+++ b/clients/client-connect/src/ConnectClient.ts
@@ -517,6 +517,10 @@ import {
ResumeContactRecordingCommandInput,
ResumeContactRecordingCommandOutput,
} from "./commands/ResumeContactRecordingCommand";
+import {
+ SearchAgentStatusesCommandInput,
+ SearchAgentStatusesCommandOutput,
+} from "./commands/SearchAgentStatusesCommand";
import {
SearchAvailablePhoneNumbersCommandInput,
SearchAvailablePhoneNumbersCommandOutput,
@@ -550,6 +554,10 @@ import {
SearchSecurityProfilesCommandInput,
SearchSecurityProfilesCommandOutput,
} from "./commands/SearchSecurityProfilesCommand";
+import {
+ SearchUserHierarchyGroupsCommandInput,
+ SearchUserHierarchyGroupsCommandOutput,
+} from "./commands/SearchUserHierarchyGroupsCommand";
import { SearchUsersCommandInput, SearchUsersCommandOutput } from "./commands/SearchUsersCommand";
import { SearchVocabulariesCommandInput, SearchVocabulariesCommandOutput } from "./commands/SearchVocabulariesCommand";
import {
@@ -947,6 +955,7 @@ export type ServiceInputTypes =
| ReplicateInstanceCommandInput
| ResumeContactCommandInput
| ResumeContactRecordingCommandInput
+ | SearchAgentStatusesCommandInput
| SearchAvailablePhoneNumbersCommandInput
| SearchContactFlowModulesCommandInput
| SearchContactFlowsCommandInput
@@ -959,6 +968,7 @@ export type ServiceInputTypes =
| SearchResourceTagsCommandInput
| SearchRoutingProfilesCommandInput
| SearchSecurityProfilesCommandInput
+ | SearchUserHierarchyGroupsCommandInput
| SearchUsersCommandInput
| SearchVocabulariesCommandInput
| SendChatIntegrationEventCommandInput
@@ -1205,6 +1215,7 @@ export type ServiceOutputTypes =
| ReplicateInstanceCommandOutput
| ResumeContactCommandOutput
| ResumeContactRecordingCommandOutput
+ | SearchAgentStatusesCommandOutput
| SearchAvailablePhoneNumbersCommandOutput
| SearchContactFlowModulesCommandOutput
| SearchContactFlowsCommandOutput
@@ -1217,6 +1228,7 @@ export type ServiceOutputTypes =
| SearchResourceTagsCommandOutput
| SearchRoutingProfilesCommandOutput
| SearchSecurityProfilesCommandOutput
+ | SearchUserHierarchyGroupsCommandOutput
| SearchUsersCommandOutput
| SearchVocabulariesCommandOutput
| SendChatIntegrationEventCommandOutput
@@ -1461,14 +1473,13 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
*
*
diff --git a/clients/client-connect/src/auth/httpAuthSchemeProvider.ts b/clients/client-connect/src/auth/httpAuthSchemeProvider.ts
index a11f18b557ba..6dced05300f7 100644
--- a/clients/client-connect/src/auth/httpAuthSchemeProvider.ts
+++ b/clients/client-connect/src/auth/httpAuthSchemeProvider.ts
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: ConnectHttpAuthSchemeP
name: "connect",
region: authParameters.region,
},
- propertiesExtractor: (config: ConnectClientConfig, context) => ({
+ propertiesExtractor: (config: Partial"LevelId": "0"
is the foundation for building
+ * levels on top of an instance. It is not user-definable, nor is it visible in the UI.
*
diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts
index c969eb8e2cc8..252a0953c41e 100644
--- a/clients/client-connect/src/models/models_0.ts
+++ b/clients/client-connect/src/models/models_0.ts
@@ -616,8 +616,8 @@ export interface AgentQualityMetrics {
/**
*
A leaf node condition which can be used to specify a string condition.
+ * @public + */ +export interface StringCondition { + /** + *The name of the field in the string condition.
+ * @public + */ + FieldName?: string; + + /** + *The value of the string.
+ * @public + */ + Value?: string; + + /** + *The type of comparison to be made when evaluating the string condition.
+ * @public + */ + ComparisonType?: StringComparisonType; +} + +/** + *A leaf node condition which can be used to specify a tag condition, for example, HAVE
+ * BPO = 123
.
The tag key in the tag condition.
+ * @public + */ + TagKey?: string; + + /** + *The tag value in the tag condition.
+ * @public + */ + TagValue?: string; +} + +/** + *A list of conditions which would be applied together with an AND
+ * condition.
A leaf node condition which can be used to specify a tag condition.
+ * @public + */ + TagConditions?: TagCondition[]; +} + +/** + *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
or AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
+ * operator.
The inner list specifies conditions that need to be applied with AND
+ * operator.
A list of conditions which would be applied together with an OR
+ * condition.
A list of conditions which would be applied together with an AND
+ * condition.
A leaf node condition which can be used to specify a tag condition, for example, HAVE
+ * BPO = 123
.
Filters to be applied to search results.
+ * @public + */ +export interface AgentStatusSearchFilter { + /** + *An object that can be used to specify Tag conditions inside the SearchFilter
.
+ * This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
+ * operator.
The inner list specifies conditions that need to be applied with AND
+ * operator.
Summary information for an agent status.
* @public @@ -6660,8 +6792,8 @@ export interface DescribeAuthenticationProfileRequest { *Information about an authentication profile. An authentication profile is a resource that * stores the authentication settings for users in your contact center. You use authentication * profiles to set up IP address range restrictions and session timeouts. For more information, see - * Set IP address restrictions or session timeouts. - *
+ * Set IP + * address restrictions or session timeouts. * @public */ export interface AuthenticationProfile { @@ -6691,8 +6823,8 @@ export interface AuthenticationProfile { /** *A list of IP address range strings that are allowed to access the Amazon Connect - * instance. For more information about how to configure IP addresses, see Configure - * IP address based access control in the Amazon Connect Administrator + * instance. For more information about how to configure IP addresses, see Configure IP + * address based access control in the Amazon Connect Administrator * Guide.
* @public */ @@ -6700,8 +6832,8 @@ export interface AuthenticationProfile { /** *A list of IP address range strings that are blocked from accessing the Amazon Connect - * instance. For more information about how to configure IP addresses, see Configure - * IP address based access control in the Amazon Connect Administrator + * instance. For more information about how to configure IP addresses, see Configure IP + * address based access control in the Amazon Connect Administrator * Guide.
* @public */ @@ -6971,155 +7103,6 @@ export interface AttributeCondition { ComparisonOperator?: string; } -/** - * @public - * @enum - */ -export const RoutingCriteriaStepStatus = { - ACTIVE: "ACTIVE", - EXPIRED: "EXPIRED", - INACTIVE: "INACTIVE", - JOINED: "JOINED", -} as const; - -/** - * @public - */ -export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus]; - -/** - *A value for a segment attribute. This is structured as a map where the key is
- * valueString
and the value is a string.
The value of a segment attribute.
- * @public - */ - ValueString?: string; -} - -/** - *Information about Amazon Connect Wisdom.
- * @public - */ -export interface WisdomInfo { - /** - *The Amazon Resource Name (ARN) of the Wisdom session.
- * @public - */ - SessionArn?: string; -} - -/** - * @public - */ -export interface DescribeContactEvaluationRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *A unique identifier for the contact evaluation.
- * @public - */ - EvaluationId: string | undefined; -} - -/** - *Information about answer data for a contact evaluation. Answer data must be either string, - * numeric, or not applicable.
- * @public - */ -export type EvaluationAnswerData = - | EvaluationAnswerData.NotApplicableMember - | EvaluationAnswerData.NumericValueMember - | EvaluationAnswerData.StringValueMember - | EvaluationAnswerData.$UnknownMember; - -/** - * @public - */ -export namespace EvaluationAnswerData { - /** - *The string value for an answer in a contact evaluation.
- * @public - */ - export interface StringValueMember { - StringValue: string; - NumericValue?: never; - NotApplicable?: never; - $unknown?: never; - } - - /** - *The numeric value for an answer in a contact evaluation.
- * @public - */ - export interface NumericValueMember { - StringValue?: never; - NumericValue: number; - NotApplicable?: never; - $unknown?: never; - } - - /** - *The flag to mark the question as not applicable.
- * @public - */ - export interface NotApplicableMember { - StringValue?: never; - NumericValue?: never; - NotApplicable: boolean; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - StringValue?: never; - NumericValue?: never; - NotApplicable?: never; - $unknown: [string, any]; - } - - export interface VisitorInformation about output answers for a contact evaluation.
- * @public - */ -export interface EvaluationAnswerOutput { - /** - *The value for an answer in a contact evaluation.
- * @public - */ - Value?: EvaluationAnswerData; - - /** - *The system suggested value for an answer in a contact evaluation.
- * @public - */ - SystemSuggestedValue?: EvaluationAnswerData; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts index 2f093eb8090e..647f3c283761 100644 --- a/clients/client-connect/src/models/models_1.ts +++ b/clients/client-connect/src/models/models_1.ts @@ -20,7 +20,6 @@ import { CreatedByInfo, DirectoryType, Distribution, - EvaluationAnswerOutput, EventSourceName, FileStatusType, FileUseCaseType, @@ -50,7 +49,6 @@ import { TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, - UseCaseType, UserIdentityInfo, UserIdentityInfoFilterSensitiveLog, UserPhoneConfig, @@ -60,6 +58,155 @@ import { VocabularyState, } from "./models_0"; +/** + * @public + * @enum + */ +export const RoutingCriteriaStepStatus = { + ACTIVE: "ACTIVE", + EXPIRED: "EXPIRED", + INACTIVE: "INACTIVE", + JOINED: "JOINED", +} as const; + +/** + * @public + */ +export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus]; + +/** + *A value for a segment attribute. This is structured as a map where the key is
+ * valueString
and the value is a string.
The value of a segment attribute.
+ * @public + */ + ValueString?: string; +} + +/** + *Information about Amazon Connect Wisdom.
+ * @public + */ +export interface WisdomInfo { + /** + *The Amazon Resource Name (ARN) of the Wisdom session.
+ * @public + */ + SessionArn?: string; +} + +/** + * @public + */ +export interface DescribeContactEvaluationRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *A unique identifier for the contact evaluation.
+ * @public + */ + EvaluationId: string | undefined; +} + +/** + *Information about answer data for a contact evaluation. Answer data must be either string, + * numeric, or not applicable.
+ * @public + */ +export type EvaluationAnswerData = + | EvaluationAnswerData.NotApplicableMember + | EvaluationAnswerData.NumericValueMember + | EvaluationAnswerData.StringValueMember + | EvaluationAnswerData.$UnknownMember; + +/** + * @public + */ +export namespace EvaluationAnswerData { + /** + *The string value for an answer in a contact evaluation.
+ * @public + */ + export interface StringValueMember { + StringValue: string; + NumericValue?: never; + NotApplicable?: never; + $unknown?: never; + } + + /** + *The numeric value for an answer in a contact evaluation.
+ * @public + */ + export interface NumericValueMember { + StringValue?: never; + NumericValue: number; + NotApplicable?: never; + $unknown?: never; + } + + /** + *The flag to mark the question as not applicable.
+ * @public + */ + export interface NotApplicableMember { + StringValue?: never; + NumericValue?: never; + NotApplicable: boolean; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + StringValue?: never; + NumericValue?: never; + NotApplicable?: never; + $unknown: [string, any]; + } + + export interface VisitorInformation about output answers for a contact evaluation.
+ * @public + */ +export interface EvaluationAnswerOutput { + /** + *The value for an answer in a contact evaluation.
+ * @public + */ + Value?: EvaluationAnswerData; + + /** + *The system suggested value for an answer in a contact evaluation.
+ * @public + */ + SystemSuggestedValue?: EvaluationAnswerData; +} + /** *Information about scores of a contact evaluation item (section or question).
* @public @@ -5080,7 +5227,8 @@ export interface GetMetricDataV2Request { *Threshold: For ThresholdValue
, enter any whole number from 1 to 604800
* (inclusive), in seconds. For Comparison
, you must enter LT
(for
* "Less than").
UI name: This metric is not available in Amazon Connect admin website.
+ *UI name: Contacts removed from queue in X seconds + *
* *The identifier of the traffic distribution group. - * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. - * The ARN must be provided if the call is from the replicated Region.
- * @public - */ - TrafficDistributionGroupId: string | undefined; - - /** - *The maximum number of results to return per page.
- * @public - */ - MaxResults?: number; - - /** - *The token for the next set of results. Use the value returned in the previous - * response in the next request to retrieve the next set of results.
- * @public - */ - NextToken?: string; -} - -/** - *Summary information about a traffic distribution group user.
- * @public - */ -export interface TrafficDistributionGroupUserSummary { - /** - *The identifier for the user. This can be the ID or the ARN of the user.
- * @public - */ - UserId?: string; -} - -/** - * @public - */ -export interface ListTrafficDistributionGroupUsersResponse { - /** - *If there are additional results, this is the token for the next set of results.
- * @public - */ - NextToken?: string; - - /** - *A list of traffic distribution group users.
- * @public - */ - TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[]; -} - -/** - *Provides summary information about the use cases for the specified integration - * association.
- * @public - */ -export interface ListUseCasesRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- * @public - */ - InstanceId: string | undefined; - - /** - *The identifier for the integration association.
- * @public - */ - IntegrationAssociationId: string | undefined; - - /** - *The token for the next set of results. Use the value returned in the previous - * response in the next request to retrieve the next set of results.
- * @public - */ - NextToken?: string; - - /** - *The maximum number of results to return per page.
- * @public - */ - MaxResults?: number; -} - -/** - *Contains the - * use - * case.
- * @public - */ -export interface UseCase { - /** - *The identifier for the use case.
- * @public - */ - UseCaseId?: string; - - /** - *The Amazon Resource Name (ARN) for the use case.
- * @public - */ - UseCaseArn?: string; - - /** - *The type of use case to associate to the integration association. Each integration - * association can have only one of each use case type.
- * @public - */ - UseCaseType?: UseCaseType; -} - -/** - * @public - */ -export interface ListUseCasesResponse { - /** - *The use cases.
- * @public - */ - UseCaseSummaryList?: UseCase[]; - - /** - *If there are additional results, this is the token for the next set of results.
- * @public - */ - NextToken?: string; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_2.ts b/clients/client-connect/src/models/models_2.ts index 6f1699b7b5dc..712eaf09a902 100644 --- a/clients/client-connect/src/models/models_2.ts +++ b/clients/client-connect/src/models/models_2.ts @@ -8,6 +8,8 @@ import { AgentConfig, AgentHierarchyGroups, AgentInfo, + AgentStatus, + AgentStatusSearchFilter, AgentStatusState, AllowedCapabilities, AnsweringMachineDetectionStatus, @@ -18,11 +20,11 @@ import { ContactFlowStatus, ContactFlowType, ContactInitiationMethod, + ControlPlaneAttributeFilter, CreatedByInfo, Customer, CustomerVoiceActivity, DisconnectDetails, - EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, Expiry, @@ -41,15 +43,17 @@ import { QuickConnectConfig, Reference, RehydrationType, - RoutingCriteriaStepStatus, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, - SegmentAttributeValue, + StringComparisonType, + StringCondition, + TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, + UseCaseType, UserIdentityInfo, UserIdentityInfoFilterSensitiveLog, UserPhoneConfig, @@ -62,7 +66,6 @@ import { ViewType, VocabularyLanguageCode, VocabularyState, - WisdomInfo, } from "./models_0"; import { @@ -71,8 +74,10 @@ import { ContactFlowModuleState, ContactFlowState, Evaluation, + EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, + HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, @@ -83,12 +88,146 @@ import { Queue, QueueStatus, QuickConnect, + RoutingCriteriaStepStatus, RoutingProfile, + SegmentAttributeValue, SignInConfig, SortOrder, TelephonyConfig, + WisdomInfo, } from "./models_1"; +/** + * @public + */ +export interface ListTrafficDistributionGroupUsersRequest { + /** + *The identifier of the traffic distribution group. + * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. + * The ARN must be provided if the call is from the replicated Region.
+ * @public + */ + TrafficDistributionGroupId: string | undefined; + + /** + *The maximum number of results to return per page.
+ * @public + */ + MaxResults?: number; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
+ * @public + */ + NextToken?: string; +} + +/** + *Summary information about a traffic distribution group user.
+ * @public + */ +export interface TrafficDistributionGroupUserSummary { + /** + *The identifier for the user. This can be the ID or the ARN of the user.
+ * @public + */ + UserId?: string; +} + +/** + * @public + */ +export interface ListTrafficDistributionGroupUsersResponse { + /** + *If there are additional results, this is the token for the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *A list of traffic distribution group users.
+ * @public + */ + TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[]; +} + +/** + *Provides summary information about the use cases for the specified integration + * association.
+ * @public + */ +export interface ListUseCasesRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The identifier for the integration association.
+ * @public + */ + IntegrationAssociationId: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to return per page.
+ * @public + */ + MaxResults?: number; +} + +/** + *Contains the + * use + * case.
+ * @public + */ +export interface UseCase { + /** + *The identifier for the use case.
+ * @public + */ + UseCaseId?: string; + + /** + *The Amazon Resource Name (ARN) for the use case.
+ * @public + */ + UseCaseArn?: string; + + /** + *The type of use case to associate to the integration association. Each integration + * association can have only one of each use case type.
+ * @public + */ + UseCaseType?: UseCaseType; +} + +/** + * @public + */ +export interface ListUseCasesResponse { + /** + *The use cases.
+ * @public + */ + UseCaseSummaryList?: UseCase[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ * @public + */ + NextToken?: string; +} + /** * @public */ @@ -724,6 +863,29 @@ export interface ResumeContactRecordingRequest { */ export interface ResumeContactRecordingResponse {} +/** + * @public + */ +export interface SearchAgentStatusesResponse { + /** + *The search criteria to be used to return agent statuses.
+ * @public + */ + AgentStatuses?: AgentStatus[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *The total number of agent statuses which matched your search query.
+ * @public + */ + ApproximateTotalCount?: number; +} + /** * @public */ @@ -815,68 +977,6 @@ export interface SearchAvailablePhoneNumbersResponse { AvailableNumbersList?: AvailableNumberSummary[]; } -/** - * @public - * @enum - */ -export const StringComparisonType = { - CONTAINS: "CONTAINS", - EXACT: "EXACT", - STARTS_WITH: "STARTS_WITH", -} as const; - -/** - * @public - */ -export type StringComparisonType = (typeof StringComparisonType)[keyof typeof StringComparisonType]; - -/** - *A leaf node condition which can be used to specify a string condition.
- *The currently supported values for FieldName
are name
and
- * description
.
The name of the field in the string condition.
- * @public - */ - FieldName?: string; - - /** - *The value of the string.
- * @public - */ - Value?: string; - - /** - *The type of comparison to be made when evaluating the string condition.
- * @public - */ - ComparisonType?: StringComparisonType; -} - -/** - *A leaf node condition which can be used to specify a tag condition, for example, HAVE
- * BPO = 123
.
The tag key in the tag condition.
- * @public - */ - TagKey?: string; - - /** - *The tag value in the tag condition.
- * @public - */ - TagValue?: string; -} - /** *An object that can be used to specify Tag conditions inside the SearchFilter
.
* This accepts an OR
of AND
(List of List) input where:
The list of resource types to be used to search tags from. If not provided or if any empty * list is provided, this API will search from all supported resource types.
+ *+ * Supported resource types + *
+ *AGENT
+ *ROUTING_PROFILE
+ *STANDARD_QUEUE
+ *SECURITY_PROFILE
+ *OPERATING_HOURS
+ *PROMPT
+ *CONTACT_FLOW
+ *FLOW_MODULE
+ *Filters to be applied to search results.
+ * @public + */ +export interface UserHierarchyGroupSearchFilter { + /** + *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts + * an OR or AND (List of List) input where:
+ *The top level list specifies conditions that need to be applied with OR
+ * operator.
The inner list specifies conditions that need to be applied with AND
+ * operator.
Information about the userHierarchyGroups.
+ * @public + */ + UserHierarchyGroups?: HierarchyGroup[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *The total number of userHierarchyGroups which matched your search query.
+ * @public + */ + ApproximateTotalCount?: number; +} + /** * @public * @enum @@ -1958,6 +2133,113 @@ export interface HierarchyGroupCondition { HierarchyGroupMatchType?: HierarchyGroupMatchType; } +/** + * @public + * @enum + */ +export const NumberComparisonType = { + EQUAL: "EQUAL", + GREATER: "GREATER", + GREATER_OR_EQUAL: "GREATER_OR_EQUAL", + LESSER: "LESSER", + LESSER_OR_EQUAL: "LESSER_OR_EQUAL", + NOT_EQUAL: "NOT_EQUAL", + RANGE: "RANGE", +} as const; + +/** + * @public + */ +export type NumberComparisonType = (typeof NumberComparisonType)[keyof typeof NumberComparisonType]; + +/** + *A leaf node condition which can be used to specify a numeric condition.
+ *The currently supported value for FieldName
is limit
.
The name of the field in the number condition.
+ * @public + */ + FieldName?: string; + + /** + *The minValue to be used while evaluating the number condition.
+ * @public + */ + MinValue?: number; + + /** + *The maxValue to be used while evaluating the number condition.
+ * @public + */ + MaxValue?: number; + + /** + *The type of comparison to be made when evaluating the number condition.
+ * @public + */ + ComparisonType?: NumberComparisonType; +} + +/** + *A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and + * ProficiencyLimit.
+ * @public + */ +export interface Condition { + /** + *A leaf node condition which can be used to specify a string condition.
+ *The currently supported values for FieldName
are name
and
+ * value
.
A leaf node condition which can be used to specify a numeric condition.
+ * @public + */ + NumberCondition?: NumberCondition; +} + +/** + * @public + * @enum + */ +export const TargetListType = { + PROFICIENCIES: "PROFICIENCIES", +} as const; + +/** + * @public + */ +export type TargetListType = (typeof TargetListType)[keyof typeof TargetListType]; + +/** + *A leaf node condition which can be used to specify a List condition to search users with + * attributes included in Lists like Proficiencies.
+ * @public + */ +export interface ListCondition { + /** + *The type of target list that will be used to filter the users.
+ * @public + */ + TargetListType?: TargetListType; + + /** + *A list of Condition objects which would be applied together with an AND condition.
+ * @public + */ + Conditions?: Condition[]; +} + /** *A list of conditions which would be applied together with an AND
* condition.
The search criteria to be used to return agent statuses.
+ * @public + */ +export interface AgentStatusSearchCriteria { + /** + *A list of conditions which would be applied together with an OR
+ * condition.
A leaf node condition which can be used to specify a string condition.
+ *The currently supported values for FieldName
are name
,
+ * description
, state
, type
, displayOrder
,
+ * and resourceID
.
A leaf node condition which can be used to specify a string condition.
+ *The currently supported values for FieldName
are name
,
+ * description
, state
, type
, displayOrder
,
+ * and resourceID
.
The search criteria to be used to return flow modules.
* @public @@ -5917,10 +6234,6 @@ export interface ContactFlowModuleSearchCriteria { /** *A leaf node condition which can be used to specify a string condition.
- *The currently supported values for FieldName
are name
and
- * description
.
A leaf node condition which can be used to specify a string condition.
- *The currently supported values for FieldName
are name
and
- * description
.
A leaf node condition which can be used to specify a string condition.
- *The currently supported values for FieldName
are name
and
- * description
.
A leaf node condition which can be used to specify a string condition.
- *The currently supported values for FieldName
are name
and
- * description
.
The search criteria to be used to return userHierarchyGroup.
+ * @public + */ +export interface UserHierarchyGroupSearchCriteria { + /** + *A list of conditions which would be applied together with an OR condition.
+ * @public + */ + OrConditions?: UserHierarchyGroupSearchCriteria[]; + + /** + *A list of conditions which would be applied together with an AND condition.
+ * @public + */ + AndConditions?: UserHierarchyGroupSearchCriteria[]; + + /** + *A leaf node condition which can be used to specify a string condition.
+ *The currently supported values for FieldName
are name
,
+ * parentId
, levelId
, and resourceID
.
The search criteria to be used to return users.
*A leaf node condition which can be used to specify a List condition to search users with + * attributes included in Lists like Proficiencies.
+ * @public + */ + ListCondition?: ListCondition; + /** *A leaf node condition which can be used to specify a hierarchy group condition.
* @public @@ -6530,6 +6866,43 @@ export interface DescribeEvaluationFormResponse { EvaluationForm: EvaluationForm | undefined; } +/** + * @public + */ +export interface SearchAgentStatusesRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous response in + * the next request to retrieve the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to return per page.
+ * @public + */ + MaxResults?: number; + + /** + *Filters to be applied to search results.
+ * @public + */ + SearchFilter?: AgentStatusSearchFilter; + + /** + *The search criteria to be used to return agent statuses.
+ * @public + */ + SearchCriteria?: AgentStatusSearchCriteria; +} + /** * @public */ @@ -6880,6 +7253,43 @@ export interface SearchSecurityProfilesRequest { SearchFilter?: SecurityProfilesSearchFilter; } +/** + * @public + */ +export interface SearchUserHierarchyGroupsRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of + * the instance.
+ * @public + */ + InstanceId: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous response in + * the next request to retrieve the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *The maximum number of results to return per page.
+ * @public + */ + MaxResults?: number; + + /** + *Filters to be applied to search results.
+ * @public + */ + SearchFilter?: UserHierarchyGroupSearchFilter; + + /** + *The search criteria to be used to return UserHierarchyGroups.
+ * @public + */ + SearchCriteria?: UserHierarchyGroupSearchCriteria; +} + /** * @public */ diff --git a/clients/client-connect/src/pagination/SearchAgentStatusesPaginator.ts b/clients/client-connect/src/pagination/SearchAgentStatusesPaginator.ts new file mode 100644 index 000000000000..cc2f218a6ffb --- /dev/null +++ b/clients/client-connect/src/pagination/SearchAgentStatusesPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + SearchAgentStatusesCommand, + SearchAgentStatusesCommandInput, + SearchAgentStatusesCommandOutput, +} from "../commands/SearchAgentStatusesCommand"; +import { ConnectClient } from "../ConnectClient"; +import { ConnectPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateSearchAgentStatuses: ( + config: ConnectPaginationConfiguration, + input: SearchAgentStatusesCommandInput, + ...rest: any[] +) => PaginatorInformation about the agent's status.
" } }, + "com.amazonaws.connect#AgentStatusSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#AgentStatusSearchCriteria" + } + }, + "com.amazonaws.connect#AgentStatusSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#AgentStatusSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR
\n condition.
A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName
are name
,\u2028\u2028\n description
, state
, type
, displayOrder
,\u2028\n and resourceID
.
A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName
are name
,\u2028\u2028\n description
, state
, type
, displayOrder
,\u2028\n and resourceID
.
The search criteria to be used to return agent statuses.
" + } + }, + "com.amazonaws.connect#AgentStatusSearchFilter": { + "type": "structure", + "members": { + "AttributeFilter": { + "target": "com.amazonaws.connect#ControlPlaneAttributeFilter", + "traits": { + "smithy.api#documentation": "An object that can be used to specify Tag conditions inside the SearchFilter
.\n This accepts an OR
of AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
\n operator.
The inner list specifies conditions that need to be applied with AND
\n operator.
Filters to be applied to search results.
" + } + }, "com.amazonaws.connect#AgentStatusState": { "type": "enum", "members": { @@ -742,7 +794,7 @@ } }, "traits": { - "smithy.api#documentation": "Can be used to define a list of preferred agents to target the contact within the queue.\n Note that agents must have the queue in their routing profile in order to be offered the\n contact.
" + "smithy.api#documentation": "Can be used to define a list of preferred agents to target the contact within the queue.\n Note that agents must have the queue in their routing profile in order to be offered the\n contact.
" } }, "com.amazonaws.connect#AgentsMinOneMaxHundred": { @@ -1336,6 +1388,9 @@ { "target": "com.amazonaws.connect#ResumeContactRecording" }, + { + "target": "com.amazonaws.connect#SearchAgentStatuses" + }, { "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" }, @@ -1372,6 +1427,9 @@ { "target": "com.amazonaws.connect#SearchSecurityProfiles" }, + { + "target": "com.amazonaws.connect#SearchUserHierarchyGroups" + }, { "target": "com.amazonaws.connect#SearchUsers" }, @@ -1589,7 +1647,7 @@ "name": "connect" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.
\nAmazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.
\nThere are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.
\nYou can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
", + "smithy.api#documentation": "Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.
\nAmazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.
\nThere are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.
\nYou can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
", "smithy.api#title": "Amazon Connect Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -4013,13 +4071,13 @@ "AllowedIps": { "target": "com.amazonaws.connect#IpCidrList", "traits": { - "smithy.api#documentation": "A list of IP address range strings that are allowed to access the Amazon Connect\n instance. For more information about how to configure IP addresses, see Configure\n IP address based access control in the Amazon Connect Administrator\n Guide.
" + "smithy.api#documentation": "A list of IP address range strings that are allowed to access the Amazon Connect\n instance. For more information about how to configure IP addresses, see Configure IP\n address based access control in the Amazon Connect Administrator\n Guide.
" } }, "BlockedIps": { "target": "com.amazonaws.connect#IpCidrList", "traits": { - "smithy.api#documentation": "A list of IP address range strings that are blocked from accessing the Amazon Connect\n instance. For more information about how to configure IP addresses, see Configure\n IP address based access control in the Amazon Connect Administrator\n Guide.
" + "smithy.api#documentation": "A list of IP address range strings that are blocked from accessing the Amazon Connect\n instance. For more information about how to configure IP addresses, see Configure IP\n address based access control in the Amazon Connect Administrator\n Guide.
" } }, "IsDefault": { @@ -4061,7 +4119,7 @@ } }, "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.
\nInformation about an authentication profile. An authentication profile is a resource that\n stores the authentication settings for users in your contact center. You use authentication\n profiles to set up IP address range restrictions and session timeouts. For more information, see \n Set IP address restrictions or session timeouts. \n
" + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change. To \nrequest access to this API, contact Amazon Web Services Support.
\nInformation about an authentication profile. An authentication profile is a resource that\n stores the authentication settings for users in your contact center. You use authentication\n profiles to set up IP address range restrictions and session timeouts. For more information, see\n Set IP\n address restrictions or session timeouts.
" } }, "com.amazonaws.connect#AuthenticationProfileDescription": { @@ -5053,6 +5111,26 @@ } } }, + "com.amazonaws.connect#CommonAttributeAndCondition": { + "type": "structure", + "members": { + "TagConditions": { + "target": "com.amazonaws.connect#TagAndConditionList", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a tag condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND
\n condition.
A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName
are name
and\u2028\n value
.
A leaf node condition which can be used to specify a numeric condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and\n ProficiencyLimit.
" + } + }, + "com.amazonaws.connect#Conditions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Condition" + } + }, "com.amazonaws.connect#ConflictException": { "type": "structure", "members": { @@ -6361,6 +6465,29 @@ } } }, + "com.amazonaws.connect#ControlPlaneAttributeFilter": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#CommonAttributeOrConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR
\n condition.
A list of conditions which would be applied together with an AND
\n condition.
An object that can be used to specify Tag conditions inside the SearchFilter
.\n This accepts an OR
or AND
(List of List) input where:
The top level list specifies conditions that need to be applied with OR
\n operator.
The inner list specifies conditions that need to be applied with AND
\n operator.
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.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. For now, this metric only\n supports the following as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nUnit: Seconds
\nValid 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
\nUI name: Average flow time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
,\n DISCONNECT_REASON
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: This metric is not available in Amazon Connect admin website.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Count
\nValid 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
\nUI name: Flows outcome\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp
\nUI name: Flows started\n
\nUnit: Seconds
\nValid 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
\nUI name: Maximum flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued time\n
\nUnit: Seconds
\nValid 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
\nUI name: Minimum flow time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid metric filter key: FLOWS_OUTCOME_TYPE
\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
\nUI name: Flows outcome percentage.
\nThe FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. This metric only supports the\n following filter keys as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Count
\nMetric filter:
\nValid values: API
| Incoming
| Outbound
|\n Transfer
| Callback
| Queue_Transfer
|\n Disconnect
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nValid metric filter key: DISCONNECT_REASON
\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback attempts\n
\nThe 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.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. For now, this metric only\n supports the following as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nUnit: Seconds
\nValid 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
\nUI name: Average flow time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
,\n DISCONNECT_REASON
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts removed from queue in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Count
\nValid 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
\nUI name: Flows outcome\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp
\nUI name: Flows started\n
\nUnit: Seconds
\nValid 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
\nUI name: Maximum flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued time\n
\nUnit: Seconds
\nValid 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
\nUI name: Minimum flow time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid metric filter key: FLOWS_OUTCOME_TYPE
\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
\nUI name: Flows outcome percentage.
\nThe FLOWS_OUTCOME_TYPE
is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. This metric only supports the\n following filter keys as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Count
\nMetric filter:
\nValid values: API
| Incoming
| Outbound
|\n Transfer
| Callback
| Queue_Transfer
|\n Disconnect
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nValid metric filter key: DISCONNECT_REASON
\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback attempts\n
\nThe type of target list that will be used to filter the users.
" + } + }, + "Conditions": { + "target": "com.amazonaws.connect#Conditions", + "traits": { + "smithy.api#documentation": "A list of Condition objects which would be applied together with an AND condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a List condition to search users with\n attributes included in Lists like Proficiencies.
" + } + }, "com.amazonaws.connect#ListContactEvaluations": { "type": "operation", "input": { @@ -24374,6 +24521,88 @@ } } }, + "com.amazonaws.connect#NullableProficiencyLimitValue": { + "type": "integer" + }, + "com.amazonaws.connect#NumberComparisonType": { + "type": "enum", + "members": { + "GREATER_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_OR_EQUAL" + } + }, + "GREATER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER" + } + }, + "LESSER_OR_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESSER_OR_EQUAL" + } + }, + "LESSER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESSER" + } + }, + "EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUAL" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUAL" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + } + } + }, + "com.amazonaws.connect#NumberCondition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "The name of the field in the number condition.
" + } + }, + "MinValue": { + "target": "com.amazonaws.connect#NullableProficiencyLimitValue", + "traits": { + "smithy.api#documentation": "The minValue to be used while evaluating the number condition.
" + } + }, + "MaxValue": { + "target": "com.amazonaws.connect#NullableProficiencyLimitValue", + "traits": { + "smithy.api#documentation": "The maxValue to be used while evaluating the number condition.
" + } + }, + "ComparisonType": { + "target": "com.amazonaws.connect#NumberComparisonType", + "traits": { + "smithy.api#documentation": "The type of comparison to be made when evaluating the number condition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a numeric condition.
\nThe currently supported value for FieldName
is limit
.
Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-agent-statuses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AgentStatuses", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchAgentStatusesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#AgentStatusSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#AgentStatusSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return agent statuses.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchAgentStatusesResponse": { + "type": "structure", + "members": { + "AgentStatuses": { + "target": "com.amazonaws.connect#AgentStatusList", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return agent statuses.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of agent statuses which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchAvailablePhoneNumbers": { "type": "operation", "input": { @@ -31083,7 +31417,7 @@ "ResourceTypes": { "target": "com.amazonaws.connect#ResourceTypeList", "traits": { - "smithy.api#documentation": "The list of resource types to be used to search tags from. If not provided or if any empty\n list is provided, this API will search from all supported resource types.
" + "smithy.api#documentation": "The list of resource types to be used to search tags from. If not provided or if any empty\n list is provided, this API will search from all supported resource types.
\n\n Supported resource types\n
\nAGENT
\nROUTING_PROFILE
\nSTANDARD_QUEUE
\nSECURITY_PROFILE
\nOPERATING_HOURS
\nPROMPT
\nCONTACT_FLOW
\nFLOW_MODULE
\nSearches UserHierarchyGroups in an Amazon Connect instance, with optional\n filtering.
\nThe UserHierarchyGroup with \"LevelId\": \"0\"
is the foundation for building\n levels on top of an instance. It is not user-definable, nor is it visible in the UI.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of\n the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#UserHierarchyGroupSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#UserHierarchyGroupSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return UserHierarchyGroups.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchUserHierarchyGroupsResponse": { + "type": "structure", + "members": { + "UserHierarchyGroups": { + "target": "com.amazonaws.connect#UserHierarchyGroupList", + "traits": { + "smithy.api#documentation": "Information about the userHierarchyGroups.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of userHierarchyGroups which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchUsers": { "type": "operation", "input": { @@ -33701,7 +34140,7 @@ } }, "traits": { - "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName
are name
and\n description
.
A leaf node condition which can be used to specify a string condition.
" } }, "com.amazonaws.connect#StringReference": { @@ -34058,7 +34497,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + "smithy.api#pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" } }, "com.amazonaws.connect#TagKeyList": { @@ -34257,6 +34696,17 @@ "target": "com.amazonaws.connect#TagSet" } }, + "com.amazonaws.connect#TargetListType": { + "type": "enum", + "members": { + "PROFICIENCIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFICIENCIES" + } + } + } + }, "com.amazonaws.connect#TaskActionDefinition": { "type": "structure", "members": { @@ -39442,6 +39892,58 @@ "target": "com.amazonaws.connect#UserData" } }, + "com.amazonaws.connect#UserHierarchyGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#HierarchyGroup" + } + }, + "com.amazonaws.connect#UserHierarchyGroupSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#UserHierarchyGroupSearchCriteria" + } + }, + "com.amazonaws.connect#UserHierarchyGroupSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#UserHierarchyGroupSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#UserHierarchyGroupSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName
are name
,\u2028\u2028\n parentId
, levelId
, and resourceID
.
The search criteria to be used to return userHierarchyGroup.
" + } + }, + "com.amazonaws.connect#UserHierarchyGroupSearchFilter": { + "type": "structure", + "members": { + "AttributeFilter": { + "target": "com.amazonaws.connect#ControlPlaneAttributeFilter", + "traits": { + "smithy.api#documentation": "An object that can be used to specify Tag conditions inside the SearchFilter. This accepts\n an OR or AND (List of List) input where:
\nThe top level list specifies conditions that need to be applied with OR
\n operator.
The inner list specifies conditions that need to be applied with AND
\n operator.
Filters to be applied to search results.
" + } + }, "com.amazonaws.connect#UserId": { "type": "string" }, @@ -39690,6 +40192,12 @@ "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName
are Username
,\n FirstName
, LastName
, RoutingProfileId
,\n SecurityProfileId
, ResourceId
.
A leaf node condition which can be used to specify a List condition to search users with\n attributes included in Lists like Proficiencies.
" + } + }, "HierarchyGroupCondition": { "target": "com.amazonaws.connect#HierarchyGroupCondition", "traits": {