@aws-sdk/client-connect 3.614.0 → 3.618.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +17 -2
  2. package/dist-cjs/index.js +227 -31
  3. package/dist-es/Connect.js +4 -0
  4. package/dist-es/ConnectClient.js +5 -5
  5. package/dist-es/commands/SearchAgentStatusesCommand.js +24 -0
  6. package/dist-es/commands/SearchUserHierarchyGroupsCommand.js +24 -0
  7. package/dist-es/commands/index.js +2 -0
  8. package/dist-es/models/models_0.js +5 -18
  9. package/dist-es/models/models_1.js +32 -0
  10. package/dist-es/models/models_2.js +12 -5
  11. package/dist-es/pagination/SearchAgentStatusesPaginator.js +4 -0
  12. package/dist-es/pagination/SearchUserHierarchyGroupsPaginator.js +4 -0
  13. package/dist-es/pagination/index.js +2 -0
  14. package/dist-es/protocols/Aws_restJson1.js +118 -2
  15. package/dist-types/Connect.d.ts +16 -3
  16. package/dist-types/ConnectClient.d.ts +8 -7
  17. package/dist-types/commands/DescribeContactEvaluationCommand.d.ts +1 -1
  18. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +6 -1
  19. package/dist-types/commands/ListTrafficDistributionGroupUsersCommand.d.ts +1 -1
  20. package/dist-types/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
  21. package/dist-types/commands/ListUseCasesCommand.d.ts +1 -1
  22. package/dist-types/commands/SearchAgentStatusesCommand.d.ts +142 -0
  23. package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +181 -0
  24. package/dist-types/commands/SearchUsersCommand.d.ts +32 -4
  25. package/dist-types/commands/index.d.ts +2 -0
  26. package/dist-types/index.d.ts +2 -3
  27. package/dist-types/models/models_0.d.ts +128 -133
  28. package/dist-types/models/models_1.d.ts +335 -241
  29. package/dist-types/models/models_2.d.ts +537 -73
  30. package/dist-types/pagination/SearchAgentStatusesPaginator.d.ts +7 -0
  31. package/dist-types/pagination/SearchUserHierarchyGroupsPaginator.d.ts +7 -0
  32. package/dist-types/pagination/index.d.ts +2 -0
  33. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  34. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  35. package/dist-types/runtimeConfig.d.ts +1 -1
  36. package/dist-types/runtimeConfig.native.d.ts +1 -1
  37. package/dist-types/ts3.4/Connect.d.ts +34 -0
  38. package/dist-types/ts3.4/ConnectClient.d.ts +14 -2
  39. package/dist-types/ts3.4/commands/DescribeContactEvaluationCommand.d.ts +1 -1
  40. package/dist-types/ts3.4/commands/ListTrafficDistributionGroupUsersCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/ListTrafficDistributionGroupsCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/ListUseCasesCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/SearchAgentStatusesCommand.d.ts +40 -0
  44. package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +40 -0
  45. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +27 -60
  47. package/dist-types/ts3.4/models/models_1.d.ts +100 -46
  48. package/dist-types/ts3.4/models/models_2.d.ts +125 -20
  49. package/dist-types/ts3.4/pagination/SearchAgentStatusesPaginator.d.ts +11 -0
  50. package/dist-types/ts3.4/pagination/SearchUserHierarchyGroupsPaginator.d.ts +11 -0
  51. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  52. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  53. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  54. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  55. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  56. package/package.json +17 -17
@@ -504,8 +504,8 @@ export interface AgentQualityMetrics {
504
504
  }
505
505
  /**
506
506
  * <p>Can be used to define a list of preferred agents to target the contact within the queue.
507
- * Note that agents must have the queue in their routing profile in order to be offered the
508
- * contact.</p>
507
+ * Note that agents must have the queue in their routing profile in order to be offered the
508
+ * contact.</p>
509
509
  * @public
510
510
  */
511
511
  export interface AgentsCriteria {
@@ -617,6 +617,126 @@ export interface AgentStatusReference {
617
617
  */
618
618
  StatusName?: string;
619
619
  }
620
+ /**
621
+ * @public
622
+ * @enum
623
+ */
624
+ export declare const StringComparisonType: {
625
+ readonly CONTAINS: "CONTAINS";
626
+ readonly EXACT: "EXACT";
627
+ readonly STARTS_WITH: "STARTS_WITH";
628
+ };
629
+ /**
630
+ * @public
631
+ */
632
+ export type StringComparisonType = (typeof StringComparisonType)[keyof typeof StringComparisonType];
633
+ /**
634
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
635
+ * @public
636
+ */
637
+ export interface StringCondition {
638
+ /**
639
+ * <p>The name of the field in the string condition.</p>
640
+ * @public
641
+ */
642
+ FieldName?: string;
643
+ /**
644
+ * <p>The value of the string.</p>
645
+ * @public
646
+ */
647
+ Value?: string;
648
+ /**
649
+ * <p>The type of comparison to be made when evaluating the string condition.</p>
650
+ * @public
651
+ */
652
+ ComparisonType?: StringComparisonType;
653
+ }
654
+ /**
655
+ * <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
656
+ * BPO = 123</code>. </p>
657
+ * @public
658
+ */
659
+ export interface TagCondition {
660
+ /**
661
+ * <p>The tag key in the tag condition.</p>
662
+ * @public
663
+ */
664
+ TagKey?: string;
665
+ /**
666
+ * <p>The tag value in the tag condition.</p>
667
+ * @public
668
+ */
669
+ TagValue?: string;
670
+ }
671
+ /**
672
+ * <p>A list of conditions which would be applied together with an <code>AND</code>
673
+ * condition.</p>
674
+ * @public
675
+ */
676
+ export interface CommonAttributeAndCondition {
677
+ /**
678
+ * <p>A leaf node condition which can be used to specify a tag condition.</p>
679
+ * @public
680
+ */
681
+ TagConditions?: TagCondition[];
682
+ }
683
+ /**
684
+ * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
685
+ * This accepts an <code>OR</code> or <code>AND</code> (List of List) input where: </p>
686
+ * <ul>
687
+ * <li>
688
+ * <p>The top level list specifies conditions that need to be applied with <code>OR</code>
689
+ * operator.</p>
690
+ * </li>
691
+ * <li>
692
+ * <p>The inner list specifies conditions that need to be applied with <code>AND</code>
693
+ * operator.</p>
694
+ * </li>
695
+ * </ul>
696
+ * @public
697
+ */
698
+ export interface ControlPlaneAttributeFilter {
699
+ /**
700
+ * <p>A list of conditions which would be applied together with an <code>OR</code>
701
+ * condition.</p>
702
+ * @public
703
+ */
704
+ OrConditions?: CommonAttributeAndCondition[];
705
+ /**
706
+ * <p>A list of conditions which would be applied together with an <code>AND</code>
707
+ * condition.</p>
708
+ * @public
709
+ */
710
+ AndCondition?: CommonAttributeAndCondition;
711
+ /**
712
+ * <p>A leaf node condition which can be used to specify a tag condition, for example, <code>HAVE
713
+ * BPO = 123</code>. </p>
714
+ * @public
715
+ */
716
+ TagCondition?: TagCondition;
717
+ }
718
+ /**
719
+ * <p>Filters to be applied to search results.</p>
720
+ * @public
721
+ */
722
+ export interface AgentStatusSearchFilter {
723
+ /**
724
+ * <p>An object that can be used to specify Tag conditions inside the <code>SearchFilter</code>.
725
+ * This accepts an <code>OR</code> of <code>AND</code> (List of List) input where: </p>
726
+ * <ul>
727
+ * <li>
728
+ * <p>The top level list specifies conditions that need to be applied with <code>OR</code>
729
+ * operator.</p>
730
+ * </li>
731
+ * <li>
732
+ * <p>The inner list specifies conditions that need to be applied with <code>AND</code>
733
+ * operator.</p>
734
+ * </li>
735
+ * </ul>
736
+ * @public
737
+ */
738
+ AttributeFilter?: ControlPlaneAttributeFilter;
739
+ }
620
740
  /**
621
741
  * <p>Summary information for an agent status.</p>
622
742
  * @public
@@ -5728,8 +5848,8 @@ export interface DescribeAuthenticationProfileRequest {
5728
5848
  * <p>Information about an authentication profile. An authentication profile is a resource that
5729
5849
  * stores the authentication settings for users in your contact center. You use authentication
5730
5850
  * profiles to set up IP address range restrictions and session timeouts. For more information, see
5731
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html">Set IP address restrictions or session timeouts</a>.
5732
- * </p>
5851
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html">Set IP
5852
+ * address restrictions or session timeouts</a>. </p>
5733
5853
  * @public
5734
5854
  */
5735
5855
  export interface AuthenticationProfile {
@@ -5755,16 +5875,16 @@ export interface AuthenticationProfile {
5755
5875
  Description?: string;
5756
5876
  /**
5757
5877
  * <p>A list of IP address range strings that are allowed to access the Amazon Connect
5758
- * 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
5759
- * IP address based access control</a> in the <i>Amazon Connect Administrator
5878
+ * 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
5879
+ * address based access control</a> in the <i>Amazon Connect Administrator
5760
5880
  * Guide</i>.</p>
5761
5881
  * @public
5762
5882
  */
5763
5883
  AllowedIps?: string[];
5764
5884
  /**
5765
5885
  * <p>A list of IP address range strings that are blocked from accessing the Amazon Connect
5766
- * 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
5767
- * IP address based access control</a> in the <i>Amazon Connect Administrator
5886
+ * 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
5887
+ * address based access control</a> in the <i>Amazon Connect Administrator
5768
5888
  * Guide</i>.</p>
5769
5889
  * @public
5770
5890
  */
@@ -6003,131 +6123,6 @@ export interface AttributeCondition {
6003
6123
  */
6004
6124
  ComparisonOperator?: string;
6005
6125
  }
6006
- /**
6007
- * @public
6008
- * @enum
6009
- */
6010
- export declare const RoutingCriteriaStepStatus: {
6011
- readonly ACTIVE: "ACTIVE";
6012
- readonly EXPIRED: "EXPIRED";
6013
- readonly INACTIVE: "INACTIVE";
6014
- readonly JOINED: "JOINED";
6015
- };
6016
- /**
6017
- * @public
6018
- */
6019
- export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus];
6020
- /**
6021
- * <p>A value for a segment attribute. This is structured as a map where the key is
6022
- * <code>valueString</code> and the value is a string.</p>
6023
- * @public
6024
- */
6025
- export interface SegmentAttributeValue {
6026
- /**
6027
- * <p>The value of a segment attribute.</p>
6028
- * @public
6029
- */
6030
- ValueString?: string;
6031
- }
6032
- /**
6033
- * <p>Information about Amazon Connect Wisdom.</p>
6034
- * @public
6035
- */
6036
- export interface WisdomInfo {
6037
- /**
6038
- * <p>The Amazon Resource Name (ARN) of the Wisdom session.</p>
6039
- * @public
6040
- */
6041
- SessionArn?: string;
6042
- }
6043
- /**
6044
- * @public
6045
- */
6046
- export interface DescribeContactEvaluationRequest {
6047
- /**
6048
- * <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>
6049
- * @public
6050
- */
6051
- InstanceId: string | undefined;
6052
- /**
6053
- * <p>A unique identifier for the contact evaluation.</p>
6054
- * @public
6055
- */
6056
- EvaluationId: string | undefined;
6057
- }
6058
- /**
6059
- * <p>Information about answer data for a contact evaluation. Answer data must be either string,
6060
- * numeric, or not applicable.</p>
6061
- * @public
6062
- */
6063
- export type EvaluationAnswerData = EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.$UnknownMember;
6064
- /**
6065
- * @public
6066
- */
6067
- export declare namespace EvaluationAnswerData {
6068
- /**
6069
- * <p>The string value for an answer in a contact evaluation.</p>
6070
- * @public
6071
- */
6072
- interface StringValueMember {
6073
- StringValue: string;
6074
- NumericValue?: never;
6075
- NotApplicable?: never;
6076
- $unknown?: never;
6077
- }
6078
- /**
6079
- * <p>The numeric value for an answer in a contact evaluation.</p>
6080
- * @public
6081
- */
6082
- interface NumericValueMember {
6083
- StringValue?: never;
6084
- NumericValue: number;
6085
- NotApplicable?: never;
6086
- $unknown?: never;
6087
- }
6088
- /**
6089
- * <p>The flag to mark the question as not applicable.</p>
6090
- * @public
6091
- */
6092
- interface NotApplicableMember {
6093
- StringValue?: never;
6094
- NumericValue?: never;
6095
- NotApplicable: boolean;
6096
- $unknown?: never;
6097
- }
6098
- /**
6099
- * @public
6100
- */
6101
- interface $UnknownMember {
6102
- StringValue?: never;
6103
- NumericValue?: never;
6104
- NotApplicable?: never;
6105
- $unknown: [string, any];
6106
- }
6107
- interface Visitor<T> {
6108
- StringValue: (value: string) => T;
6109
- NumericValue: (value: number) => T;
6110
- NotApplicable: (value: boolean) => T;
6111
- _: (name: string, value: any) => T;
6112
- }
6113
- const visit: <T>(value: EvaluationAnswerData, visitor: Visitor<T>) => T;
6114
- }
6115
- /**
6116
- * <p>Information about output answers for a contact evaluation.</p>
6117
- * @public
6118
- */
6119
- export interface EvaluationAnswerOutput {
6120
- /**
6121
- * <p>The value for an answer in a contact evaluation.</p>
6122
- * @public
6123
- */
6124
- Value?: EvaluationAnswerData;
6125
- /**
6126
- * <p>The system suggested value for an answer in a contact evaluation.</p>
6127
- * @public
6128
- */
6129
- SystemSuggestedValue?: EvaluationAnswerData;
6130
- }
6131
6126
  /**
6132
6127
  * @internal
6133
6128
  */