aws-sdk-connect 1.67.0 → 1.70.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -382,6 +382,38 @@ module Aws::Connect
382
382
  include Aws::Structure
383
383
  end
384
384
 
385
+ # @note When making an API call, you may pass AssociatePhoneNumberContactFlowRequest
386
+ # data as a hash:
387
+ #
388
+ # {
389
+ # phone_number_id: "PhoneNumberId", # required
390
+ # instance_id: "InstanceId", # required
391
+ # contact_flow_id: "ContactFlowId", # required
392
+ # }
393
+ #
394
+ # @!attribute [rw] phone_number_id
395
+ # A unique identifier for the phone number.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] instance_id
399
+ # The identifier of the Amazon Connect instance. You can find the
400
+ # instanceId in the ARN of the instance.
401
+ # @return [String]
402
+ #
403
+ # @!attribute [rw] contact_flow_id
404
+ # The identifier of the contact flow.
405
+ # @return [String]
406
+ #
407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociatePhoneNumberContactFlowRequest AWS API Documentation
408
+ #
409
+ class AssociatePhoneNumberContactFlowRequest < Struct.new(
410
+ :phone_number_id,
411
+ :instance_id,
412
+ :contact_flow_id)
413
+ SENSITIVE = []
414
+ include Aws::Structure
415
+ end
416
+
385
417
  # @note When making an API call, you may pass AssociateQueueQuickConnectsRequest
386
418
  # data as a hash:
387
419
  #
@@ -538,6 +570,31 @@ module Aws::Connect
538
570
  include Aws::Structure
539
571
  end
540
572
 
573
+ # Information about available phone numbers.
574
+ #
575
+ # @!attribute [rw] phone_number
576
+ # The phone number. Phone numbers are formatted `[+] [country code]
577
+ # [subscriber number including area code]`.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] phone_number_country_code
581
+ # The ISO country code.
582
+ # @return [String]
583
+ #
584
+ # @!attribute [rw] phone_number_type
585
+ # The type of phone number.
586
+ # @return [String]
587
+ #
588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AvailableNumberSummary AWS API Documentation
589
+ #
590
+ class AvailableNumberSummary < Struct.new(
591
+ :phone_number,
592
+ :phone_number_country_code,
593
+ :phone_number_type)
594
+ SENSITIVE = []
595
+ include Aws::Structure
596
+ end
597
+
541
598
  # A chat message.
542
599
  #
543
600
  # @note When making an API call, you may pass ChatMessage
@@ -589,6 +646,133 @@ module Aws::Connect
589
646
  include Aws::Structure
590
647
  end
591
648
 
649
+ # @note When making an API call, you may pass ClaimPhoneNumberRequest
650
+ # data as a hash:
651
+ #
652
+ # {
653
+ # target_arn: "ARN", # required
654
+ # phone_number: "PhoneNumber", # required
655
+ # phone_number_description: "PhoneNumberDescription",
656
+ # tags: {
657
+ # "TagKey" => "TagValue",
658
+ # },
659
+ # client_token: "ClientToken",
660
+ # }
661
+ #
662
+ # @!attribute [rw] target_arn
663
+ # The Amazon Resource Name (ARN) for Amazon Connect instances that
664
+ # phone numbers are claimed to.
665
+ # @return [String]
666
+ #
667
+ # @!attribute [rw] phone_number
668
+ # The phone number you want to claim. Phone numbers are formatted `[+]
669
+ # [country code] [subscriber number including area code]`.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] phone_number_description
673
+ # The description of the phone number.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] tags
677
+ # The tags used to organize, track, or control access for this
678
+ # resource.
679
+ # @return [Hash<String,String>]
680
+ #
681
+ # @!attribute [rw] client_token
682
+ # A unique, case-sensitive identifier that you provide to ensure the
683
+ # idempotency of the request.
684
+ #
685
+ # **A suitable default value is auto-generated.** You should normally
686
+ # not need to pass this option.
687
+ # @return [String]
688
+ #
689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimPhoneNumberRequest AWS API Documentation
690
+ #
691
+ class ClaimPhoneNumberRequest < Struct.new(
692
+ :target_arn,
693
+ :phone_number,
694
+ :phone_number_description,
695
+ :tags,
696
+ :client_token)
697
+ SENSITIVE = []
698
+ include Aws::Structure
699
+ end
700
+
701
+ # @!attribute [rw] phone_number_id
702
+ # A unique identifier for the phone number.
703
+ # @return [String]
704
+ #
705
+ # @!attribute [rw] phone_number_arn
706
+ # The Amazon Resource Name (ARN) of the phone number.
707
+ # @return [String]
708
+ #
709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimPhoneNumberResponse AWS API Documentation
710
+ #
711
+ class ClaimPhoneNumberResponse < Struct.new(
712
+ :phone_number_id,
713
+ :phone_number_arn)
714
+ SENSITIVE = []
715
+ include Aws::Structure
716
+ end
717
+
718
+ # Information about a phone number that has been claimed to your Amazon
719
+ # Connect instance.
720
+ #
721
+ # @!attribute [rw] phone_number_id
722
+ # A unique identifier for the phone number.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] phone_number_arn
726
+ # The Amazon Resource Name (ARN) of the phone number.
727
+ # @return [String]
728
+ #
729
+ # @!attribute [rw] phone_number
730
+ # The phone number. Phone numbers are formatted `[+] [country code]
731
+ # [subscriber number including area code]`.
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] phone_number_country_code
735
+ # The ISO country code.
736
+ # @return [String]
737
+ #
738
+ # @!attribute [rw] phone_number_type
739
+ # The type of phone number.
740
+ # @return [String]
741
+ #
742
+ # @!attribute [rw] phone_number_description
743
+ # The description of the phone number.
744
+ # @return [String]
745
+ #
746
+ # @!attribute [rw] target_arn
747
+ # The Amazon Resource Name (ARN) for Amazon Connect instances that
748
+ # phone numbers are claimed to.
749
+ # @return [String]
750
+ #
751
+ # @!attribute [rw] tags
752
+ # The tags used to organize, track, or control access for this
753
+ # resource.
754
+ # @return [Hash<String,String>]
755
+ #
756
+ # @!attribute [rw] phone_number_status
757
+ # The status of the phone number.
758
+ # @return [Types::PhoneNumberStatus]
759
+ #
760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimedPhoneNumberSummary AWS API Documentation
761
+ #
762
+ class ClaimedPhoneNumberSummary < Struct.new(
763
+ :phone_number_id,
764
+ :phone_number_arn,
765
+ :phone_number,
766
+ :phone_number_country_code,
767
+ :phone_number_type,
768
+ :phone_number_description,
769
+ :target_arn,
770
+ :tags,
771
+ :phone_number_status)
772
+ SENSITIVE = []
773
+ include Aws::Structure
774
+ end
775
+
592
776
  # Contains information about a contact.
593
777
  #
594
778
  # @!attribute [rw] arn
@@ -880,6 +1064,64 @@ module Aws::Connect
880
1064
  include Aws::Structure
881
1065
  end
882
1066
 
1067
+ # An object that can be used to specify Tag conditions inside the
1068
+ # `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
1069
+ # where:
1070
+ #
1071
+ # * Top level list specifies conditions that need to be applied with
1072
+ # `OR` operator
1073
+ #
1074
+ # * Inner list specifies conditions that need to be applied with `AND`
1075
+ # operator.
1076
+ #
1077
+ # @note When making an API call, you may pass ControlPlaneTagFilter
1078
+ # data as a hash:
1079
+ #
1080
+ # {
1081
+ # or_conditions: [
1082
+ # [
1083
+ # {
1084
+ # tag_key: "String",
1085
+ # tag_value: "String",
1086
+ # },
1087
+ # ],
1088
+ # ],
1089
+ # and_conditions: [
1090
+ # {
1091
+ # tag_key: "String",
1092
+ # tag_value: "String",
1093
+ # },
1094
+ # ],
1095
+ # tag_condition: {
1096
+ # tag_key: "String",
1097
+ # tag_value: "String",
1098
+ # },
1099
+ # }
1100
+ #
1101
+ # @!attribute [rw] or_conditions
1102
+ # A list of conditions which would be applied together with an `OR`
1103
+ # condition.
1104
+ # @return [Array<Array<Types::TagCondition>>]
1105
+ #
1106
+ # @!attribute [rw] and_conditions
1107
+ # A list of conditions which would be applied together with an `AND`
1108
+ # condition.
1109
+ # @return [Array<Types::TagCondition>]
1110
+ #
1111
+ # @!attribute [rw] tag_condition
1112
+ # A leaf node condition which can be used to specify a tag condition.
1113
+ # @return [Types::TagCondition]
1114
+ #
1115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ControlPlaneTagFilter AWS API Documentation
1116
+ #
1117
+ class ControlPlaneTagFilter < Struct.new(
1118
+ :or_conditions,
1119
+ :and_conditions,
1120
+ :tag_condition)
1121
+ SENSITIVE = []
1122
+ include Aws::Structure
1123
+ end
1124
+
883
1125
  # @note When making an API call, you may pass CreateAgentStatusRequest
884
1126
  # data as a hash:
885
1127
  #
@@ -2626,7 +2868,7 @@ module Aws::Connect
2626
2868
  #
2627
2869
  # {
2628
2870
  # instance_id: "InstanceId", # required
2629
- # attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
2871
+ # attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE
2630
2872
  # }
2631
2873
  #
2632
2874
  # @!attribute [rw] instance_id
@@ -2736,6 +2978,38 @@ module Aws::Connect
2736
2978
  include Aws::Structure
2737
2979
  end
2738
2980
 
2981
+ # @note When making an API call, you may pass DescribePhoneNumberRequest
2982
+ # data as a hash:
2983
+ #
2984
+ # {
2985
+ # phone_number_id: "PhoneNumberId", # required
2986
+ # }
2987
+ #
2988
+ # @!attribute [rw] phone_number_id
2989
+ # A unique identifier for the phone number.
2990
+ # @return [String]
2991
+ #
2992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumberRequest AWS API Documentation
2993
+ #
2994
+ class DescribePhoneNumberRequest < Struct.new(
2995
+ :phone_number_id)
2996
+ SENSITIVE = []
2997
+ include Aws::Structure
2998
+ end
2999
+
3000
+ # @!attribute [rw] claimed_phone_number_summary
3001
+ # Information about a phone number that's been claimed to your Amazon
3002
+ # Connect instance.
3003
+ # @return [Types::ClaimedPhoneNumberSummary]
3004
+ #
3005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumberResponse AWS API Documentation
3006
+ #
3007
+ class DescribePhoneNumberResponse < Struct.new(
3008
+ :claimed_phone_number_summary)
3009
+ SENSITIVE = []
3010
+ include Aws::Structure
3011
+ end
3012
+
2739
3013
  # @note When making an API call, you may pass DescribeQueueRequest
2740
3014
  # data as a hash:
2741
3015
  #
@@ -3225,6 +3499,32 @@ module Aws::Connect
3225
3499
  include Aws::Structure
3226
3500
  end
3227
3501
 
3502
+ # @note When making an API call, you may pass DisassociatePhoneNumberContactFlowRequest
3503
+ # data as a hash:
3504
+ #
3505
+ # {
3506
+ # phone_number_id: "PhoneNumberId", # required
3507
+ # instance_id: "InstanceId", # required
3508
+ # }
3509
+ #
3510
+ # @!attribute [rw] phone_number_id
3511
+ # A unique identifier for the phone number.
3512
+ # @return [String]
3513
+ #
3514
+ # @!attribute [rw] instance_id
3515
+ # The identifier of the Amazon Connect instance. You can find the
3516
+ # instanceId in the ARN of the instance.
3517
+ # @return [String]
3518
+ #
3519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociatePhoneNumberContactFlowRequest AWS API Documentation
3520
+ #
3521
+ class DisassociatePhoneNumberContactFlowRequest < Struct.new(
3522
+ :phone_number_id,
3523
+ :instance_id)
3524
+ SENSITIVE = []
3525
+ include Aws::Structure
3526
+ end
3527
+
3228
3528
  # @note When making an API call, you may pass DisassociateQueueQuickConnectsRequest
3229
3529
  # data as a hash:
3230
3530
  #
@@ -4014,6 +4314,34 @@ module Aws::Connect
4014
4314
  include Aws::Structure
4015
4315
  end
4016
4316
 
4317
+ # A leaf node condition which can be used to specify a hierarchy group
4318
+ # condition.
4319
+ #
4320
+ # @note When making an API call, you may pass HierarchyGroupCondition
4321
+ # data as a hash:
4322
+ #
4323
+ # {
4324
+ # value: "String",
4325
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
4326
+ # }
4327
+ #
4328
+ # @!attribute [rw] value
4329
+ # The value in the hierarchy group condition.
4330
+ # @return [String]
4331
+ #
4332
+ # @!attribute [rw] hierarchy_group_match_type
4333
+ # The type of hierarchy group match.
4334
+ # @return [String]
4335
+ #
4336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroupCondition AWS API Documentation
4337
+ #
4338
+ class HierarchyGroupCondition < Struct.new(
4339
+ :value,
4340
+ :hierarchy_group_match_type)
4341
+ SENSITIVE = []
4342
+ include Aws::Structure
4343
+ end
4344
+
4017
4345
  # Contains summary information about a hierarchy group.
4018
4346
  #
4019
4347
  # @!attribute [rw] id
@@ -5771,68 +6099,184 @@ module Aws::Connect
5771
6099
  include Aws::Structure
5772
6100
  end
5773
6101
 
5774
- # @note When making an API call, you may pass ListPromptsRequest
5775
- # data as a hash:
5776
- #
5777
- # {
5778
- # instance_id: "InstanceId", # required
5779
- # next_token: "NextToken",
5780
- # max_results: 1,
5781
- # }
6102
+ # Information about phone numbers that have been claimed to your Amazon
6103
+ # Connect instance.
5782
6104
  #
5783
- # @!attribute [rw] instance_id
5784
- # The identifier of the Amazon Connect instance.
6105
+ # @!attribute [rw] phone_number_id
6106
+ # A unique identifier for the phone number.
5785
6107
  # @return [String]
5786
6108
  #
5787
- # @!attribute [rw] next_token
5788
- # The token for the next set of results. Use the value returned in the
5789
- # previous response in the next request to retrieve the next set of
5790
- # results.
6109
+ # @!attribute [rw] phone_number_arn
6110
+ # The Amazon Resource Name (ARN) of the phone number.
5791
6111
  # @return [String]
5792
6112
  #
5793
- # @!attribute [rw] max_results
5794
- # The maximum number of results to return per page.
5795
- # @return [Integer]
6113
+ # @!attribute [rw] phone_number
6114
+ # The phone number. Phone numbers are formatted `[+] [country code]
6115
+ # [subscriber number including area code]`.
6116
+ # @return [String]
5796
6117
  #
5797
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
6118
+ # @!attribute [rw] phone_number_country_code
6119
+ # The ISO country code.
6120
+ # @return [String]
5798
6121
  #
5799
- class ListPromptsRequest < Struct.new(
5800
- :instance_id,
5801
- :next_token,
5802
- :max_results)
5803
- SENSITIVE = []
5804
- include Aws::Structure
5805
- end
5806
-
5807
- # @!attribute [rw] prompt_summary_list
5808
- # Information about the prompts.
5809
- # @return [Array<Types::PromptSummary>]
6122
+ # @!attribute [rw] phone_number_type
6123
+ # The type of phone number.
6124
+ # @return [String]
5810
6125
  #
5811
- # @!attribute [rw] next_token
5812
- # If there are additional results, this is the token for the next set
5813
- # of results.
6126
+ # @!attribute [rw] target_arn
6127
+ # The Amazon Resource Name (ARN) for Amazon Connect instances that
6128
+ # phone numbers are claimed to.
5814
6129
  # @return [String]
5815
6130
  #
5816
- # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsResponse AWS API Documentation
6131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersSummary AWS API Documentation
5817
6132
  #
5818
- class ListPromptsResponse < Struct.new(
5819
- :prompt_summary_list,
5820
- :next_token)
6133
+ class ListPhoneNumbersSummary < Struct.new(
6134
+ :phone_number_id,
6135
+ :phone_number_arn,
6136
+ :phone_number,
6137
+ :phone_number_country_code,
6138
+ :phone_number_type,
6139
+ :target_arn)
5821
6140
  SENSITIVE = []
5822
6141
  include Aws::Structure
5823
6142
  end
5824
6143
 
5825
- # @note When making an API call, you may pass ListQueueQuickConnectsRequest
6144
+ # @note When making an API call, you may pass ListPhoneNumbersV2Request
5826
6145
  # data as a hash:
5827
6146
  #
5828
6147
  # {
5829
- # instance_id: "InstanceId", # required
5830
- # queue_id: "QueueId", # required
5831
- # next_token: "NextToken",
6148
+ # target_arn: "ARN",
5832
6149
  # max_results: 1,
6150
+ # next_token: "LargeNextToken",
6151
+ # phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
6152
+ # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
6153
+ # phone_number_prefix: "PhoneNumberPrefix",
5833
6154
  # }
5834
6155
  #
5835
- # @!attribute [rw] instance_id
6156
+ # @!attribute [rw] target_arn
6157
+ # The Amazon Resource Name (ARN) for Amazon Connect instances that
6158
+ # phone numbers are claimed to. If `TargetArn` input is not provided,
6159
+ # this API lists numbers claimed to all the Amazon Connect instances
6160
+ # belonging to your account.
6161
+ # @return [String]
6162
+ #
6163
+ # @!attribute [rw] max_results
6164
+ # The maximum number of results to return per page.
6165
+ # @return [Integer]
6166
+ #
6167
+ # @!attribute [rw] next_token
6168
+ # The token for the next set of results. Use the value returned in the
6169
+ # previous response in the next request to retrieve the next set of
6170
+ # results.
6171
+ # @return [String]
6172
+ #
6173
+ # @!attribute [rw] phone_number_country_codes
6174
+ # The ISO country code.
6175
+ # @return [Array<String>]
6176
+ #
6177
+ # @!attribute [rw] phone_number_types
6178
+ # The type of phone number.
6179
+ # @return [Array<String>]
6180
+ #
6181
+ # @!attribute [rw] phone_number_prefix
6182
+ # The prefix of the phone number. If provided, it must contain `+` as
6183
+ # part of the country code.
6184
+ # @return [String]
6185
+ #
6186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersV2Request AWS API Documentation
6187
+ #
6188
+ class ListPhoneNumbersV2Request < Struct.new(
6189
+ :target_arn,
6190
+ :max_results,
6191
+ :next_token,
6192
+ :phone_number_country_codes,
6193
+ :phone_number_types,
6194
+ :phone_number_prefix)
6195
+ SENSITIVE = []
6196
+ include Aws::Structure
6197
+ end
6198
+
6199
+ # @!attribute [rw] next_token
6200
+ # If there are additional results, this is the token for the next set
6201
+ # of results.
6202
+ # @return [String]
6203
+ #
6204
+ # @!attribute [rw] list_phone_numbers_summary_list
6205
+ # Information about phone numbers that have been claimed to your
6206
+ # Amazon Connect instances.
6207
+ # @return [Array<Types::ListPhoneNumbersSummary>]
6208
+ #
6209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersV2Response AWS API Documentation
6210
+ #
6211
+ class ListPhoneNumbersV2Response < Struct.new(
6212
+ :next_token,
6213
+ :list_phone_numbers_summary_list)
6214
+ SENSITIVE = []
6215
+ include Aws::Structure
6216
+ end
6217
+
6218
+ # @note When making an API call, you may pass ListPromptsRequest
6219
+ # data as a hash:
6220
+ #
6221
+ # {
6222
+ # instance_id: "InstanceId", # required
6223
+ # next_token: "NextToken",
6224
+ # max_results: 1,
6225
+ # }
6226
+ #
6227
+ # @!attribute [rw] instance_id
6228
+ # The identifier of the Amazon Connect instance.
6229
+ # @return [String]
6230
+ #
6231
+ # @!attribute [rw] next_token
6232
+ # The token for the next set of results. Use the value returned in the
6233
+ # previous response in the next request to retrieve the next set of
6234
+ # results.
6235
+ # @return [String]
6236
+ #
6237
+ # @!attribute [rw] max_results
6238
+ # The maximum number of results to return per page.
6239
+ # @return [Integer]
6240
+ #
6241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
6242
+ #
6243
+ class ListPromptsRequest < Struct.new(
6244
+ :instance_id,
6245
+ :next_token,
6246
+ :max_results)
6247
+ SENSITIVE = []
6248
+ include Aws::Structure
6249
+ end
6250
+
6251
+ # @!attribute [rw] prompt_summary_list
6252
+ # Information about the prompts.
6253
+ # @return [Array<Types::PromptSummary>]
6254
+ #
6255
+ # @!attribute [rw] next_token
6256
+ # If there are additional results, this is the token for the next set
6257
+ # of results.
6258
+ # @return [String]
6259
+ #
6260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsResponse AWS API Documentation
6261
+ #
6262
+ class ListPromptsResponse < Struct.new(
6263
+ :prompt_summary_list,
6264
+ :next_token)
6265
+ SENSITIVE = []
6266
+ include Aws::Structure
6267
+ end
6268
+
6269
+ # @note When making an API call, you may pass ListQueueQuickConnectsRequest
6270
+ # data as a hash:
6271
+ #
6272
+ # {
6273
+ # instance_id: "InstanceId", # required
6274
+ # queue_id: "QueueId", # required
6275
+ # next_token: "NextToken",
6276
+ # max_results: 1,
6277
+ # }
6278
+ #
6279
+ # @!attribute [rw] instance_id
5836
6280
  # The identifier of the Amazon Connect instance. You can find the
5837
6281
  # instanceId in the ARN of the instance.
5838
6282
  # @return [String]
@@ -6592,6 +7036,25 @@ module Aws::Connect
6592
7036
  include Aws::Structure
6593
7037
  end
6594
7038
 
7039
+ # The status of the phone number.
7040
+ #
7041
+ # @!attribute [rw] status
7042
+ # The status.
7043
+ # @return [String]
7044
+ #
7045
+ # @!attribute [rw] message
7046
+ # The status message.
7047
+ # @return [String]
7048
+ #
7049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PhoneNumberStatus AWS API Documentation
7050
+ #
7051
+ class PhoneNumberStatus < Struct.new(
7052
+ :status,
7053
+ :message)
7054
+ SENSITIVE = []
7055
+ include Aws::Structure
7056
+ end
7057
+
6595
7058
  # Contains summary information about a phone number for a contact
6596
7059
  # center.
6597
7060
  #
@@ -7004,6 +7467,35 @@ module Aws::Connect
7004
7467
  class Unknown < ReferenceSummary; end
7005
7468
  end
7006
7469
 
7470
+ # @note When making an API call, you may pass ReleasePhoneNumberRequest
7471
+ # data as a hash:
7472
+ #
7473
+ # {
7474
+ # phone_number_id: "PhoneNumberId", # required
7475
+ # client_token: "ClientToken",
7476
+ # }
7477
+ #
7478
+ # @!attribute [rw] phone_number_id
7479
+ # A unique identifier for the phone number.
7480
+ # @return [String]
7481
+ #
7482
+ # @!attribute [rw] client_token
7483
+ # A unique, case-sensitive identifier that you provide to ensure the
7484
+ # idempotency of the request.
7485
+ #
7486
+ # **A suitable default value is auto-generated.** You should normally
7487
+ # not need to pass this option.
7488
+ # @return [String]
7489
+ #
7490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReleasePhoneNumberRequest AWS API Documentation
7491
+ #
7492
+ class ReleasePhoneNumberRequest < Struct.new(
7493
+ :phone_number_id,
7494
+ :client_token)
7495
+ SENSITIVE = []
7496
+ include Aws::Structure
7497
+ end
7498
+
7007
7499
  # A resource already has that name.
7008
7500
  #
7009
7501
  # @!attribute [rw] message
@@ -7331,6 +7823,188 @@ module Aws::Connect
7331
7823
  include Aws::Structure
7332
7824
  end
7333
7825
 
7826
+ # @note When making an API call, you may pass SearchAvailablePhoneNumbersRequest
7827
+ # data as a hash:
7828
+ #
7829
+ # {
7830
+ # target_arn: "ARN", # required
7831
+ # phone_number_country_code: "AF", # required, accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
7832
+ # phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID
7833
+ # phone_number_prefix: "PhoneNumberPrefix",
7834
+ # max_results: 1,
7835
+ # next_token: "LargeNextToken",
7836
+ # }
7837
+ #
7838
+ # @!attribute [rw] target_arn
7839
+ # The Amazon Resource Name (ARN) for Amazon Connect instances that
7840
+ # phone numbers are claimed to.
7841
+ # @return [String]
7842
+ #
7843
+ # @!attribute [rw] phone_number_country_code
7844
+ # The ISO country code.
7845
+ # @return [String]
7846
+ #
7847
+ # @!attribute [rw] phone_number_type
7848
+ # The type of phone number.
7849
+ # @return [String]
7850
+ #
7851
+ # @!attribute [rw] phone_number_prefix
7852
+ # The prefix of the phone number. If provided, it must contain `+` as
7853
+ # part of the country code.
7854
+ # @return [String]
7855
+ #
7856
+ # @!attribute [rw] max_results
7857
+ # The maximum number of results to return per page.
7858
+ # @return [Integer]
7859
+ #
7860
+ # @!attribute [rw] next_token
7861
+ # The token for the next set of results. Use the value returned in the
7862
+ # previous response in the next request to retrieve the next set of
7863
+ # results.
7864
+ # @return [String]
7865
+ #
7866
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbersRequest AWS API Documentation
7867
+ #
7868
+ class SearchAvailablePhoneNumbersRequest < Struct.new(
7869
+ :target_arn,
7870
+ :phone_number_country_code,
7871
+ :phone_number_type,
7872
+ :phone_number_prefix,
7873
+ :max_results,
7874
+ :next_token)
7875
+ SENSITIVE = []
7876
+ include Aws::Structure
7877
+ end
7878
+
7879
+ # @!attribute [rw] next_token
7880
+ # If there are additional results, this is the token for the next set
7881
+ # of results.
7882
+ # @return [String]
7883
+ #
7884
+ # @!attribute [rw] available_numbers_list
7885
+ # A list of available phone numbers that you can claim for your Amazon
7886
+ # Connect instance.
7887
+ # @return [Array<Types::AvailableNumberSummary>]
7888
+ #
7889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbersResponse AWS API Documentation
7890
+ #
7891
+ class SearchAvailablePhoneNumbersResponse < Struct.new(
7892
+ :next_token,
7893
+ :available_numbers_list)
7894
+ SENSITIVE = []
7895
+ include Aws::Structure
7896
+ end
7897
+
7898
+ # @note When making an API call, you may pass SearchUsersRequest
7899
+ # data as a hash:
7900
+ #
7901
+ # {
7902
+ # instance_id: "InstanceId",
7903
+ # next_token: "NextToken2500",
7904
+ # max_results: 1,
7905
+ # search_filter: {
7906
+ # tag_filter: {
7907
+ # or_conditions: [
7908
+ # [
7909
+ # {
7910
+ # tag_key: "String",
7911
+ # tag_value: "String",
7912
+ # },
7913
+ # ],
7914
+ # ],
7915
+ # and_conditions: [
7916
+ # {
7917
+ # tag_key: "String",
7918
+ # tag_value: "String",
7919
+ # },
7920
+ # ],
7921
+ # tag_condition: {
7922
+ # tag_key: "String",
7923
+ # tag_value: "String",
7924
+ # },
7925
+ # },
7926
+ # },
7927
+ # search_criteria: {
7928
+ # or_conditions: [
7929
+ # {
7930
+ # # recursive UserSearchCriteria
7931
+ # },
7932
+ # ],
7933
+ # and_conditions: [
7934
+ # {
7935
+ # # recursive UserSearchCriteria
7936
+ # },
7937
+ # ],
7938
+ # string_condition: {
7939
+ # field_name: "String",
7940
+ # value: "String",
7941
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
7942
+ # },
7943
+ # hierarchy_group_condition: {
7944
+ # value: "String",
7945
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
7946
+ # },
7947
+ # },
7948
+ # }
7949
+ #
7950
+ # @!attribute [rw] instance_id
7951
+ # The identifier of the Amazon Connect instance. You can find the
7952
+ # instanceId in the ARN of the instance.
7953
+ # @return [String]
7954
+ #
7955
+ # @!attribute [rw] next_token
7956
+ # The token for the next set of results. Use the value returned in the
7957
+ # previous response in the next request to retrieve the next set of
7958
+ # results.
7959
+ # @return [String]
7960
+ #
7961
+ # @!attribute [rw] max_results
7962
+ # The maximum number of results to return per page.
7963
+ # @return [Integer]
7964
+ #
7965
+ # @!attribute [rw] search_filter
7966
+ # Filters to be applied to search results.
7967
+ # @return [Types::UserSearchFilter]
7968
+ #
7969
+ # @!attribute [rw] search_criteria
7970
+ # The search criteria to be used to return users.
7971
+ # @return [Types::UserSearchCriteria]
7972
+ #
7973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsersRequest AWS API Documentation
7974
+ #
7975
+ class SearchUsersRequest < Struct.new(
7976
+ :instance_id,
7977
+ :next_token,
7978
+ :max_results,
7979
+ :search_filter,
7980
+ :search_criteria)
7981
+ SENSITIVE = []
7982
+ include Aws::Structure
7983
+ end
7984
+
7985
+ # @!attribute [rw] users
7986
+ # Information about the users.
7987
+ # @return [Array<Types::UserSearchSummary>]
7988
+ #
7989
+ # @!attribute [rw] next_token
7990
+ # If there are additional results, this is the token for the next set
7991
+ # of results.
7992
+ # @return [String]
7993
+ #
7994
+ # @!attribute [rw] approximate_total_count
7995
+ # The total number of users who matched your search query.
7996
+ # @return [Integer]
7997
+ #
7998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsersResponse AWS API Documentation
7999
+ #
8000
+ class SearchUsersResponse < Struct.new(
8001
+ :users,
8002
+ :next_token,
8003
+ :approximate_total_count)
8004
+ SENSITIVE = []
8005
+ include Aws::Structure
8006
+ end
8007
+
7334
8008
  # @note When making an API call, you may pass SearchVocabulariesRequest
7335
8009
  # data as a hash:
7336
8010
  #
@@ -8065,6 +8739,41 @@ module Aws::Connect
8065
8739
  #
8066
8740
  class StopContactStreamingResponse < Aws::EmptyStructure; end
8067
8741
 
8742
+ # A leaf node condition which can be used to specify a string condition,
8743
+ # for example, `username = 'abc'`.
8744
+ #
8745
+ # @note When making an API call, you may pass StringCondition
8746
+ # data as a hash:
8747
+ #
8748
+ # {
8749
+ # field_name: "String",
8750
+ # value: "String",
8751
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
8752
+ # }
8753
+ #
8754
+ # @!attribute [rw] field_name
8755
+ # The name of the field in the string condition.
8756
+ # @return [String]
8757
+ #
8758
+ # @!attribute [rw] value
8759
+ # The value of the string.
8760
+ # @return [String]
8761
+ #
8762
+ # @!attribute [rw] comparison_type
8763
+ # The type of comparison to be made when evaluating the string
8764
+ # condition.
8765
+ # @return [String]
8766
+ #
8767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StringCondition AWS API Documentation
8768
+ #
8769
+ class StringCondition < Struct.new(
8770
+ :field_name,
8771
+ :value,
8772
+ :comparison_type)
8773
+ SENSITIVE = []
8774
+ include Aws::Structure
8775
+ end
8776
+
8068
8777
  # @note When making an API call, you may pass SuspendContactRecordingRequest
8069
8778
  # data as a hash:
8070
8779
  #
@@ -8102,6 +8811,34 @@ module Aws::Connect
8102
8811
  #
8103
8812
  class SuspendContactRecordingResponse < Aws::EmptyStructure; end
8104
8813
 
8814
+ # A leaf node condition which can be used to specify a tag condition,
8815
+ # for example, `HAVE BPO = 123`.
8816
+ #
8817
+ # @note When making an API call, you may pass TagCondition
8818
+ # data as a hash:
8819
+ #
8820
+ # {
8821
+ # tag_key: "String",
8822
+ # tag_value: "String",
8823
+ # }
8824
+ #
8825
+ # @!attribute [rw] tag_key
8826
+ # The tag key in the tag condition.
8827
+ # @return [String]
8828
+ #
8829
+ # @!attribute [rw] tag_value
8830
+ # The tag value in the tag condition.
8831
+ # @return [String]
8832
+ #
8833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagCondition AWS API Documentation
8834
+ #
8835
+ class TagCondition < Struct.new(
8836
+ :tag_key,
8837
+ :tag_value)
8838
+ SENSITIVE = []
8839
+ include Aws::Structure
8840
+ end
8841
+
8105
8842
  # @note When making an API call, you may pass TagResourceRequest
8106
8843
  # data as a hash:
8107
8844
  #
@@ -8658,7 +9395,7 @@ module Aws::Connect
8658
9395
  #
8659
9396
  # {
8660
9397
  # instance_id: "InstanceId", # required
8661
- # attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
9398
+ # attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE
8662
9399
  # value: "InstanceAttributeValue", # required
8663
9400
  # }
8664
9401
  #
@@ -8755,6 +9492,59 @@ module Aws::Connect
8755
9492
  include Aws::Structure
8756
9493
  end
8757
9494
 
9495
+ # @note When making an API call, you may pass UpdatePhoneNumberRequest
9496
+ # data as a hash:
9497
+ #
9498
+ # {
9499
+ # phone_number_id: "PhoneNumberId", # required
9500
+ # target_arn: "ARN", # required
9501
+ # client_token: "ClientToken",
9502
+ # }
9503
+ #
9504
+ # @!attribute [rw] phone_number_id
9505
+ # A unique identifier for the phone number.
9506
+ # @return [String]
9507
+ #
9508
+ # @!attribute [rw] target_arn
9509
+ # The Amazon Resource Name (ARN) for Amazon Connect instances that
9510
+ # phone numbers are claimed to.
9511
+ # @return [String]
9512
+ #
9513
+ # @!attribute [rw] client_token
9514
+ # A unique, case-sensitive identifier that you provide to ensure the
9515
+ # idempotency of the request.
9516
+ #
9517
+ # **A suitable default value is auto-generated.** You should normally
9518
+ # not need to pass this option.
9519
+ # @return [String]
9520
+ #
9521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberRequest AWS API Documentation
9522
+ #
9523
+ class UpdatePhoneNumberRequest < Struct.new(
9524
+ :phone_number_id,
9525
+ :target_arn,
9526
+ :client_token)
9527
+ SENSITIVE = []
9528
+ include Aws::Structure
9529
+ end
9530
+
9531
+ # @!attribute [rw] phone_number_id
9532
+ # A unique identifier for the phone number.
9533
+ # @return [String]
9534
+ #
9535
+ # @!attribute [rw] phone_number_arn
9536
+ # The Amazon Resource Name (ARN) of the phone number.
9537
+ # @return [String]
9538
+ #
9539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberResponse AWS API Documentation
9540
+ #
9541
+ class UpdatePhoneNumberResponse < Struct.new(
9542
+ :phone_number_id,
9543
+ :phone_number_arn)
9544
+ SENSITIVE = []
9545
+ include Aws::Structure
9546
+ end
9547
+
8758
9548
  # @note When making an API call, you may pass UpdateQueueHoursOfOperationRequest
8759
9549
  # data as a hash:
8760
9550
  #
@@ -9586,6 +10376,25 @@ module Aws::Connect
9586
10376
  include Aws::Structure
9587
10377
  end
9588
10378
 
10379
+ # The user's first name and last name.
10380
+ #
10381
+ # @!attribute [rw] first_name
10382
+ # The user's first name.
10383
+ # @return [String]
10384
+ #
10385
+ # @!attribute [rw] last_name
10386
+ # The user's last name.
10387
+ # @return [String]
10388
+ #
10389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserIdentityInfoLite AWS API Documentation
10390
+ #
10391
+ class UserIdentityInfoLite < Struct.new(
10392
+ :first_name,
10393
+ :last_name)
10394
+ SENSITIVE = []
10395
+ include Aws::Structure
10396
+ end
10397
+
9589
10398
  # No user with the specified credentials was found in the Amazon Connect
9590
10399
  # instance.
9591
10400
  #
@@ -9668,6 +10477,201 @@ module Aws::Connect
9668
10477
  include Aws::Structure
9669
10478
  end
9670
10479
 
10480
+ # The search criteria to be used to return users.
10481
+ #
10482
+ # @note When making an API call, you may pass UserSearchCriteria
10483
+ # data as a hash:
10484
+ #
10485
+ # {
10486
+ # or_conditions: [
10487
+ # {
10488
+ # or_conditions: {
10489
+ # # recursive UserSearchConditionList
10490
+ # },
10491
+ # and_conditions: {
10492
+ # # recursive UserSearchConditionList
10493
+ # },
10494
+ # string_condition: {
10495
+ # field_name: "String",
10496
+ # value: "String",
10497
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
10498
+ # },
10499
+ # hierarchy_group_condition: {
10500
+ # value: "String",
10501
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
10502
+ # },
10503
+ # },
10504
+ # ],
10505
+ # and_conditions: [
10506
+ # {
10507
+ # or_conditions: {
10508
+ # # recursive UserSearchConditionList
10509
+ # },
10510
+ # and_conditions: {
10511
+ # # recursive UserSearchConditionList
10512
+ # },
10513
+ # string_condition: {
10514
+ # field_name: "String",
10515
+ # value: "String",
10516
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
10517
+ # },
10518
+ # hierarchy_group_condition: {
10519
+ # value: "String",
10520
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
10521
+ # },
10522
+ # },
10523
+ # ],
10524
+ # string_condition: {
10525
+ # field_name: "String",
10526
+ # value: "String",
10527
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
10528
+ # },
10529
+ # hierarchy_group_condition: {
10530
+ # value: "String",
10531
+ # hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
10532
+ # },
10533
+ # }
10534
+ #
10535
+ # @!attribute [rw] or_conditions
10536
+ # A list of conditions which would be applied together with an `OR`
10537
+ # condition.
10538
+ # @return [Array<Types::UserSearchCriteria>]
10539
+ #
10540
+ # @!attribute [rw] and_conditions
10541
+ # A list of conditions which would be applied together with an `AND`
10542
+ # condition.
10543
+ # @return [Array<Types::UserSearchCriteria>]
10544
+ #
10545
+ # @!attribute [rw] string_condition
10546
+ # A leaf node condition which can be used to specify a string
10547
+ # condition.
10548
+ # @return [Types::StringCondition]
10549
+ #
10550
+ # @!attribute [rw] hierarchy_group_condition
10551
+ # A leaf node condition which can be used to specify a hierarchy group
10552
+ # condition.
10553
+ # @return [Types::HierarchyGroupCondition]
10554
+ #
10555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchCriteria AWS API Documentation
10556
+ #
10557
+ class UserSearchCriteria < Struct.new(
10558
+ :or_conditions,
10559
+ :and_conditions,
10560
+ :string_condition,
10561
+ :hierarchy_group_condition)
10562
+ SENSITIVE = []
10563
+ include Aws::Structure
10564
+ end
10565
+
10566
+ # Filters to be applied to search results.
10567
+ #
10568
+ # @note When making an API call, you may pass UserSearchFilter
10569
+ # data as a hash:
10570
+ #
10571
+ # {
10572
+ # tag_filter: {
10573
+ # or_conditions: [
10574
+ # [
10575
+ # {
10576
+ # tag_key: "String",
10577
+ # tag_value: "String",
10578
+ # },
10579
+ # ],
10580
+ # ],
10581
+ # and_conditions: [
10582
+ # {
10583
+ # tag_key: "String",
10584
+ # tag_value: "String",
10585
+ # },
10586
+ # ],
10587
+ # tag_condition: {
10588
+ # tag_key: "String",
10589
+ # tag_value: "String",
10590
+ # },
10591
+ # },
10592
+ # }
10593
+ #
10594
+ # @!attribute [rw] tag_filter
10595
+ # An object that can be used to specify Tag conditions inside the
10596
+ # `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
10597
+ # where:
10598
+ #
10599
+ # * Top level list specifies conditions that need to be applied with
10600
+ # `OR` operator
10601
+ #
10602
+ # * Inner list specifies conditions that need to be applied with `AND`
10603
+ # operator.
10604
+ # @return [Types::ControlPlaneTagFilter]
10605
+ #
10606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchFilter AWS API Documentation
10607
+ #
10608
+ class UserSearchFilter < Struct.new(
10609
+ :tag_filter)
10610
+ SENSITIVE = []
10611
+ include Aws::Structure
10612
+ end
10613
+
10614
+ # Information about the returned users.
10615
+ #
10616
+ # @!attribute [rw] arn
10617
+ # The Amazon Resource Name (ARN) of the user.
10618
+ # @return [String]
10619
+ #
10620
+ # @!attribute [rw] directory_user_id
10621
+ # The directory identifier of the user.
10622
+ # @return [String]
10623
+ #
10624
+ # @!attribute [rw] hierarchy_group_id
10625
+ # The identifier of the user's hierarchy group.
10626
+ # @return [String]
10627
+ #
10628
+ # @!attribute [rw] id
10629
+ # The identifier of the user's summary.
10630
+ # @return [String]
10631
+ #
10632
+ # @!attribute [rw] identity_info
10633
+ # The user's first name and last name.
10634
+ # @return [Types::UserIdentityInfoLite]
10635
+ #
10636
+ # @!attribute [rw] phone_config
10637
+ # Contains information about the phone configuration settings for a
10638
+ # user.
10639
+ # @return [Types::UserPhoneConfig]
10640
+ #
10641
+ # @!attribute [rw] routing_profile_id
10642
+ # The identifier of the user's routing profile.
10643
+ # @return [String]
10644
+ #
10645
+ # @!attribute [rw] security_profile_ids
10646
+ # The identifiers of the user's security profiles.
10647
+ # @return [Array<String>]
10648
+ #
10649
+ # @!attribute [rw] tags
10650
+ # The tags used to organize, track, or control access for this
10651
+ # resource.
10652
+ # @return [Hash<String,String>]
10653
+ #
10654
+ # @!attribute [rw] username
10655
+ # The name of the user.
10656
+ # @return [String]
10657
+ #
10658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchSummary AWS API Documentation
10659
+ #
10660
+ class UserSearchSummary < Struct.new(
10661
+ :arn,
10662
+ :directory_user_id,
10663
+ :hierarchy_group_id,
10664
+ :id,
10665
+ :identity_info,
10666
+ :phone_config,
10667
+ :routing_profile_id,
10668
+ :security_profile_ids,
10669
+ :tags,
10670
+ :username)
10671
+ SENSITIVE = []
10672
+ include Aws::Structure
10673
+ end
10674
+
9671
10675
  # Contains summary information about a user.
9672
10676
  #
9673
10677
  # @!attribute [rw] id