aws-sdk-connect 1.68.0 → 1.71.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +514 -2
- data/lib/aws-sdk-connect/client_api.rb +362 -0
- data/lib/aws-sdk-connect/types.rb +1081 -41
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -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
|
#
|
@@ -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
|
-
#
|
5775
|
-
#
|
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]
|
5784
|
-
#
|
6105
|
+
# @!attribute [rw] phone_number_id
|
6106
|
+
# A unique identifier for the phone number.
|
5785
6107
|
# @return [String]
|
5786
6108
|
#
|
5787
|
-
# @!attribute [rw]
|
5788
|
-
# 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]
|
5794
|
-
# The
|
5795
|
-
#
|
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
|
-
#
|
6118
|
+
# @!attribute [rw] phone_number_country_code
|
6119
|
+
# The ISO country code.
|
6120
|
+
# @return [String]
|
5798
6121
|
#
|
5799
|
-
|
5800
|
-
|
5801
|
-
|
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]
|
5812
|
-
#
|
5813
|
-
#
|
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/
|
6131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersSummary AWS API Documentation
|
5817
6132
|
#
|
5818
|
-
class
|
5819
|
-
:
|
5820
|
-
:
|
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
|
6144
|
+
# @note When making an API call, you may pass ListPhoneNumbersV2Request
|
5826
6145
|
# data as a hash:
|
5827
6146
|
#
|
5828
6147
|
# {
|
5829
|
-
#
|
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]
|
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
|
#
|
@@ -6665,6 +7128,42 @@ module Aws::Connect
|
|
6665
7128
|
include Aws::Structure
|
6666
7129
|
end
|
6667
7130
|
|
7131
|
+
# @note When making an API call, you may pass PutUserStatusRequest
|
7132
|
+
# data as a hash:
|
7133
|
+
#
|
7134
|
+
# {
|
7135
|
+
# user_id: "UserId", # required
|
7136
|
+
# instance_id: "InstanceId", # required
|
7137
|
+
# agent_status_id: "AgentStatusId", # required
|
7138
|
+
# }
|
7139
|
+
#
|
7140
|
+
# @!attribute [rw] user_id
|
7141
|
+
# The identifier of the user.
|
7142
|
+
# @return [String]
|
7143
|
+
#
|
7144
|
+
# @!attribute [rw] instance_id
|
7145
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7146
|
+
# instanceId in the ARN of the instance.
|
7147
|
+
# @return [String]
|
7148
|
+
#
|
7149
|
+
# @!attribute [rw] agent_status_id
|
7150
|
+
# The identifier of the agent status.
|
7151
|
+
# @return [String]
|
7152
|
+
#
|
7153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatusRequest AWS API Documentation
|
7154
|
+
#
|
7155
|
+
class PutUserStatusRequest < Struct.new(
|
7156
|
+
:user_id,
|
7157
|
+
:instance_id,
|
7158
|
+
:agent_status_id)
|
7159
|
+
SENSITIVE = []
|
7160
|
+
include Aws::Structure
|
7161
|
+
end
|
7162
|
+
|
7163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatusResponse AWS API Documentation
|
7164
|
+
#
|
7165
|
+
class PutUserStatusResponse < Aws::EmptyStructure; end
|
7166
|
+
|
6668
7167
|
# Contains information about a queue.
|
6669
7168
|
#
|
6670
7169
|
# @!attribute [rw] name
|
@@ -7004,6 +7503,35 @@ module Aws::Connect
|
|
7004
7503
|
class Unknown < ReferenceSummary; end
|
7005
7504
|
end
|
7006
7505
|
|
7506
|
+
# @note When making an API call, you may pass ReleasePhoneNumberRequest
|
7507
|
+
# data as a hash:
|
7508
|
+
#
|
7509
|
+
# {
|
7510
|
+
# phone_number_id: "PhoneNumberId", # required
|
7511
|
+
# client_token: "ClientToken",
|
7512
|
+
# }
|
7513
|
+
#
|
7514
|
+
# @!attribute [rw] phone_number_id
|
7515
|
+
# A unique identifier for the phone number.
|
7516
|
+
# @return [String]
|
7517
|
+
#
|
7518
|
+
# @!attribute [rw] client_token
|
7519
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
7520
|
+
# idempotency of the request.
|
7521
|
+
#
|
7522
|
+
# **A suitable default value is auto-generated.** You should normally
|
7523
|
+
# not need to pass this option.
|
7524
|
+
# @return [String]
|
7525
|
+
#
|
7526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReleasePhoneNumberRequest AWS API Documentation
|
7527
|
+
#
|
7528
|
+
class ReleasePhoneNumberRequest < Struct.new(
|
7529
|
+
:phone_number_id,
|
7530
|
+
:client_token)
|
7531
|
+
SENSITIVE = []
|
7532
|
+
include Aws::Structure
|
7533
|
+
end
|
7534
|
+
|
7007
7535
|
# A resource already has that name.
|
7008
7536
|
#
|
7009
7537
|
# @!attribute [rw] message
|
@@ -7331,6 +7859,188 @@ module Aws::Connect
|
|
7331
7859
|
include Aws::Structure
|
7332
7860
|
end
|
7333
7861
|
|
7862
|
+
# @note When making an API call, you may pass SearchAvailablePhoneNumbersRequest
|
7863
|
+
# data as a hash:
|
7864
|
+
#
|
7865
|
+
# {
|
7866
|
+
# target_arn: "ARN", # required
|
7867
|
+
# 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
|
7868
|
+
# phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID
|
7869
|
+
# phone_number_prefix: "PhoneNumberPrefix",
|
7870
|
+
# max_results: 1,
|
7871
|
+
# next_token: "LargeNextToken",
|
7872
|
+
# }
|
7873
|
+
#
|
7874
|
+
# @!attribute [rw] target_arn
|
7875
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances that
|
7876
|
+
# phone numbers are claimed to.
|
7877
|
+
# @return [String]
|
7878
|
+
#
|
7879
|
+
# @!attribute [rw] phone_number_country_code
|
7880
|
+
# The ISO country code.
|
7881
|
+
# @return [String]
|
7882
|
+
#
|
7883
|
+
# @!attribute [rw] phone_number_type
|
7884
|
+
# The type of phone number.
|
7885
|
+
# @return [String]
|
7886
|
+
#
|
7887
|
+
# @!attribute [rw] phone_number_prefix
|
7888
|
+
# The prefix of the phone number. If provided, it must contain `+` as
|
7889
|
+
# part of the country code.
|
7890
|
+
# @return [String]
|
7891
|
+
#
|
7892
|
+
# @!attribute [rw] max_results
|
7893
|
+
# The maximum number of results to return per page.
|
7894
|
+
# @return [Integer]
|
7895
|
+
#
|
7896
|
+
# @!attribute [rw] next_token
|
7897
|
+
# The token for the next set of results. Use the value returned in the
|
7898
|
+
# previous response in the next request to retrieve the next set of
|
7899
|
+
# results.
|
7900
|
+
# @return [String]
|
7901
|
+
#
|
7902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbersRequest AWS API Documentation
|
7903
|
+
#
|
7904
|
+
class SearchAvailablePhoneNumbersRequest < Struct.new(
|
7905
|
+
:target_arn,
|
7906
|
+
:phone_number_country_code,
|
7907
|
+
:phone_number_type,
|
7908
|
+
:phone_number_prefix,
|
7909
|
+
:max_results,
|
7910
|
+
:next_token)
|
7911
|
+
SENSITIVE = []
|
7912
|
+
include Aws::Structure
|
7913
|
+
end
|
7914
|
+
|
7915
|
+
# @!attribute [rw] next_token
|
7916
|
+
# If there are additional results, this is the token for the next set
|
7917
|
+
# of results.
|
7918
|
+
# @return [String]
|
7919
|
+
#
|
7920
|
+
# @!attribute [rw] available_numbers_list
|
7921
|
+
# A list of available phone numbers that you can claim for your Amazon
|
7922
|
+
# Connect instance.
|
7923
|
+
# @return [Array<Types::AvailableNumberSummary>]
|
7924
|
+
#
|
7925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbersResponse AWS API Documentation
|
7926
|
+
#
|
7927
|
+
class SearchAvailablePhoneNumbersResponse < Struct.new(
|
7928
|
+
:next_token,
|
7929
|
+
:available_numbers_list)
|
7930
|
+
SENSITIVE = []
|
7931
|
+
include Aws::Structure
|
7932
|
+
end
|
7933
|
+
|
7934
|
+
# @note When making an API call, you may pass SearchUsersRequest
|
7935
|
+
# data as a hash:
|
7936
|
+
#
|
7937
|
+
# {
|
7938
|
+
# instance_id: "InstanceId",
|
7939
|
+
# next_token: "NextToken2500",
|
7940
|
+
# max_results: 1,
|
7941
|
+
# search_filter: {
|
7942
|
+
# tag_filter: {
|
7943
|
+
# or_conditions: [
|
7944
|
+
# [
|
7945
|
+
# {
|
7946
|
+
# tag_key: "String",
|
7947
|
+
# tag_value: "String",
|
7948
|
+
# },
|
7949
|
+
# ],
|
7950
|
+
# ],
|
7951
|
+
# and_conditions: [
|
7952
|
+
# {
|
7953
|
+
# tag_key: "String",
|
7954
|
+
# tag_value: "String",
|
7955
|
+
# },
|
7956
|
+
# ],
|
7957
|
+
# tag_condition: {
|
7958
|
+
# tag_key: "String",
|
7959
|
+
# tag_value: "String",
|
7960
|
+
# },
|
7961
|
+
# },
|
7962
|
+
# },
|
7963
|
+
# search_criteria: {
|
7964
|
+
# or_conditions: [
|
7965
|
+
# {
|
7966
|
+
# # recursive UserSearchCriteria
|
7967
|
+
# },
|
7968
|
+
# ],
|
7969
|
+
# and_conditions: [
|
7970
|
+
# {
|
7971
|
+
# # recursive UserSearchCriteria
|
7972
|
+
# },
|
7973
|
+
# ],
|
7974
|
+
# string_condition: {
|
7975
|
+
# field_name: "String",
|
7976
|
+
# value: "String",
|
7977
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
7978
|
+
# },
|
7979
|
+
# hierarchy_group_condition: {
|
7980
|
+
# value: "String",
|
7981
|
+
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
7982
|
+
# },
|
7983
|
+
# },
|
7984
|
+
# }
|
7985
|
+
#
|
7986
|
+
# @!attribute [rw] instance_id
|
7987
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7988
|
+
# instanceId in the ARN of the instance.
|
7989
|
+
# @return [String]
|
7990
|
+
#
|
7991
|
+
# @!attribute [rw] next_token
|
7992
|
+
# The token for the next set of results. Use the value returned in the
|
7993
|
+
# previous response in the next request to retrieve the next set of
|
7994
|
+
# results.
|
7995
|
+
# @return [String]
|
7996
|
+
#
|
7997
|
+
# @!attribute [rw] max_results
|
7998
|
+
# The maximum number of results to return per page.
|
7999
|
+
# @return [Integer]
|
8000
|
+
#
|
8001
|
+
# @!attribute [rw] search_filter
|
8002
|
+
# Filters to be applied to search results.
|
8003
|
+
# @return [Types::UserSearchFilter]
|
8004
|
+
#
|
8005
|
+
# @!attribute [rw] search_criteria
|
8006
|
+
# The search criteria to be used to return users.
|
8007
|
+
# @return [Types::UserSearchCriteria]
|
8008
|
+
#
|
8009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsersRequest AWS API Documentation
|
8010
|
+
#
|
8011
|
+
class SearchUsersRequest < Struct.new(
|
8012
|
+
:instance_id,
|
8013
|
+
:next_token,
|
8014
|
+
:max_results,
|
8015
|
+
:search_filter,
|
8016
|
+
:search_criteria)
|
8017
|
+
SENSITIVE = []
|
8018
|
+
include Aws::Structure
|
8019
|
+
end
|
8020
|
+
|
8021
|
+
# @!attribute [rw] users
|
8022
|
+
# Information about the users.
|
8023
|
+
# @return [Array<Types::UserSearchSummary>]
|
8024
|
+
#
|
8025
|
+
# @!attribute [rw] next_token
|
8026
|
+
# If there are additional results, this is the token for the next set
|
8027
|
+
# of results.
|
8028
|
+
# @return [String]
|
8029
|
+
#
|
8030
|
+
# @!attribute [rw] approximate_total_count
|
8031
|
+
# The total number of users who matched your search query.
|
8032
|
+
# @return [Integer]
|
8033
|
+
#
|
8034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsersResponse AWS API Documentation
|
8035
|
+
#
|
8036
|
+
class SearchUsersResponse < Struct.new(
|
8037
|
+
:users,
|
8038
|
+
:next_token,
|
8039
|
+
:approximate_total_count)
|
8040
|
+
SENSITIVE = []
|
8041
|
+
include Aws::Structure
|
8042
|
+
end
|
8043
|
+
|
7334
8044
|
# @note When making an API call, you may pass SearchVocabulariesRequest
|
7335
8045
|
# data as a hash:
|
7336
8046
|
#
|
@@ -8065,6 +8775,41 @@ module Aws::Connect
|
|
8065
8775
|
#
|
8066
8776
|
class StopContactStreamingResponse < Aws::EmptyStructure; end
|
8067
8777
|
|
8778
|
+
# A leaf node condition which can be used to specify a string condition,
|
8779
|
+
# for example, `username = 'abc'`.
|
8780
|
+
#
|
8781
|
+
# @note When making an API call, you may pass StringCondition
|
8782
|
+
# data as a hash:
|
8783
|
+
#
|
8784
|
+
# {
|
8785
|
+
# field_name: "String",
|
8786
|
+
# value: "String",
|
8787
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
8788
|
+
# }
|
8789
|
+
#
|
8790
|
+
# @!attribute [rw] field_name
|
8791
|
+
# The name of the field in the string condition.
|
8792
|
+
# @return [String]
|
8793
|
+
#
|
8794
|
+
# @!attribute [rw] value
|
8795
|
+
# The value of the string.
|
8796
|
+
# @return [String]
|
8797
|
+
#
|
8798
|
+
# @!attribute [rw] comparison_type
|
8799
|
+
# The type of comparison to be made when evaluating the string
|
8800
|
+
# condition.
|
8801
|
+
# @return [String]
|
8802
|
+
#
|
8803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StringCondition AWS API Documentation
|
8804
|
+
#
|
8805
|
+
class StringCondition < Struct.new(
|
8806
|
+
:field_name,
|
8807
|
+
:value,
|
8808
|
+
:comparison_type)
|
8809
|
+
SENSITIVE = []
|
8810
|
+
include Aws::Structure
|
8811
|
+
end
|
8812
|
+
|
8068
8813
|
# @note When making an API call, you may pass SuspendContactRecordingRequest
|
8069
8814
|
# data as a hash:
|
8070
8815
|
#
|
@@ -8102,6 +8847,34 @@ module Aws::Connect
|
|
8102
8847
|
#
|
8103
8848
|
class SuspendContactRecordingResponse < Aws::EmptyStructure; end
|
8104
8849
|
|
8850
|
+
# A leaf node condition which can be used to specify a tag condition,
|
8851
|
+
# for example, `HAVE BPO = 123`.
|
8852
|
+
#
|
8853
|
+
# @note When making an API call, you may pass TagCondition
|
8854
|
+
# data as a hash:
|
8855
|
+
#
|
8856
|
+
# {
|
8857
|
+
# tag_key: "String",
|
8858
|
+
# tag_value: "String",
|
8859
|
+
# }
|
8860
|
+
#
|
8861
|
+
# @!attribute [rw] tag_key
|
8862
|
+
# The tag key in the tag condition.
|
8863
|
+
# @return [String]
|
8864
|
+
#
|
8865
|
+
# @!attribute [rw] tag_value
|
8866
|
+
# The tag value in the tag condition.
|
8867
|
+
# @return [String]
|
8868
|
+
#
|
8869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagCondition AWS API Documentation
|
8870
|
+
#
|
8871
|
+
class TagCondition < Struct.new(
|
8872
|
+
:tag_key,
|
8873
|
+
:tag_value)
|
8874
|
+
SENSITIVE = []
|
8875
|
+
include Aws::Structure
|
8876
|
+
end
|
8877
|
+
|
8105
8878
|
# @note When making an API call, you may pass TagResourceRequest
|
8106
8879
|
# data as a hash:
|
8107
8880
|
#
|
@@ -8755,6 +9528,59 @@ module Aws::Connect
|
|
8755
9528
|
include Aws::Structure
|
8756
9529
|
end
|
8757
9530
|
|
9531
|
+
# @note When making an API call, you may pass UpdatePhoneNumberRequest
|
9532
|
+
# data as a hash:
|
9533
|
+
#
|
9534
|
+
# {
|
9535
|
+
# phone_number_id: "PhoneNumberId", # required
|
9536
|
+
# target_arn: "ARN", # required
|
9537
|
+
# client_token: "ClientToken",
|
9538
|
+
# }
|
9539
|
+
#
|
9540
|
+
# @!attribute [rw] phone_number_id
|
9541
|
+
# A unique identifier for the phone number.
|
9542
|
+
# @return [String]
|
9543
|
+
#
|
9544
|
+
# @!attribute [rw] target_arn
|
9545
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances that
|
9546
|
+
# phone numbers are claimed to.
|
9547
|
+
# @return [String]
|
9548
|
+
#
|
9549
|
+
# @!attribute [rw] client_token
|
9550
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
9551
|
+
# idempotency of the request.
|
9552
|
+
#
|
9553
|
+
# **A suitable default value is auto-generated.** You should normally
|
9554
|
+
# not need to pass this option.
|
9555
|
+
# @return [String]
|
9556
|
+
#
|
9557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberRequest AWS API Documentation
|
9558
|
+
#
|
9559
|
+
class UpdatePhoneNumberRequest < Struct.new(
|
9560
|
+
:phone_number_id,
|
9561
|
+
:target_arn,
|
9562
|
+
:client_token)
|
9563
|
+
SENSITIVE = []
|
9564
|
+
include Aws::Structure
|
9565
|
+
end
|
9566
|
+
|
9567
|
+
# @!attribute [rw] phone_number_id
|
9568
|
+
# A unique identifier for the phone number.
|
9569
|
+
# @return [String]
|
9570
|
+
#
|
9571
|
+
# @!attribute [rw] phone_number_arn
|
9572
|
+
# The Amazon Resource Name (ARN) of the phone number.
|
9573
|
+
# @return [String]
|
9574
|
+
#
|
9575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumberResponse AWS API Documentation
|
9576
|
+
#
|
9577
|
+
class UpdatePhoneNumberResponse < Struct.new(
|
9578
|
+
:phone_number_id,
|
9579
|
+
:phone_number_arn)
|
9580
|
+
SENSITIVE = []
|
9581
|
+
include Aws::Structure
|
9582
|
+
end
|
9583
|
+
|
8758
9584
|
# @note When making an API call, you may pass UpdateQueueHoursOfOperationRequest
|
8759
9585
|
# data as a hash:
|
8760
9586
|
#
|
@@ -9586,6 +10412,25 @@ module Aws::Connect
|
|
9586
10412
|
include Aws::Structure
|
9587
10413
|
end
|
9588
10414
|
|
10415
|
+
# The user's first name and last name.
|
10416
|
+
#
|
10417
|
+
# @!attribute [rw] first_name
|
10418
|
+
# The user's first name.
|
10419
|
+
# @return [String]
|
10420
|
+
#
|
10421
|
+
# @!attribute [rw] last_name
|
10422
|
+
# The user's last name.
|
10423
|
+
# @return [String]
|
10424
|
+
#
|
10425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserIdentityInfoLite AWS API Documentation
|
10426
|
+
#
|
10427
|
+
class UserIdentityInfoLite < Struct.new(
|
10428
|
+
:first_name,
|
10429
|
+
:last_name)
|
10430
|
+
SENSITIVE = []
|
10431
|
+
include Aws::Structure
|
10432
|
+
end
|
10433
|
+
|
9589
10434
|
# No user with the specified credentials was found in the Amazon Connect
|
9590
10435
|
# instance.
|
9591
10436
|
#
|
@@ -9668,6 +10513,201 @@ module Aws::Connect
|
|
9668
10513
|
include Aws::Structure
|
9669
10514
|
end
|
9670
10515
|
|
10516
|
+
# The search criteria to be used to return users.
|
10517
|
+
#
|
10518
|
+
# @note When making an API call, you may pass UserSearchCriteria
|
10519
|
+
# data as a hash:
|
10520
|
+
#
|
10521
|
+
# {
|
10522
|
+
# or_conditions: [
|
10523
|
+
# {
|
10524
|
+
# or_conditions: {
|
10525
|
+
# # recursive UserSearchConditionList
|
10526
|
+
# },
|
10527
|
+
# and_conditions: {
|
10528
|
+
# # recursive UserSearchConditionList
|
10529
|
+
# },
|
10530
|
+
# string_condition: {
|
10531
|
+
# field_name: "String",
|
10532
|
+
# value: "String",
|
10533
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10534
|
+
# },
|
10535
|
+
# hierarchy_group_condition: {
|
10536
|
+
# value: "String",
|
10537
|
+
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
10538
|
+
# },
|
10539
|
+
# },
|
10540
|
+
# ],
|
10541
|
+
# and_conditions: [
|
10542
|
+
# {
|
10543
|
+
# or_conditions: {
|
10544
|
+
# # recursive UserSearchConditionList
|
10545
|
+
# },
|
10546
|
+
# and_conditions: {
|
10547
|
+
# # recursive UserSearchConditionList
|
10548
|
+
# },
|
10549
|
+
# string_condition: {
|
10550
|
+
# field_name: "String",
|
10551
|
+
# value: "String",
|
10552
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10553
|
+
# },
|
10554
|
+
# hierarchy_group_condition: {
|
10555
|
+
# value: "String",
|
10556
|
+
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
10557
|
+
# },
|
10558
|
+
# },
|
10559
|
+
# ],
|
10560
|
+
# string_condition: {
|
10561
|
+
# field_name: "String",
|
10562
|
+
# value: "String",
|
10563
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
10564
|
+
# },
|
10565
|
+
# hierarchy_group_condition: {
|
10566
|
+
# value: "String",
|
10567
|
+
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
10568
|
+
# },
|
10569
|
+
# }
|
10570
|
+
#
|
10571
|
+
# @!attribute [rw] or_conditions
|
10572
|
+
# A list of conditions which would be applied together with an `OR`
|
10573
|
+
# condition.
|
10574
|
+
# @return [Array<Types::UserSearchCriteria>]
|
10575
|
+
#
|
10576
|
+
# @!attribute [rw] and_conditions
|
10577
|
+
# A list of conditions which would be applied together with an `AND`
|
10578
|
+
# condition.
|
10579
|
+
# @return [Array<Types::UserSearchCriteria>]
|
10580
|
+
#
|
10581
|
+
# @!attribute [rw] string_condition
|
10582
|
+
# A leaf node condition which can be used to specify a string
|
10583
|
+
# condition.
|
10584
|
+
# @return [Types::StringCondition]
|
10585
|
+
#
|
10586
|
+
# @!attribute [rw] hierarchy_group_condition
|
10587
|
+
# A leaf node condition which can be used to specify a hierarchy group
|
10588
|
+
# condition.
|
10589
|
+
# @return [Types::HierarchyGroupCondition]
|
10590
|
+
#
|
10591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchCriteria AWS API Documentation
|
10592
|
+
#
|
10593
|
+
class UserSearchCriteria < Struct.new(
|
10594
|
+
:or_conditions,
|
10595
|
+
:and_conditions,
|
10596
|
+
:string_condition,
|
10597
|
+
:hierarchy_group_condition)
|
10598
|
+
SENSITIVE = []
|
10599
|
+
include Aws::Structure
|
10600
|
+
end
|
10601
|
+
|
10602
|
+
# Filters to be applied to search results.
|
10603
|
+
#
|
10604
|
+
# @note When making an API call, you may pass UserSearchFilter
|
10605
|
+
# data as a hash:
|
10606
|
+
#
|
10607
|
+
# {
|
10608
|
+
# tag_filter: {
|
10609
|
+
# or_conditions: [
|
10610
|
+
# [
|
10611
|
+
# {
|
10612
|
+
# tag_key: "String",
|
10613
|
+
# tag_value: "String",
|
10614
|
+
# },
|
10615
|
+
# ],
|
10616
|
+
# ],
|
10617
|
+
# and_conditions: [
|
10618
|
+
# {
|
10619
|
+
# tag_key: "String",
|
10620
|
+
# tag_value: "String",
|
10621
|
+
# },
|
10622
|
+
# ],
|
10623
|
+
# tag_condition: {
|
10624
|
+
# tag_key: "String",
|
10625
|
+
# tag_value: "String",
|
10626
|
+
# },
|
10627
|
+
# },
|
10628
|
+
# }
|
10629
|
+
#
|
10630
|
+
# @!attribute [rw] tag_filter
|
10631
|
+
# An object that can be used to specify Tag conditions inside the
|
10632
|
+
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
10633
|
+
# where:
|
10634
|
+
#
|
10635
|
+
# * Top level list specifies conditions that need to be applied with
|
10636
|
+
# `OR` operator
|
10637
|
+
#
|
10638
|
+
# * Inner list specifies conditions that need to be applied with `AND`
|
10639
|
+
# operator.
|
10640
|
+
# @return [Types::ControlPlaneTagFilter]
|
10641
|
+
#
|
10642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchFilter AWS API Documentation
|
10643
|
+
#
|
10644
|
+
class UserSearchFilter < Struct.new(
|
10645
|
+
:tag_filter)
|
10646
|
+
SENSITIVE = []
|
10647
|
+
include Aws::Structure
|
10648
|
+
end
|
10649
|
+
|
10650
|
+
# Information about the returned users.
|
10651
|
+
#
|
10652
|
+
# @!attribute [rw] arn
|
10653
|
+
# The Amazon Resource Name (ARN) of the user.
|
10654
|
+
# @return [String]
|
10655
|
+
#
|
10656
|
+
# @!attribute [rw] directory_user_id
|
10657
|
+
# The directory identifier of the user.
|
10658
|
+
# @return [String]
|
10659
|
+
#
|
10660
|
+
# @!attribute [rw] hierarchy_group_id
|
10661
|
+
# The identifier of the user's hierarchy group.
|
10662
|
+
# @return [String]
|
10663
|
+
#
|
10664
|
+
# @!attribute [rw] id
|
10665
|
+
# The identifier of the user's summary.
|
10666
|
+
# @return [String]
|
10667
|
+
#
|
10668
|
+
# @!attribute [rw] identity_info
|
10669
|
+
# The user's first name and last name.
|
10670
|
+
# @return [Types::UserIdentityInfoLite]
|
10671
|
+
#
|
10672
|
+
# @!attribute [rw] phone_config
|
10673
|
+
# Contains information about the phone configuration settings for a
|
10674
|
+
# user.
|
10675
|
+
# @return [Types::UserPhoneConfig]
|
10676
|
+
#
|
10677
|
+
# @!attribute [rw] routing_profile_id
|
10678
|
+
# The identifier of the user's routing profile.
|
10679
|
+
# @return [String]
|
10680
|
+
#
|
10681
|
+
# @!attribute [rw] security_profile_ids
|
10682
|
+
# The identifiers of the user's security profiles.
|
10683
|
+
# @return [Array<String>]
|
10684
|
+
#
|
10685
|
+
# @!attribute [rw] tags
|
10686
|
+
# The tags used to organize, track, or control access for this
|
10687
|
+
# resource.
|
10688
|
+
# @return [Hash<String,String>]
|
10689
|
+
#
|
10690
|
+
# @!attribute [rw] username
|
10691
|
+
# The name of the user.
|
10692
|
+
# @return [String]
|
10693
|
+
#
|
10694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserSearchSummary AWS API Documentation
|
10695
|
+
#
|
10696
|
+
class UserSearchSummary < Struct.new(
|
10697
|
+
:arn,
|
10698
|
+
:directory_user_id,
|
10699
|
+
:hierarchy_group_id,
|
10700
|
+
:id,
|
10701
|
+
:identity_info,
|
10702
|
+
:phone_config,
|
10703
|
+
:routing_profile_id,
|
10704
|
+
:security_profile_ids,
|
10705
|
+
:tags,
|
10706
|
+
:username)
|
10707
|
+
SENSITIVE = []
|
10708
|
+
include Aws::Structure
|
10709
|
+
end
|
10710
|
+
|
9671
10711
|
# Contains summary information about a user.
|
9672
10712
|
#
|
9673
10713
|
# @!attribute [rw] id
|