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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 34db8560c57988395b035ef80e9ea5b56675b5a89d630d6840cfa79a5f23b449
|
4
|
+
data.tar.gz: 32378f74df465824fb66fc400ded1826bad6ebadb5bbacebbeb567044a3bbab8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 18f53eb7a3c632553a4a1a256d6072fc6ad9bd5086c68662f03788462cfda2ec5d7db7cea067b56c07be4dd2503d4589444624f7175f83d2a13cf82e71939e0b
|
7
|
+
data.tar.gz: 561baeeb267dfddda7833bf65b8b8a541f623111e668537fff808e5797f7ddf2c4fe517e61fafd723c409c4509d44da8cb98880d28d00b8e4b397437f9f10e14
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.71.0 (2022-04-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces an API for changing the current agent status of a user in Connect.
|
8
|
+
|
9
|
+
1.70.0 (2022-04-25)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds SearchUsers API which can be used to search for users with a Connect Instance
|
13
|
+
|
14
|
+
1.69.0 (2022-04-20)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds APIs to search, claim, release, list, update, and describe phone numbers. You can also use them to associate and disassociate contact flows to phone numbers.
|
18
|
+
|
4
19
|
1.68.0 (2022-04-01)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.71.0
|
@@ -600,6 +600,38 @@ module Aws::Connect
|
|
600
600
|
req.send_request(options)
|
601
601
|
end
|
602
602
|
|
603
|
+
# Associates a contact flow with a phone number claimed to your Amazon
|
604
|
+
# Connect instance.
|
605
|
+
#
|
606
|
+
# @option params [required, String] :phone_number_id
|
607
|
+
# A unique identifier for the phone number.
|
608
|
+
#
|
609
|
+
# @option params [required, String] :instance_id
|
610
|
+
# The identifier of the Amazon Connect instance. You can find the
|
611
|
+
# instanceId in the ARN of the instance.
|
612
|
+
#
|
613
|
+
# @option params [required, String] :contact_flow_id
|
614
|
+
# The identifier of the contact flow.
|
615
|
+
#
|
616
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
617
|
+
#
|
618
|
+
# @example Request syntax with placeholder values
|
619
|
+
#
|
620
|
+
# resp = client.associate_phone_number_contact_flow({
|
621
|
+
# phone_number_id: "PhoneNumberId", # required
|
622
|
+
# instance_id: "InstanceId", # required
|
623
|
+
# contact_flow_id: "ContactFlowId", # required
|
624
|
+
# })
|
625
|
+
#
|
626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociatePhoneNumberContactFlow AWS API Documentation
|
627
|
+
#
|
628
|
+
# @overload associate_phone_number_contact_flow(params = {})
|
629
|
+
# @param [Hash] params ({})
|
630
|
+
def associate_phone_number_contact_flow(params = {}, options = {})
|
631
|
+
req = build_request(:associate_phone_number_contact_flow, params)
|
632
|
+
req.send_request(options)
|
633
|
+
end
|
634
|
+
|
603
635
|
# This API is in preview release for Amazon Connect and is subject to
|
604
636
|
# change.
|
605
637
|
#
|
@@ -710,6 +742,60 @@ module Aws::Connect
|
|
710
742
|
req.send_request(options)
|
711
743
|
end
|
712
744
|
|
745
|
+
# Claims an available phone number to your Amazon Connect instance.
|
746
|
+
#
|
747
|
+
# @option params [required, String] :target_arn
|
748
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances that phone
|
749
|
+
# numbers are claimed to.
|
750
|
+
#
|
751
|
+
# @option params [required, String] :phone_number
|
752
|
+
# The phone number you want to claim. Phone numbers are formatted `[+]
|
753
|
+
# [country code] [subscriber number including area code]`.
|
754
|
+
#
|
755
|
+
# @option params [String] :phone_number_description
|
756
|
+
# The description of the phone number.
|
757
|
+
#
|
758
|
+
# @option params [Hash<String,String>] :tags
|
759
|
+
# The tags used to organize, track, or control access for this resource.
|
760
|
+
#
|
761
|
+
# @option params [String] :client_token
|
762
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
763
|
+
# idempotency of the request.
|
764
|
+
#
|
765
|
+
# **A suitable default value is auto-generated.** You should normally
|
766
|
+
# not need to pass this option.**
|
767
|
+
#
|
768
|
+
# @return [Types::ClaimPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
769
|
+
#
|
770
|
+
# * {Types::ClaimPhoneNumberResponse#phone_number_id #phone_number_id} => String
|
771
|
+
# * {Types::ClaimPhoneNumberResponse#phone_number_arn #phone_number_arn} => String
|
772
|
+
#
|
773
|
+
# @example Request syntax with placeholder values
|
774
|
+
#
|
775
|
+
# resp = client.claim_phone_number({
|
776
|
+
# target_arn: "ARN", # required
|
777
|
+
# phone_number: "PhoneNumber", # required
|
778
|
+
# phone_number_description: "PhoneNumberDescription",
|
779
|
+
# tags: {
|
780
|
+
# "TagKey" => "TagValue",
|
781
|
+
# },
|
782
|
+
# client_token: "ClientToken",
|
783
|
+
# })
|
784
|
+
#
|
785
|
+
# @example Response structure
|
786
|
+
#
|
787
|
+
# resp.phone_number_id #=> String
|
788
|
+
# resp.phone_number_arn #=> String
|
789
|
+
#
|
790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimPhoneNumber AWS API Documentation
|
791
|
+
#
|
792
|
+
# @overload claim_phone_number(params = {})
|
793
|
+
# @param [Hash] params ({})
|
794
|
+
def claim_phone_number(params = {}, options = {})
|
795
|
+
req = build_request(:claim_phone_number, params)
|
796
|
+
req.send_request(options)
|
797
|
+
end
|
798
|
+
|
713
799
|
# This API is in preview release for Amazon Connect and is subject to
|
714
800
|
# change.
|
715
801
|
#
|
@@ -2318,6 +2404,45 @@ module Aws::Connect
|
|
2318
2404
|
req.send_request(options)
|
2319
2405
|
end
|
2320
2406
|
|
2407
|
+
# Gets details and status of a phone number that’s claimed to your
|
2408
|
+
# Amazon Connect instance
|
2409
|
+
#
|
2410
|
+
# @option params [required, String] :phone_number_id
|
2411
|
+
# A unique identifier for the phone number.
|
2412
|
+
#
|
2413
|
+
# @return [Types::DescribePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2414
|
+
#
|
2415
|
+
# * {Types::DescribePhoneNumberResponse#claimed_phone_number_summary #claimed_phone_number_summary} => Types::ClaimedPhoneNumberSummary
|
2416
|
+
#
|
2417
|
+
# @example Request syntax with placeholder values
|
2418
|
+
#
|
2419
|
+
# resp = client.describe_phone_number({
|
2420
|
+
# phone_number_id: "PhoneNumberId", # required
|
2421
|
+
# })
|
2422
|
+
#
|
2423
|
+
# @example Response structure
|
2424
|
+
#
|
2425
|
+
# resp.claimed_phone_number_summary.phone_number_id #=> String
|
2426
|
+
# resp.claimed_phone_number_summary.phone_number_arn #=> String
|
2427
|
+
# resp.claimed_phone_number_summary.phone_number #=> String
|
2428
|
+
# resp.claimed_phone_number_summary.phone_number_country_code #=> String, one of "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"
|
2429
|
+
# resp.claimed_phone_number_summary.phone_number_type #=> String, one of "TOLL_FREE", "DID"
|
2430
|
+
# resp.claimed_phone_number_summary.phone_number_description #=> String
|
2431
|
+
# resp.claimed_phone_number_summary.target_arn #=> String
|
2432
|
+
# resp.claimed_phone_number_summary.tags #=> Hash
|
2433
|
+
# resp.claimed_phone_number_summary.tags["TagKey"] #=> String
|
2434
|
+
# resp.claimed_phone_number_summary.phone_number_status.status #=> String, one of "CLAIMED", "IN_PROGRESS", "FAILED"
|
2435
|
+
# resp.claimed_phone_number_summary.phone_number_status.message #=> String
|
2436
|
+
#
|
2437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumber AWS API Documentation
|
2438
|
+
#
|
2439
|
+
# @overload describe_phone_number(params = {})
|
2440
|
+
# @param [Hash] params ({})
|
2441
|
+
def describe_phone_number(params = {}, options = {})
|
2442
|
+
req = build_request(:describe_phone_number, params)
|
2443
|
+
req.send_request(options)
|
2444
|
+
end
|
2445
|
+
|
2321
2446
|
# This API is in preview release for Amazon Connect and is subject to
|
2322
2447
|
# change.
|
2323
2448
|
#
|
@@ -2858,6 +2983,34 @@ module Aws::Connect
|
|
2858
2983
|
req.send_request(options)
|
2859
2984
|
end
|
2860
2985
|
|
2986
|
+
# Removes the contact flow association from a phone number claimed to
|
2987
|
+
# your Amazon Connect instance, if a contact flow association exists.
|
2988
|
+
#
|
2989
|
+
# @option params [required, String] :phone_number_id
|
2990
|
+
# A unique identifier for the phone number.
|
2991
|
+
#
|
2992
|
+
# @option params [required, String] :instance_id
|
2993
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2994
|
+
# instanceId in the ARN of the instance.
|
2995
|
+
#
|
2996
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2997
|
+
#
|
2998
|
+
# @example Request syntax with placeholder values
|
2999
|
+
#
|
3000
|
+
# resp = client.disassociate_phone_number_contact_flow({
|
3001
|
+
# phone_number_id: "PhoneNumberId", # required
|
3002
|
+
# instance_id: "InstanceId", # required
|
3003
|
+
# })
|
3004
|
+
#
|
3005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociatePhoneNumberContactFlow AWS API Documentation
|
3006
|
+
#
|
3007
|
+
# @overload disassociate_phone_number_contact_flow(params = {})
|
3008
|
+
# @param [Hash] params ({})
|
3009
|
+
def disassociate_phone_number_contact_flow(params = {}, options = {})
|
3010
|
+
req = build_request(:disassociate_phone_number_contact_flow, params)
|
3011
|
+
req.send_request(options)
|
3012
|
+
end
|
3013
|
+
|
2861
3014
|
# This API is in preview release for Amazon Connect and is subject to
|
2862
3015
|
# change.
|
2863
3016
|
#
|
@@ -4353,6 +4506,78 @@ module Aws::Connect
|
|
4353
4506
|
req.send_request(options)
|
4354
4507
|
end
|
4355
4508
|
|
4509
|
+
# Lists phone numbers claimed to your Amazon Connect instance.
|
4510
|
+
#
|
4511
|
+
# For more information about phone numbers, see [Set Up Phone Numbers
|
4512
|
+
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
4513
|
+
# Guide*.
|
4514
|
+
#
|
4515
|
+
#
|
4516
|
+
#
|
4517
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
4518
|
+
#
|
4519
|
+
# @option params [String] :target_arn
|
4520
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances that phone
|
4521
|
+
# numbers are claimed to. If `TargetArn` input is not provided, this API
|
4522
|
+
# lists numbers claimed to all the Amazon Connect instances belonging to
|
4523
|
+
# your account.
|
4524
|
+
#
|
4525
|
+
# @option params [Integer] :max_results
|
4526
|
+
# The maximum number of results to return per page.
|
4527
|
+
#
|
4528
|
+
# @option params [String] :next_token
|
4529
|
+
# The token for the next set of results. Use the value returned in the
|
4530
|
+
# previous response in the next request to retrieve the next set of
|
4531
|
+
# results.
|
4532
|
+
#
|
4533
|
+
# @option params [Array<String>] :phone_number_country_codes
|
4534
|
+
# The ISO country code.
|
4535
|
+
#
|
4536
|
+
# @option params [Array<String>] :phone_number_types
|
4537
|
+
# The type of phone number.
|
4538
|
+
#
|
4539
|
+
# @option params [String] :phone_number_prefix
|
4540
|
+
# The prefix of the phone number. If provided, it must contain `+` as
|
4541
|
+
# part of the country code.
|
4542
|
+
#
|
4543
|
+
# @return [Types::ListPhoneNumbersV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4544
|
+
#
|
4545
|
+
# * {Types::ListPhoneNumbersV2Response#next_token #next_token} => String
|
4546
|
+
# * {Types::ListPhoneNumbersV2Response#list_phone_numbers_summary_list #list_phone_numbers_summary_list} => Array<Types::ListPhoneNumbersSummary>
|
4547
|
+
#
|
4548
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4549
|
+
#
|
4550
|
+
# @example Request syntax with placeholder values
|
4551
|
+
#
|
4552
|
+
# resp = client.list_phone_numbers_v2({
|
4553
|
+
# target_arn: "ARN",
|
4554
|
+
# max_results: 1,
|
4555
|
+
# next_token: "LargeNextToken",
|
4556
|
+
# 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
|
4557
|
+
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID
|
4558
|
+
# phone_number_prefix: "PhoneNumberPrefix",
|
4559
|
+
# })
|
4560
|
+
#
|
4561
|
+
# @example Response structure
|
4562
|
+
#
|
4563
|
+
# resp.next_token #=> String
|
4564
|
+
# resp.list_phone_numbers_summary_list #=> Array
|
4565
|
+
# resp.list_phone_numbers_summary_list[0].phone_number_id #=> String
|
4566
|
+
# resp.list_phone_numbers_summary_list[0].phone_number_arn #=> String
|
4567
|
+
# resp.list_phone_numbers_summary_list[0].phone_number #=> String
|
4568
|
+
# resp.list_phone_numbers_summary_list[0].phone_number_country_code #=> String, one of "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"
|
4569
|
+
# resp.list_phone_numbers_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID"
|
4570
|
+
# resp.list_phone_numbers_summary_list[0].target_arn #=> String
|
4571
|
+
#
|
4572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersV2 AWS API Documentation
|
4573
|
+
#
|
4574
|
+
# @overload list_phone_numbers_v2(params = {})
|
4575
|
+
# @param [Hash] params ({})
|
4576
|
+
def list_phone_numbers_v2(params = {}, options = {})
|
4577
|
+
req = build_request(:list_phone_numbers_v2, params)
|
4578
|
+
req.send_request(options)
|
4579
|
+
end
|
4580
|
+
|
4356
4581
|
# Provides information about the prompts for the specified Amazon
|
4357
4582
|
# Connect instance.
|
4358
4583
|
#
|
@@ -5023,6 +5248,78 @@ module Aws::Connect
|
|
5023
5248
|
req.send_request(options)
|
5024
5249
|
end
|
5025
5250
|
|
5251
|
+
# Changes the current status of a user or agent in Amazon Connect. If
|
5252
|
+
# the agent is currently handling a contact, this sets the agent's next
|
5253
|
+
# status.
|
5254
|
+
#
|
5255
|
+
# For more information, see [Agent status][1] and [Set your next
|
5256
|
+
# status][2] in the *Amazon Connect Administrator Guide*.
|
5257
|
+
#
|
5258
|
+
#
|
5259
|
+
#
|
5260
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html
|
5261
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html
|
5262
|
+
#
|
5263
|
+
# @option params [required, String] :user_id
|
5264
|
+
# The identifier of the user.
|
5265
|
+
#
|
5266
|
+
# @option params [required, String] :instance_id
|
5267
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5268
|
+
# instanceId in the ARN of the instance.
|
5269
|
+
#
|
5270
|
+
# @option params [required, String] :agent_status_id
|
5271
|
+
# The identifier of the agent status.
|
5272
|
+
#
|
5273
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5274
|
+
#
|
5275
|
+
# @example Request syntax with placeholder values
|
5276
|
+
#
|
5277
|
+
# resp = client.put_user_status({
|
5278
|
+
# user_id: "UserId", # required
|
5279
|
+
# instance_id: "InstanceId", # required
|
5280
|
+
# agent_status_id: "AgentStatusId", # required
|
5281
|
+
# })
|
5282
|
+
#
|
5283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatus AWS API Documentation
|
5284
|
+
#
|
5285
|
+
# @overload put_user_status(params = {})
|
5286
|
+
# @param [Hash] params ({})
|
5287
|
+
def put_user_status(params = {}, options = {})
|
5288
|
+
req = build_request(:put_user_status, params)
|
5289
|
+
req.send_request(options)
|
5290
|
+
end
|
5291
|
+
|
5292
|
+
# Releases a phone number previously claimed to an Amazon Connect
|
5293
|
+
# instance.
|
5294
|
+
#
|
5295
|
+
# @option params [required, String] :phone_number_id
|
5296
|
+
# A unique identifier for the phone number.
|
5297
|
+
#
|
5298
|
+
# @option params [String] :client_token
|
5299
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
5300
|
+
# idempotency of the request.
|
5301
|
+
#
|
5302
|
+
# **A suitable default value is auto-generated.** You should normally
|
5303
|
+
# not need to pass this option.**
|
5304
|
+
#
|
5305
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5306
|
+
#
|
5307
|
+
# @example Request syntax with placeholder values
|
5308
|
+
#
|
5309
|
+
# resp = client.release_phone_number({
|
5310
|
+
# phone_number_id: "PhoneNumberId", # required
|
5311
|
+
# client_token: "ClientToken",
|
5312
|
+
# })
|
5313
|
+
#
|
5314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReleasePhoneNumber AWS API Documentation
|
5315
|
+
#
|
5316
|
+
# @overload release_phone_number(params = {})
|
5317
|
+
# @param [Hash] params ({})
|
5318
|
+
def release_phone_number(params = {}, options = {})
|
5319
|
+
req = build_request(:release_phone_number, params)
|
5320
|
+
req.send_request(options)
|
5321
|
+
end
|
5322
|
+
|
5026
5323
|
# When a contact is being recorded, and the recording has been suspended
|
5027
5324
|
# using SuspendContactRecording, this API resumes recording the call.
|
5028
5325
|
#
|
@@ -5058,6 +5355,176 @@ module Aws::Connect
|
|
5058
5355
|
req.send_request(options)
|
5059
5356
|
end
|
5060
5357
|
|
5358
|
+
# Searches for available phone numbers that you can claim to your Amazon
|
5359
|
+
# Connect instance.
|
5360
|
+
#
|
5361
|
+
# @option params [required, String] :target_arn
|
5362
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances that phone
|
5363
|
+
# numbers are claimed to.
|
5364
|
+
#
|
5365
|
+
# @option params [required, String] :phone_number_country_code
|
5366
|
+
# The ISO country code.
|
5367
|
+
#
|
5368
|
+
# @option params [required, String] :phone_number_type
|
5369
|
+
# The type of phone number.
|
5370
|
+
#
|
5371
|
+
# @option params [String] :phone_number_prefix
|
5372
|
+
# The prefix of the phone number. If provided, it must contain `+` as
|
5373
|
+
# part of the country code.
|
5374
|
+
#
|
5375
|
+
# @option params [Integer] :max_results
|
5376
|
+
# The maximum number of results to return per page.
|
5377
|
+
#
|
5378
|
+
# @option params [String] :next_token
|
5379
|
+
# The token for the next set of results. Use the value returned in the
|
5380
|
+
# previous response in the next request to retrieve the next set of
|
5381
|
+
# results.
|
5382
|
+
#
|
5383
|
+
# @return [Types::SearchAvailablePhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5384
|
+
#
|
5385
|
+
# * {Types::SearchAvailablePhoneNumbersResponse#next_token #next_token} => String
|
5386
|
+
# * {Types::SearchAvailablePhoneNumbersResponse#available_numbers_list #available_numbers_list} => Array<Types::AvailableNumberSummary>
|
5387
|
+
#
|
5388
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5389
|
+
#
|
5390
|
+
# @example Request syntax with placeholder values
|
5391
|
+
#
|
5392
|
+
# resp = client.search_available_phone_numbers({
|
5393
|
+
# target_arn: "ARN", # required
|
5394
|
+
# 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
|
5395
|
+
# phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID
|
5396
|
+
# phone_number_prefix: "PhoneNumberPrefix",
|
5397
|
+
# max_results: 1,
|
5398
|
+
# next_token: "LargeNextToken",
|
5399
|
+
# })
|
5400
|
+
#
|
5401
|
+
# @example Response structure
|
5402
|
+
#
|
5403
|
+
# resp.next_token #=> String
|
5404
|
+
# resp.available_numbers_list #=> Array
|
5405
|
+
# resp.available_numbers_list[0].phone_number #=> String
|
5406
|
+
# resp.available_numbers_list[0].phone_number_country_code #=> String, one of "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"
|
5407
|
+
# resp.available_numbers_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID"
|
5408
|
+
#
|
5409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbers AWS API Documentation
|
5410
|
+
#
|
5411
|
+
# @overload search_available_phone_numbers(params = {})
|
5412
|
+
# @param [Hash] params ({})
|
5413
|
+
def search_available_phone_numbers(params = {}, options = {})
|
5414
|
+
req = build_request(:search_available_phone_numbers, params)
|
5415
|
+
req.send_request(options)
|
5416
|
+
end
|
5417
|
+
|
5418
|
+
# Searches users in an Amazon Connect instance, with optional filtering.
|
5419
|
+
#
|
5420
|
+
# @option params [String] :instance_id
|
5421
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5422
|
+
# instanceId in the ARN of the instance.
|
5423
|
+
#
|
5424
|
+
# @option params [String] :next_token
|
5425
|
+
# The token for the next set of results. Use the value returned in the
|
5426
|
+
# previous response in the next request to retrieve the next set of
|
5427
|
+
# results.
|
5428
|
+
#
|
5429
|
+
# @option params [Integer] :max_results
|
5430
|
+
# The maximum number of results to return per page.
|
5431
|
+
#
|
5432
|
+
# @option params [Types::UserSearchFilter] :search_filter
|
5433
|
+
# Filters to be applied to search results.
|
5434
|
+
#
|
5435
|
+
# @option params [Types::UserSearchCriteria] :search_criteria
|
5436
|
+
# The search criteria to be used to return users.
|
5437
|
+
#
|
5438
|
+
# @return [Types::SearchUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5439
|
+
#
|
5440
|
+
# * {Types::SearchUsersResponse#users #users} => Array<Types::UserSearchSummary>
|
5441
|
+
# * {Types::SearchUsersResponse#next_token #next_token} => String
|
5442
|
+
# * {Types::SearchUsersResponse#approximate_total_count #approximate_total_count} => Integer
|
5443
|
+
#
|
5444
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5445
|
+
#
|
5446
|
+
# @example Request syntax with placeholder values
|
5447
|
+
#
|
5448
|
+
# resp = client.search_users({
|
5449
|
+
# instance_id: "InstanceId",
|
5450
|
+
# next_token: "NextToken2500",
|
5451
|
+
# max_results: 1,
|
5452
|
+
# search_filter: {
|
5453
|
+
# tag_filter: {
|
5454
|
+
# or_conditions: [
|
5455
|
+
# [
|
5456
|
+
# {
|
5457
|
+
# tag_key: "String",
|
5458
|
+
# tag_value: "String",
|
5459
|
+
# },
|
5460
|
+
# ],
|
5461
|
+
# ],
|
5462
|
+
# and_conditions: [
|
5463
|
+
# {
|
5464
|
+
# tag_key: "String",
|
5465
|
+
# tag_value: "String",
|
5466
|
+
# },
|
5467
|
+
# ],
|
5468
|
+
# tag_condition: {
|
5469
|
+
# tag_key: "String",
|
5470
|
+
# tag_value: "String",
|
5471
|
+
# },
|
5472
|
+
# },
|
5473
|
+
# },
|
5474
|
+
# search_criteria: {
|
5475
|
+
# or_conditions: [
|
5476
|
+
# {
|
5477
|
+
# # recursive UserSearchCriteria
|
5478
|
+
# },
|
5479
|
+
# ],
|
5480
|
+
# and_conditions: [
|
5481
|
+
# {
|
5482
|
+
# # recursive UserSearchCriteria
|
5483
|
+
# },
|
5484
|
+
# ],
|
5485
|
+
# string_condition: {
|
5486
|
+
# field_name: "String",
|
5487
|
+
# value: "String",
|
5488
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
5489
|
+
# },
|
5490
|
+
# hierarchy_group_condition: {
|
5491
|
+
# value: "String",
|
5492
|
+
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
5493
|
+
# },
|
5494
|
+
# },
|
5495
|
+
# })
|
5496
|
+
#
|
5497
|
+
# @example Response structure
|
5498
|
+
#
|
5499
|
+
# resp.users #=> Array
|
5500
|
+
# resp.users[0].arn #=> String
|
5501
|
+
# resp.users[0].directory_user_id #=> String
|
5502
|
+
# resp.users[0].hierarchy_group_id #=> String
|
5503
|
+
# resp.users[0].id #=> String
|
5504
|
+
# resp.users[0].identity_info.first_name #=> String
|
5505
|
+
# resp.users[0].identity_info.last_name #=> String
|
5506
|
+
# resp.users[0].phone_config.phone_type #=> String, one of "SOFT_PHONE", "DESK_PHONE"
|
5507
|
+
# resp.users[0].phone_config.auto_accept #=> Boolean
|
5508
|
+
# resp.users[0].phone_config.after_contact_work_time_limit #=> Integer
|
5509
|
+
# resp.users[0].phone_config.desk_phone_number #=> String
|
5510
|
+
# resp.users[0].routing_profile_id #=> String
|
5511
|
+
# resp.users[0].security_profile_ids #=> Array
|
5512
|
+
# resp.users[0].security_profile_ids[0] #=> String
|
5513
|
+
# resp.users[0].tags #=> Hash
|
5514
|
+
# resp.users[0].tags["TagKey"] #=> String
|
5515
|
+
# resp.users[0].username #=> String
|
5516
|
+
# resp.next_token #=> String
|
5517
|
+
# resp.approximate_total_count #=> Integer
|
5518
|
+
#
|
5519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUsers AWS API Documentation
|
5520
|
+
#
|
5521
|
+
# @overload search_users(params = {})
|
5522
|
+
# @param [Hash] params ({})
|
5523
|
+
def search_users(params = {}, options = {})
|
5524
|
+
req = build_request(:search_users, params)
|
5525
|
+
req.send_request(options)
|
5526
|
+
end
|
5527
|
+
|
5061
5528
|
# Searches for vocabularies within a specific Amazon Connect instance
|
5062
5529
|
# using `State`, `NameStartsWith`, and `LanguageCode`.
|
5063
5530
|
#
|
@@ -5733,7 +6200,8 @@ module Aws::Connect
|
|
5733
6200
|
# Adds the specified tags to the specified resource.
|
5734
6201
|
#
|
5735
6202
|
# The supported resource types are users, routing profiles, queues,
|
5736
|
-
# quick connects, contact flows, agent status,
|
6203
|
+
# quick connects, contact flows, agent status, hours of operation, and
|
6204
|
+
# phone number.
|
5737
6205
|
#
|
5738
6206
|
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
5739
6207
|
# Policy Examples][1] in the *Amazon Connect Administrator Guide*.
|
@@ -6358,6 +6826,50 @@ module Aws::Connect
|
|
6358
6826
|
req.send_request(options)
|
6359
6827
|
end
|
6360
6828
|
|
6829
|
+
# Updates your claimed phone number from its current Amazon Connect
|
6830
|
+
# instance to another Amazon Connect instance in the same Region.
|
6831
|
+
#
|
6832
|
+
# @option params [required, String] :phone_number_id
|
6833
|
+
# A unique identifier for the phone number.
|
6834
|
+
#
|
6835
|
+
# @option params [required, String] :target_arn
|
6836
|
+
# The Amazon Resource Name (ARN) for Amazon Connect instances that phone
|
6837
|
+
# numbers are claimed to.
|
6838
|
+
#
|
6839
|
+
# @option params [String] :client_token
|
6840
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
6841
|
+
# idempotency of the request.
|
6842
|
+
#
|
6843
|
+
# **A suitable default value is auto-generated.** You should normally
|
6844
|
+
# not need to pass this option.**
|
6845
|
+
#
|
6846
|
+
# @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6847
|
+
#
|
6848
|
+
# * {Types::UpdatePhoneNumberResponse#phone_number_id #phone_number_id} => String
|
6849
|
+
# * {Types::UpdatePhoneNumberResponse#phone_number_arn #phone_number_arn} => String
|
6850
|
+
#
|
6851
|
+
# @example Request syntax with placeholder values
|
6852
|
+
#
|
6853
|
+
# resp = client.update_phone_number({
|
6854
|
+
# phone_number_id: "PhoneNumberId", # required
|
6855
|
+
# target_arn: "ARN", # required
|
6856
|
+
# client_token: "ClientToken",
|
6857
|
+
# })
|
6858
|
+
#
|
6859
|
+
# @example Response structure
|
6860
|
+
#
|
6861
|
+
# resp.phone_number_id #=> String
|
6862
|
+
# resp.phone_number_arn #=> String
|
6863
|
+
#
|
6864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePhoneNumber AWS API Documentation
|
6865
|
+
#
|
6866
|
+
# @overload update_phone_number(params = {})
|
6867
|
+
# @param [Hash] params ({})
|
6868
|
+
def update_phone_number(params = {}, options = {})
|
6869
|
+
req = build_request(:update_phone_number, params)
|
6870
|
+
req.send_request(options)
|
6871
|
+
end
|
6872
|
+
|
6361
6873
|
# This API is in preview release for Amazon Connect and is subject to
|
6362
6874
|
# change.
|
6363
6875
|
#
|
@@ -7073,7 +7585,7 @@ module Aws::Connect
|
|
7073
7585
|
params: params,
|
7074
7586
|
config: config)
|
7075
7587
|
context[:gem_name] = 'aws-sdk-connect'
|
7076
|
-
context[:gem_version] = '1.
|
7588
|
+
context[:gem_version] = '1.71.0'
|
7077
7589
|
Seahorse::Client::Request.new(handlers, context)
|
7078
7590
|
end
|
7079
7591
|
|