@aws-sdk/client-connect 3.613.0 → 3.616.0

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

@@ -504,8 +504,8 @@ export interface AgentQualityMetrics {
 }
 /**
  * <p>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.</p>
+ *    Note that agents must have the queue in their routing profile in order to be offered the
+ *    contact.</p>
  * @public
  */
 export interface AgentsCriteria {
@@ -617,6 +617,126 @@ export interface AgentStatusReference {
      */
     StatusName?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const StringComparisonType: {
+    readonly CONTAINS: "CONTAINS";
+    readonly EXACT: "EXACT";
+    readonly STARTS_WITH: "STARTS_WITH";
+};
+/**
+ * @public
+ */
+export type StringComparisonType = (typeof StringComparisonType)[keyof typeof StringComparisonType];
+/**
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
+ * @public
+ */
+export interface StringCondition {
+    /**
+     * <p>The name of the field in the string condition.</p>
+     * @public
+     */
+    FieldName?: string;
+    /**
+     * <p>The value of the string.</p>
+     * @public
+     */
+    Value?: string;
+    /**
+     * <p>The type of comparison to be made when evaluating the string condition.</p>
+     * @public
+     */
+    ComparisonType?: StringComparisonType;
+}
+/**
+ * <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
+ *     BPO = 123</code>. </p>
+ * @public
+ */
+export interface TagCondition {
+    /**
+     * <p>The tag key in the tag condition.</p>
+     * @public
+     */
+    TagKey?: string;
+    /**
+     * <p>The tag value in the tag condition.</p>
+     * @public
+     */
+    TagValue?: string;
+}
+/**
+ * <p>A list of conditions which would be applied together with an <code>AND</code>
+ *    condition.</p>
+ * @public
+ */
+export interface CommonAttributeAndCondition {
+    /**
+     * <p>A leaf node condition which can be used to specify a tag condition.</p>
+     * @public
+     */
+    TagConditions?: TagCondition[];
+}
+/**
+ * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
+ *    This accepts an <code>OR</code> or <code>AND</code> (List of List) input where: </p>
+ *          <ul>
+ *             <li>
+ *                <p>The top level list specifies conditions that need to be applied with <code>OR</code>
+ *      operator.</p>
+ *             </li>
+ *             <li>
+ *                <p>The inner list specifies conditions that need to be applied with <code>AND</code>
+ *      operator.</p>
+ *             </li>
+ *          </ul>
+ * @public
+ */
+export interface ControlPlaneAttributeFilter {
+    /**
+     * <p>A list of conditions which would be applied together with an <code>OR</code>
+     *    condition.</p>
+     * @public
+     */
+    OrConditions?: CommonAttributeAndCondition[];
+    /**
+     * <p>A list of conditions which would be applied together with an <code>AND</code>
+     *    condition.</p>
+     * @public
+     */
+    AndCondition?: CommonAttributeAndCondition;
+    /**
+     * <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
+     *     BPO = 123</code>. </p>
+     * @public
+     */
+    TagCondition?: TagCondition;
+}
+/**
+ * <p>Filters to be applied to search results.</p>
+ * @public
+ */
+export interface AgentStatusSearchFilter {
+    /**
+     * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
+     *    This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
+     *          <ul>
+     *             <li>
+     *                <p>The top level list specifies conditions that need to be applied with <code>OR</code>
+     *      operator.</p>
+     *             </li>
+     *             <li>
+     *                <p>The inner list specifies conditions that need to be applied with <code>AND</code>
+     *      operator.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    AttributeFilter?: ControlPlaneAttributeFilter;
+}
 /**
  * <p>Summary information for an agent status.</p>
  * @public
@@ -5728,8 +5848,8 @@ export interface DescribeAuthenticationProfileRequest {
  *          <p>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
- *    <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html">Set IP address restrictions or session timeouts</a>.
- *   </p>
+ *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html">Set IP
+ *     address restrictions or session timeouts</a>. </p>
  * @public
  */
 export interface AuthenticationProfile {
@@ -5755,16 +5875,16 @@ export interface AuthenticationProfile {
     Description?: string;
     /**
      * <p>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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
-     *     IP address based access control</a> in the <i>Amazon Connect Administrator
+     *    instance. For more information about how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP
+     *     address based access control</a> in the <i>Amazon Connect Administrator
      *     Guide</i>.</p>
      * @public
      */
     AllowedIps?: string[];
     /**
      * <p>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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure
-     *     IP address based access control</a> in the <i>Amazon Connect Administrator
+     *    instance. For more information about how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP
+     *     address based access control</a> in the <i>Amazon Connect Administrator
      *     Guide</i>.</p>
      * @public
      */
@@ -6003,131 +6123,6 @@ export interface AttributeCondition {
      */
     ComparisonOperator?: string;
 }
-/**
- * @public
- * @enum
- */
-export declare const RoutingCriteriaStepStatus: {
-    readonly ACTIVE: "ACTIVE";
-    readonly EXPIRED: "EXPIRED";
-    readonly INACTIVE: "INACTIVE";
-    readonly JOINED: "JOINED";
-};
-/**
- * @public
- */
-export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus];
-/**
- * <p>A value for a segment attribute. This is structured as a map where the key is
- *     <code>valueString</code> and the value is a string.</p>
- * @public
- */
-export interface SegmentAttributeValue {
-    /**
-     * <p>The value of a segment attribute.</p>
-     * @public
-     */
-    ValueString?: string;
-}
-/**
- * <p>Information about Amazon Connect Wisdom.</p>
- * @public
- */
-export interface WisdomInfo {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the Wisdom session.</p>
-     * @public
-     */
-    SessionArn?: string;
-}
-/**
- * @public
- */
-export interface DescribeContactEvaluationRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>A unique identifier for the contact evaluation.</p>
-     * @public
-     */
-    EvaluationId: string | undefined;
-}
-/**
- * <p>Information about answer data for a contact evaluation. Answer data must be either string,
- *    numeric, or not applicable.</p>
- * @public
- */
-export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.$UnknownMember;
-/**
- * @public
- */
-export declare namespace EvaluationAnswerData {
-    /**
-     * <p>The string value for an answer in a contact evaluation.</p>
-     * @public
-     */
-    interface StringValueMember {
-        StringValue: string;
-        NumericValue?: never;
-        NotApplicable?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p>The numeric value for an answer in a contact evaluation.</p>
-     * @public
-     */
-    interface NumericValueMember {
-        StringValue?: never;
-        NumericValue: number;
-        NotApplicable?: never;
-        $unknown?: never;
-    }
-    /**
-     * <p>The flag to mark the question as not applicable.</p>
-     * @public
-     */
-    interface NotApplicableMember {
-        StringValue?: never;
-        NumericValue?: never;
-        NotApplicable: boolean;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        StringValue?: never;
-        NumericValue?: never;
-        NotApplicable?: never;
-        $unknown: [string, any];
-    }
-    interface Visitor<T> {
-        StringValue: (value: string) => T;
-        NumericValue: (value: number) => T;
-        NotApplicable: (value: boolean) => T;
-        _: (name: string, value: any) => T;
-    }
-    const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
-}
-/**
- * <p>Information about output answers for a contact evaluation.</p>
- * @public
- */
-export interface EvaluationAnswerOutput {
-    /**
-     * <p>The value for an answer in a contact evaluation.</p>
-     * @public
-     */
-    Value?: EvaluationAnswerData;
-    /**
-     * <p>The system suggested value for an answer in a contact evaluation.</p>
-     * @public
-     */
-    SystemSuggestedValue?: EvaluationAnswerData;
-}
 /**
  * @internal
  */

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

@@ -1,6 +1,131 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
-import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EvaluationAnswerOutput, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
+import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, Application, Channel, ContactFlowStatus, ContactFlowType, ContactState, CreatedByInfo, DirectoryType, Distribution, EventSourceName, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QueueReference, QuickConnectConfig, QuickConnectType, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
+/**
+ * @public
+ * @enum
+ */
+export declare const RoutingCriteriaStepStatus: {
+    readonly ACTIVE: "ACTIVE";
+    readonly EXPIRED: "EXPIRED";
+    readonly INACTIVE: "INACTIVE";
+    readonly JOINED: "JOINED";
+};
+/**
+ * @public
+ */
+export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus];
+/**
+ * <p>A value for a segment attribute. This is structured as a map where the key is
+ *     <code>valueString</code> and the value is a string.</p>
+ * @public
+ */
+export interface SegmentAttributeValue {
+    /**
+     * <p>The value of a segment attribute.</p>
+     * @public
+     */
+    ValueString?: string;
+}
+/**
+ * <p>Information about Amazon Connect Wisdom.</p>
+ * @public
+ */
+export interface WisdomInfo {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the Wisdom session.</p>
+     * @public
+     */
+    SessionArn?: string;
+}
+/**
+ * @public
+ */
+export interface DescribeContactEvaluationRequest {
+    /**
+     * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>A unique identifier for the contact evaluation.</p>
+     * @public
+     */
+    EvaluationId: string | undefined;
+}
+/**
+ * <p>Information about answer data for a contact evaluation. Answer data must be either string,
+ *    numeric, or not applicable.</p>
+ * @public
+ */
+export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace EvaluationAnswerData {
+    /**
+     * <p>The string value for an answer in a contact evaluation.</p>
+     * @public
+     */
+    interface StringValueMember {
+        StringValue: string;
+        NumericValue?: never;
+        NotApplicable?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The numeric value for an answer in a contact evaluation.</p>
+     * @public
+     */
+    interface NumericValueMember {
+        StringValue?: never;
+        NumericValue: number;
+        NotApplicable?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The flag to mark the question as not applicable.</p>
+     * @public
+     */
+    interface NotApplicableMember {
+        StringValue?: never;
+        NumericValue?: never;
+        NotApplicable: boolean;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        StringValue?: never;
+        NumericValue?: never;
+        NotApplicable?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        StringValue: (value: string) => T;
+        NumericValue: (value: number) => T;
+        NotApplicable: (value: boolean) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Information about output answers for a contact evaluation.</p>
+ * @public
+ */
+export interface EvaluationAnswerOutput {
+    /**
+     * <p>The value for an answer in a contact evaluation.</p>
+     * @public
+     */
+    Value?: EvaluationAnswerData;
+    /**
+     * <p>The system suggested value for an answer in a contact evaluation.</p>
+     * @public
+     */
+    SystemSuggestedValue?: EvaluationAnswerData;
+}
 /**
  * <p>Information about scores of a contact evaluation item (section or question).</p>
  * @public
@@ -4531,7 +4656,8 @@ export interface GetMetricDataV2Request {
      *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
      *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
      *       "Less than").</p>
-     *                <p>UI name: This metric is not available in Amazon Connect admin website. </p>
+     *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical">Contacts removed from queue in X seconds</a>
+     *                </p>
      *             </dd>
      *             <dt>CONTACTS_RESOLVED_IN_X</dt>
      *             <dd>
@@ -8542,122 +8668,6 @@ export interface ListTrafficDistributionGroupsResponse {
      */
     TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[];
 }
-/**
- * @public
- */
-export interface ListTrafficDistributionGroupUsersRequest {
-    /**
-     * <p>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.</p>
-     * @public
-     */
-    TrafficDistributionGroupId: string | undefined;
-    /**
-     * <p>The maximum number of results to return per page.</p>
-     * @public
-     */
-    MaxResults?: number;
-    /**
-     * <p>The token for the next set of results. Use the value returned in the previous
-     * response in the next request to retrieve the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-}
-/**
- * <p>Summary information about a traffic distribution group user.</p>
- * @public
- */
-export interface TrafficDistributionGroupUserSummary {
-    /**
-     * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
-     * @public
-     */
-    UserId?: string;
-}
-/**
- * @public
- */
-export interface ListTrafficDistributionGroupUsersResponse {
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>A list of traffic distribution group users.</p>
-     * @public
-     */
-    TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[];
-}
-/**
- * <p>Provides summary information about the use cases for the specified integration
- *    association.</p>
- * @public
- */
-export interface ListUseCasesRequest {
-    /**
-     * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier for the integration association.</p>
-     * @public
-     */
-    IntegrationAssociationId: string | undefined;
-    /**
-     * <p>The token for the next set of results. Use the value returned in the previous
-     * response in the next request to retrieve the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-    /**
-     * <p>The maximum number of results to return per page.</p>
-     * @public
-     */
-    MaxResults?: number;
-}
-/**
- * <p>Contains the
- *    use
- *    case.</p>
- * @public
- */
-export interface UseCase {
-    /**
-     * <p>The identifier for the use case.</p>
-     * @public
-     */
-    UseCaseId?: string;
-    /**
-     * <p>The Amazon Resource Name (ARN) for the use case.</p>
-     * @public
-     */
-    UseCaseArn?: string;
-    /**
-     * <p>The type of use case to associate to the integration association. Each integration
-     *    association can have only one of each use case type.</p>
-     * @public
-     */
-    UseCaseType?: UseCaseType;
-}
-/**
- * @public
- */
-export interface ListUseCasesResponse {
-    /**
-     * <p>The use cases.</p>
-     * @public
-     */
-    UseCaseSummaryList?: UseCase[];
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string;
-}
 /**
  * @internal
  */