@aws-sdk/client-connect 3.614.0 → 3.616.0

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

@@ -1,7 +1,123 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
-import { AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentInfo, AgentStatusState, AllowedCapabilities, AnsweringMachineDetectionStatus, Application, AttributeCondition, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, CreatedByInfo, Customer, CustomerVoiceActivity, DisconnectDetails, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, Expiry, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QualityMetrics, QueueInfo, QuickConnectConfig, Reference, RehydrationType, RoutingCriteriaStepStatus, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SegmentAttributeValue, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState, WisdomInfo } from "./models_0";
-import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationFormVersionStatus, EvaluationNote, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RoutingProfile, SignInConfig, SortOrder, TelephonyConfig } from "./models_1";
+import { AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentInfo, AgentStatus, AgentStatusSearchFilter, AgentStatusState, AllowedCapabilities, AnsweringMachineDetectionStatus, Application, AttributeCondition, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, Customer, CustomerVoiceActivity, DisconnectDetails, EvaluationFormQuestion, EvaluationFormScoringStrategy, Expiry, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, ParticipantRole, PredefinedAttributeValues, QualityMetrics, QueueInfo, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
+import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, Evaluation, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RoutingCriteriaStepStatus, RoutingProfile, SegmentAttributeValue, SignInConfig, SortOrder, TelephonyConfig, WisdomInfo } from "./models_1";
+/**
+ * @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;
+}
 /**
  * @public
  */
@@ -553,6 +669,26 @@ export interface ResumeContactRecordingRequest {
  */
 export interface ResumeContactRecordingResponse {
 }
+/**
+ * @public
+ */
+export interface SearchAgentStatusesResponse {
+    /**
+     * <p>The search criteria to be used to return agent statuses.</p>
+     * @public
+     */
+    AgentStatuses?: AgentStatus[];
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string;
+    /**
+     * <p>The total number of agent statuses which matched your search query.</p>
+     * @public
+     */
+    ApproximateTotalCount?: number;
+}
 /**
  * @public
  */
@@ -632,61 +768,6 @@ export interface SearchAvailablePhoneNumbersResponse {
      */
     AvailableNumbersList?: AvailableNumberSummary[];
 }
-/**
- * @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>
- *          <note>
- *             <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
- *      <code>description</code>.</p>
- *          </note>
- * @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>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>
@@ -1443,6 +1524,35 @@ export interface SearchResourceTagsRequest {
     /**
      * <p>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.</p>
+     *          <p class="title">
+     *             <b>Supported resource types</b>
+     *          </p>
+     *          <ul>
+     *             <li>
+     *                <p>AGENT</p>
+     *             </li>
+     *             <li>
+     *                <p>ROUTING_PROFILE</p>
+     *             </li>
+     *             <li>
+     *                <p>STANDARD_QUEUE</p>
+     *             </li>
+     *             <li>
+     *                <p>SECURITY_PROFILE</p>
+     *             </li>
+     *             <li>
+     *                <p>OPERATING_HOURS</p>
+     *             </li>
+     *             <li>
+     *                <p>PROMPT</p>
+     *             </li>
+     *             <li>
+     *                <p>CONTACT_FLOW</p>
+     *             </li>
+     *             <li>
+     *                <p>FLOW_MODULE</p>
+     *             </li>
+     *          </ul>
      * @public
      */
     ResourceTypes?: string[];
@@ -1614,6 +1724,48 @@ export interface SearchSecurityProfilesResponse {
      */
     ApproximateTotalCount?: number;
 }
+/**
+ * <p>Filters to be applied to search results.</p>
+ * @public
+ */
+export interface UserHierarchyGroupSearchFilter {
+    /**
+     * <p>An object that can be used to specify Tag conditions inside the SearchFilter. This accepts
+     *    an OR or AND (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;
+}
+/**
+ * @public
+ */
+export interface SearchUserHierarchyGroupsResponse {
+    /**
+     * <p>Information about the userHierarchyGroups.</p>
+     * @public
+     */
+    UserHierarchyGroups?: HierarchyGroup[];
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string;
+    /**
+     * <p>The total number of userHierarchyGroups which matched your search query.</p>
+     * @public
+     */
+    ApproximateTotalCount?: number;
+}
 /**
  * @public
  * @enum
@@ -1642,6 +1794,101 @@ export interface HierarchyGroupCondition {
      */
     HierarchyGroupMatchType?: HierarchyGroupMatchType;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const NumberComparisonType: {
+    readonly EQUAL: "EQUAL";
+    readonly GREATER: "GREATER";
+    readonly GREATER_OR_EQUAL: "GREATER_OR_EQUAL";
+    readonly LESSER: "LESSER";
+    readonly LESSER_OR_EQUAL: "LESSER_OR_EQUAL";
+    readonly NOT_EQUAL: "NOT_EQUAL";
+    readonly RANGE: "RANGE";
+};
+/**
+ * @public
+ */
+export type NumberComparisonType = (typeof NumberComparisonType)[keyof typeof NumberComparisonType];
+/**
+ * <p>A leaf node condition which can be used to specify a numeric condition.</p>
+ *          <note>
+ *             <p>The currently supported value for <code>FieldName</code> is <code>limit</code>.</p>
+ *          </note>
+ * @public
+ */
+export interface NumberCondition {
+    /**
+     * <p>The name of the field in the number condition.</p>
+     * @public
+     */
+    FieldName?: string;
+    /**
+     * <p>The minValue to be used while evaluating the number condition.</p>
+     * @public
+     */
+    MinValue?: number;
+    /**
+     * <p>The maxValue to be used while evaluating the number condition.</p>
+     * @public
+     */
+    MaxValue?: number;
+    /**
+     * <p>The type of comparison to be made when evaluating the number condition.</p>
+     * @public
+     */
+    ComparisonType?: NumberComparisonType;
+}
+/**
+ * <p>A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and
+ *    ProficiencyLimit.</p>
+ * @public
+ */
+export interface Condition {
+    /**
+     * <p>A leaf node condition which can be used to specify a string condition.</p>
+     *          <note>
+     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
+     *      <code>value</code>.</p>
+     *          </note>
+     * @public
+     */
+    StringCondition?: StringCondition;
+    /**
+     * <p>A leaf node condition which can be used to specify a numeric condition.</p>
+     * @public
+     */
+    NumberCondition?: NumberCondition;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const TargetListType: {
+    readonly PROFICIENCIES: "PROFICIENCIES";
+};
+/**
+ * @public
+ */
+export type TargetListType = (typeof TargetListType)[keyof typeof TargetListType];
+/**
+ * <p>A leaf node condition which can be used to specify a List condition to search users with
+ *    attributes included in Lists like Proficiencies.</p>
+ * @public
+ */
+export interface ListCondition {
+    /**
+     * <p>The type of target list that will be used to filter the users.</p>
+     * @public
+     */
+    TargetListType?: TargetListType;
+    /**
+     * <p>A list of Condition objects which would be applied together with an AND condition.</p>
+     * @public
+     */
+    Conditions?: Condition[];
+}
 /**
  * <p>A list of conditions which would be applied together with an <code>AND</code>
  *    condition.</p>
@@ -5079,6 +5326,38 @@ export interface EvaluationFormSection {
      */
     Weight?: number;
 }
+/**
+ * <p>The search criteria to be used to return agent statuses.</p>
+ * @public
+ */
+export interface AgentStatusSearchCriteria {
+    /**
+     * <p>A list of conditions which would be applied together with an <code>OR</code>
+     *    condition.</p>
+     * @public
+     */
+    OrConditions?: AgentStatusSearchCriteria[];
+    /**
+     * <p>A leaf node condition which can be used to specify a string condition.</p>
+     *          <note>
+     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
+     *      <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
+     *     and <code>resourceID</code>.</p>
+     *          </note>
+     * @public
+     */
+    AndConditions?: AgentStatusSearchCriteria[];
+    /**
+     * <p>A leaf node condition which can be used to specify a string condition.</p>
+     *          <note>
+     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
+     *      <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
+     *     and <code>resourceID</code>.</p>
+     *          </note>
+     * @public
+     */
+    StringCondition?: StringCondition;
+}
 /**
  * <p>The search criteria to be used to return flow modules.</p>
  * @public
@@ -5098,10 +5377,6 @@ export interface ContactFlowModuleSearchCriteria {
     AndConditions?: ContactFlowModuleSearchCriteria[];
     /**
      * <p>A leaf node condition which can be used to specify a string condition.</p>
-     *          <note>
-     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
-     *      <code>description</code>.</p>
-     *          </note>
      * @public
      */
     StringCondition?: StringCondition;
@@ -5125,10 +5400,6 @@ export interface ContactFlowSearchCriteria {
     AndConditions?: ContactFlowSearchCriteria[];
     /**
      * <p>A leaf node condition which can be used to specify a string condition.</p>
-     *          <note>
-     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
-     *      <code>description</code>.</p>
-     *          </note>
      * @public
      */
     StringCondition?: StringCondition;
@@ -5368,10 +5639,6 @@ export interface PredefinedAttributeSearchCriteria {
     AndConditions?: PredefinedAttributeSearchCriteria[];
     /**
      * <p>A leaf node condition which can be used to specify a string condition.</p>
-     *          <note>
-     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
-     *      <code>description</code>.</p>
-     *          </note>
      * @public
      */
     StringCondition?: StringCondition;
@@ -5514,10 +5781,6 @@ export interface SecurityProfileSearchCriteria {
     AndConditions?: SecurityProfileSearchCriteria[];
     /**
      * <p>A leaf node condition which can be used to specify a string condition.</p>
-     *          <note>
-     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code> and
-     *      <code>description</code>.</p>
-     *          </note>
      * @public
      */
     StringCondition?: StringCondition;
@@ -5575,6 +5838,31 @@ export interface UpdateEvaluationFormRequest {
      */
     ClientToken?: string;
 }
+/**
+ * <p>The search criteria to be used to return userHierarchyGroup.</p>
+ * @public
+ */
+export interface UserHierarchyGroupSearchCriteria {
+    /**
+     * <p>A list of conditions which would be applied together with an OR condition.</p>
+     * @public
+     */
+    OrConditions?: UserHierarchyGroupSearchCriteria[];
+    /**
+     * <p>A list of conditions which would be applied together with an AND condition.</p>
+     * @public
+     */
+    AndConditions?: UserHierarchyGroupSearchCriteria[];
+    /**
+     * <p>A leaf node condition which can be used to specify a string condition.</p>
+     *          <note>
+     *             <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
+     *      <code>parentId</code>, <code>levelId</code>, and <code>resourceID</code>.</p>
+     *          </note>
+     * @public
+     */
+    StringCondition?: StringCondition;
+}
 /**
  * <p>The search criteria to be used to return users.</p>
  *          <note>
@@ -5605,6 +5893,12 @@ export interface UserSearchCriteria {
      * @public
      */
     StringCondition?: StringCondition;
+    /**
+     * <p>A leaf node condition which can be used to specify a List condition to search users with
+     *    attributes included in Lists like Proficiencies.</p>
+     * @public
+     */
+    ListCondition?: ListCondition;
     /**
      * <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
      * @public
@@ -5636,6 +5930,38 @@ export interface DescribeEvaluationFormResponse {
      */
     EvaluationForm: EvaluationForm | undefined;
 }
+/**
+ * @public
+ */
+export interface SearchAgentStatusesRequest {
+    /**
+     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
+     *    the instance.</p>
+     * @public
+     */
+    InstanceId: 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>Filters to be applied to search results.</p>
+     * @public
+     */
+    SearchFilter?: AgentStatusSearchFilter;
+    /**
+     * <p>The search criteria to be used to return agent statuses.</p>
+     * @public
+     */
+    SearchCriteria?: AgentStatusSearchCriteria;
+}
 /**
  * @public
  */
@@ -5942,6 +6268,38 @@ export interface SearchSecurityProfilesRequest {
      */
     SearchFilter?: SecurityProfilesSearchFilter;
 }
+/**
+ * @public
+ */
+export interface SearchUserHierarchyGroupsRequest {
+    /**
+     * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
+     *    the instance.</p>
+     * @public
+     */
+    InstanceId: 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>Filters to be applied to search results.</p>
+     * @public
+     */
+    SearchFilter?: UserHierarchyGroupSearchFilter;
+    /**
+     * <p>The search criteria to be used to return UserHierarchyGroups.</p>
+     * @public
+     */
+    SearchCriteria?: UserHierarchyGroupSearchCriteria;
+}
 /**
  * @public
  */

package/dist-types/pagination/SearchAgentStatusesPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { SearchAgentStatusesCommandInput, SearchAgentStatusesCommandOutput } from "../commands/SearchAgentStatusesCommand";
+import { ConnectPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateSearchAgentStatuses: (config: ConnectPaginationConfiguration, input: SearchAgentStatusesCommandInput, ...rest: any[]) => Paginator<SearchAgentStatusesCommandOutput>;

package/dist-types/pagination/SearchUserHierarchyGroupsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { SearchUserHierarchyGroupsCommandInput, SearchUserHierarchyGroupsCommandOutput } from "../commands/SearchUserHierarchyGroupsCommand";
+import { ConnectPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateSearchUserHierarchyGroups: (config: ConnectPaginationConfiguration, input: SearchUserHierarchyGroupsCommandInput, ...rest: any[]) => Paginator<SearchUserHierarchyGroupsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -46,6 +46,7 @@ export * from "./ListUserProficienciesPaginator";
 export * from "./ListUsersPaginator";
 export * from "./ListViewVersionsPaginator";
 export * from "./ListViewsPaginator";
+export * from "./SearchAgentStatusesPaginator";
 export * from "./SearchAvailablePhoneNumbersPaginator";
 export * from "./SearchContactFlowModulesPaginator";
 export * from "./SearchContactFlowsPaginator";
@@ -58,5 +59,6 @@ export * from "./SearchQuickConnectsPaginator";
 export * from "./SearchResourceTagsPaginator";
 export * from "./SearchRoutingProfilesPaginator";
 export * from "./SearchSecurityProfilesPaginator";
+export * from "./SearchUserHierarchyGroupsPaginator";
 export * from "./SearchUsersPaginator";
 export * from "./SearchVocabulariesPaginator";