aws-sdk-connect 1.123.0 → 1.125.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +754 -53
- data/lib/aws-sdk-connect/client_api.rb +422 -0
- data/lib/aws-sdk-connect/endpoints.rb +168 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +24 -0
- data/lib/aws-sdk-connect/types.rb +842 -22
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -880,6 +880,45 @@ module Aws::Connect
|
|
880
880
|
req.send_request(options)
|
881
881
|
end
|
882
882
|
|
883
|
+
# Associates an agent with a traffic distribution group.
|
884
|
+
#
|
885
|
+
# @option params [required, String] :traffic_distribution_group_id
|
886
|
+
# The identifier of the traffic distribution group. This can be the ID
|
887
|
+
# or the ARN if the API is being called in the Region where the traffic
|
888
|
+
# distribution group was created. The ARN must be provided if the call
|
889
|
+
# is from the replicated Region.
|
890
|
+
#
|
891
|
+
# @option params [required, String] :user_id
|
892
|
+
# The identifier of the user account. This can be the ID or the ARN of
|
893
|
+
# the user.
|
894
|
+
#
|
895
|
+
# @option params [required, String] :instance_id
|
896
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
897
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
898
|
+
#
|
899
|
+
#
|
900
|
+
#
|
901
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
902
|
+
#
|
903
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
904
|
+
#
|
905
|
+
# @example Request syntax with placeholder values
|
906
|
+
#
|
907
|
+
# resp = client.associate_traffic_distribution_group_user({
|
908
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
909
|
+
# user_id: "UserId", # required
|
910
|
+
# instance_id: "InstanceId", # required
|
911
|
+
# })
|
912
|
+
#
|
913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateTrafficDistributionGroupUser AWS API Documentation
|
914
|
+
#
|
915
|
+
# @overload associate_traffic_distribution_group_user(params = {})
|
916
|
+
# @param [Hash] params ({})
|
917
|
+
def associate_traffic_distribution_group_user(params = {}, options = {})
|
918
|
+
req = build_request(:associate_traffic_distribution_group_user, params)
|
919
|
+
req.send_request(options)
|
920
|
+
end
|
921
|
+
|
883
922
|
# Claims an available phone number to your Amazon Connect instance or
|
884
923
|
# traffic distribution group. You can call this API only in the same
|
885
924
|
# Amazon Web Services Region where the Amazon Connect instance or
|
@@ -1663,28 +1702,32 @@ module Aws::Connect
|
|
1663
1702
|
#
|
1664
1703
|
# Creates a new queue for the specified Amazon Connect instance.
|
1665
1704
|
#
|
1666
|
-
# If the number
|
1667
|
-
#
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
#
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
# will receive a `ResourceNotFoundException`.
|
1705
|
+
# * If the phone number is claimed to a traffic distribution group that
|
1706
|
+
# was created in the same Region as the Amazon Connect instance where
|
1707
|
+
# you are calling this API, then you can use a full phone number ARN
|
1708
|
+
# or a UUID for `OutboundCallerIdNumberId`. However, if the phone
|
1709
|
+
# number is claimed to a traffic distribution group that is in one
|
1710
|
+
# Region, and you are calling this API from an instance in another
|
1711
|
+
# Amazon Web Services Region that is associated with the traffic
|
1712
|
+
# distribution group, you must provide a full phone number ARN. If a
|
1713
|
+
# UUID is provided in this scenario, you will receive a
|
1714
|
+
# `ResourceNotFoundException`.
|
1677
1715
|
#
|
1678
|
-
#
|
1679
|
-
# in the path, for example,
|
1680
|
-
#
|
1681
|
-
# same ARN format that is returned when you call the
|
1682
|
-
#
|
1716
|
+
# * Only use the phone number ARN format that doesn't contain
|
1717
|
+
# `instance` in the path, for example,
|
1718
|
+
# `arn:aws:connect:us-east-1:1234567890:phone-number/uuid`. This is
|
1719
|
+
# the same ARN format that is returned when you call the
|
1720
|
+
# [ListPhoneNumbersV2][1] API.
|
1683
1721
|
#
|
1722
|
+
# * If you plan to use IAM policies to allow/deny access to this API for
|
1723
|
+
# phone number resources claimed to a traffic distribution group, see
|
1724
|
+
# [Allow or Deny queue API actions for phone numbers in a replica
|
1725
|
+
# Region][2].
|
1684
1726
|
#
|
1685
1727
|
#
|
1686
|
-
#
|
1687
|
-
# [
|
1728
|
+
#
|
1729
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html
|
1730
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region
|
1688
1731
|
#
|
1689
1732
|
# @option params [required, String] :instance_id
|
1690
1733
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -1869,8 +1912,8 @@ module Aws::Connect
|
|
1869
1912
|
#
|
1870
1913
|
# @option params [String] :agent_availability_timer
|
1871
1914
|
# Whether agents with this routing profile will have their routing order
|
1872
|
-
# calculated based on *time since their last
|
1873
|
-
#
|
1915
|
+
# calculated based on *longest idle time* or *time since their last
|
1916
|
+
# inbound contact*.
|
1874
1917
|
#
|
1875
1918
|
# @return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1876
1919
|
#
|
@@ -2234,13 +2277,23 @@ module Aws::Connect
|
|
2234
2277
|
# Creates a traffic distribution group given an Amazon Connect instance
|
2235
2278
|
# that has been replicated.
|
2236
2279
|
#
|
2280
|
+
# <note markdown="1"> You can change the `SignInConfig` distribution only for a default
|
2281
|
+
# `TrafficDistributionGroup` (see the `IsDefault` parameter in the
|
2282
|
+
# [TrafficDistributionGroup][1] data type). If you call
|
2283
|
+
# `UpdateTrafficDistribution` with a modified `SignInConfig` and a
|
2284
|
+
# non-default `TrafficDistributionGroup`, an `InvalidRequestException`
|
2285
|
+
# is returned.
|
2286
|
+
#
|
2287
|
+
# </note>
|
2288
|
+
#
|
2237
2289
|
# For more information about creating traffic distribution groups, see
|
2238
|
-
# [Set up traffic distribution groups][
|
2290
|
+
# [Set up traffic distribution groups][2] in the *Amazon Connect
|
2239
2291
|
# Administrator Guide*.
|
2240
2292
|
#
|
2241
2293
|
#
|
2242
2294
|
#
|
2243
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
2295
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html
|
2296
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html
|
2244
2297
|
#
|
2245
2298
|
# @option params [required, String] :name
|
2246
2299
|
# The name for the traffic distribution group.
|
@@ -2515,6 +2568,161 @@ module Aws::Connect
|
|
2515
2568
|
req.send_request(options)
|
2516
2569
|
end
|
2517
2570
|
|
2571
|
+
# Creates a new view with the possible status of `SAVED` or `PUBLISHED`.
|
2572
|
+
#
|
2573
|
+
# The views will have a unique name for each connect instance.
|
2574
|
+
#
|
2575
|
+
# It performs basic content validation if the status is `SAVED` or full
|
2576
|
+
# content validation if the status is set to `PUBLISHED`. An error is
|
2577
|
+
# returned if validation fails. It associates either the `$SAVED`
|
2578
|
+
# qualifier or both of the `$SAVED` and `$LATEST` qualifiers with the
|
2579
|
+
# provided view content based on the status. The view is idempotent if
|
2580
|
+
# ClientToken is provided.
|
2581
|
+
#
|
2582
|
+
# @option params [required, String] :instance_id
|
2583
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2584
|
+
# instanceId in the ARN of the instance.
|
2585
|
+
#
|
2586
|
+
# @option params [String] :client_token
|
2587
|
+
# A unique Id for each create view request to avoid duplicate view
|
2588
|
+
# creation. For example, the view is idempotent ClientToken is provided.
|
2589
|
+
#
|
2590
|
+
# @option params [required, String] :status
|
2591
|
+
# Indicates the view status as either `SAVED` or `PUBLISHED`. The
|
2592
|
+
# `PUBLISHED` status will initiate validation on the content.
|
2593
|
+
#
|
2594
|
+
# @option params [required, Types::ViewInputContent] :content
|
2595
|
+
# View content containing all content necessary to render a view except
|
2596
|
+
# for runtime input data.
|
2597
|
+
#
|
2598
|
+
# The total uncompressed content has a maximum file size of 400kB.
|
2599
|
+
#
|
2600
|
+
# @option params [String] :description
|
2601
|
+
# The description of the view.
|
2602
|
+
#
|
2603
|
+
# @option params [required, String] :name
|
2604
|
+
# The name of the view.
|
2605
|
+
#
|
2606
|
+
# @option params [Hash<String,String>] :tags
|
2607
|
+
# The tags associated with the view resource (not specific to view
|
2608
|
+
# version).These tags can be used to organize, track, or control access
|
2609
|
+
# for this resource. For example, \\\{ "tags":
|
2610
|
+
# \\\{"key1":"value1", "key2":"value2"\\} \\}.
|
2611
|
+
#
|
2612
|
+
# @return [Types::CreateViewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2613
|
+
#
|
2614
|
+
# * {Types::CreateViewResponse#view #view} => Types::View
|
2615
|
+
#
|
2616
|
+
# @example Request syntax with placeholder values
|
2617
|
+
#
|
2618
|
+
# resp = client.create_view({
|
2619
|
+
# instance_id: "ViewsInstanceId", # required
|
2620
|
+
# client_token: "ViewsClientToken",
|
2621
|
+
# status: "PUBLISHED", # required, accepts PUBLISHED, SAVED
|
2622
|
+
# content: { # required
|
2623
|
+
# template: "ViewTemplate",
|
2624
|
+
# actions: ["ViewAction"],
|
2625
|
+
# },
|
2626
|
+
# description: "ViewDescription",
|
2627
|
+
# name: "ViewName", # required
|
2628
|
+
# tags: {
|
2629
|
+
# "TagKey" => "TagValue",
|
2630
|
+
# },
|
2631
|
+
# })
|
2632
|
+
#
|
2633
|
+
# @example Response structure
|
2634
|
+
#
|
2635
|
+
# resp.view.id #=> String
|
2636
|
+
# resp.view.arn #=> String
|
2637
|
+
# resp.view.name #=> String
|
2638
|
+
# resp.view.status #=> String, one of "PUBLISHED", "SAVED"
|
2639
|
+
# resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
2640
|
+
# resp.view.description #=> String
|
2641
|
+
# resp.view.version #=> Integer
|
2642
|
+
# resp.view.version_description #=> String
|
2643
|
+
# resp.view.content.input_schema #=> String
|
2644
|
+
# resp.view.content.template #=> String
|
2645
|
+
# resp.view.content.actions #=> Array
|
2646
|
+
# resp.view.content.actions[0] #=> String
|
2647
|
+
# resp.view.tags #=> Hash
|
2648
|
+
# resp.view.tags["TagKey"] #=> String
|
2649
|
+
# resp.view.created_time #=> Time
|
2650
|
+
# resp.view.last_modified_time #=> Time
|
2651
|
+
# resp.view.view_content_sha_256 #=> String
|
2652
|
+
#
|
2653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateView AWS API Documentation
|
2654
|
+
#
|
2655
|
+
# @overload create_view(params = {})
|
2656
|
+
# @param [Hash] params ({})
|
2657
|
+
def create_view(params = {}, options = {})
|
2658
|
+
req = build_request(:create_view, params)
|
2659
|
+
req.send_request(options)
|
2660
|
+
end
|
2661
|
+
|
2662
|
+
# Publishes a new version of the view identifier.
|
2663
|
+
#
|
2664
|
+
# Versions are immutable and monotonically increasing.
|
2665
|
+
#
|
2666
|
+
# It returns the highest version if there is no change in content
|
2667
|
+
# compared to that version. An error is displayed if the supplied
|
2668
|
+
# ViewContentSha256 is different from the ViewContentSha256 of the
|
2669
|
+
# `$LATEST` alias.
|
2670
|
+
#
|
2671
|
+
# @option params [required, String] :instance_id
|
2672
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2673
|
+
# instanceId in the ARN of the instance.
|
2674
|
+
#
|
2675
|
+
# @option params [required, String] :view_id
|
2676
|
+
# The identifier of the view. Both `ViewArn` and `ViewId` can be used.
|
2677
|
+
#
|
2678
|
+
# @option params [String] :version_description
|
2679
|
+
# The description for the version being published.
|
2680
|
+
#
|
2681
|
+
# @option params [String] :view_content_sha_256
|
2682
|
+
# Indicates the checksum value of the latest published view content.
|
2683
|
+
#
|
2684
|
+
# @return [Types::CreateViewVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2685
|
+
#
|
2686
|
+
# * {Types::CreateViewVersionResponse#view #view} => Types::View
|
2687
|
+
#
|
2688
|
+
# @example Request syntax with placeholder values
|
2689
|
+
#
|
2690
|
+
# resp = client.create_view_version({
|
2691
|
+
# instance_id: "ViewsInstanceId", # required
|
2692
|
+
# view_id: "ViewId", # required
|
2693
|
+
# version_description: "ViewDescription",
|
2694
|
+
# view_content_sha_256: "ViewContentSha256",
|
2695
|
+
# })
|
2696
|
+
#
|
2697
|
+
# @example Response structure
|
2698
|
+
#
|
2699
|
+
# resp.view.id #=> String
|
2700
|
+
# resp.view.arn #=> String
|
2701
|
+
# resp.view.name #=> String
|
2702
|
+
# resp.view.status #=> String, one of "PUBLISHED", "SAVED"
|
2703
|
+
# resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
2704
|
+
# resp.view.description #=> String
|
2705
|
+
# resp.view.version #=> Integer
|
2706
|
+
# resp.view.version_description #=> String
|
2707
|
+
# resp.view.content.input_schema #=> String
|
2708
|
+
# resp.view.content.template #=> String
|
2709
|
+
# resp.view.content.actions #=> Array
|
2710
|
+
# resp.view.content.actions[0] #=> String
|
2711
|
+
# resp.view.tags #=> Hash
|
2712
|
+
# resp.view.tags["TagKey"] #=> String
|
2713
|
+
# resp.view.created_time #=> Time
|
2714
|
+
# resp.view.last_modified_time #=> Time
|
2715
|
+
# resp.view.view_content_sha_256 #=> String
|
2716
|
+
#
|
2717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateViewVersion AWS API Documentation
|
2718
|
+
#
|
2719
|
+
# @overload create_view_version(params = {})
|
2720
|
+
# @param [Hash] params ({})
|
2721
|
+
def create_view_version(params = {}, options = {})
|
2722
|
+
req = build_request(:create_view_version, params)
|
2723
|
+
req.send_request(options)
|
2724
|
+
end
|
2725
|
+
|
2518
2726
|
# Creates a custom vocabulary associated with your Amazon Connect
|
2519
2727
|
# instance. You can set a custom vocabulary to be your default
|
2520
2728
|
# vocabulary for a given language. Contact Lens for Amazon Connect uses
|
@@ -3252,6 +3460,65 @@ module Aws::Connect
|
|
3252
3460
|
req.send_request(options)
|
3253
3461
|
end
|
3254
3462
|
|
3463
|
+
# Deletes the view entirely. It deletes the view and all associated
|
3464
|
+
# qualifiers (versions and aliases).
|
3465
|
+
#
|
3466
|
+
# @option params [required, String] :instance_id
|
3467
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3468
|
+
# instanceId in the ARN of the instance.
|
3469
|
+
#
|
3470
|
+
# @option params [required, String] :view_id
|
3471
|
+
# The identifier of the view. Both `ViewArn` and `ViewId` can be used.
|
3472
|
+
#
|
3473
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3474
|
+
#
|
3475
|
+
# @example Request syntax with placeholder values
|
3476
|
+
#
|
3477
|
+
# resp = client.delete_view({
|
3478
|
+
# instance_id: "ViewsInstanceId", # required
|
3479
|
+
# view_id: "ViewId", # required
|
3480
|
+
# })
|
3481
|
+
#
|
3482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteView AWS API Documentation
|
3483
|
+
#
|
3484
|
+
# @overload delete_view(params = {})
|
3485
|
+
# @param [Hash] params ({})
|
3486
|
+
def delete_view(params = {}, options = {})
|
3487
|
+
req = build_request(:delete_view, params)
|
3488
|
+
req.send_request(options)
|
3489
|
+
end
|
3490
|
+
|
3491
|
+
# Deletes the particular version specified in `ViewVersion` identifier.
|
3492
|
+
#
|
3493
|
+
# @option params [required, String] :instance_id
|
3494
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3495
|
+
# instanceId in the ARN of the instance.
|
3496
|
+
#
|
3497
|
+
# @option params [required, String] :view_id
|
3498
|
+
# The identifier of the view. Both `ViewArn` and `ViewId` can be used.
|
3499
|
+
#
|
3500
|
+
# @option params [required, Integer] :view_version
|
3501
|
+
# The version number of the view.
|
3502
|
+
#
|
3503
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3504
|
+
#
|
3505
|
+
# @example Request syntax with placeholder values
|
3506
|
+
#
|
3507
|
+
# resp = client.delete_view_version({
|
3508
|
+
# instance_id: "ViewsInstanceId", # required
|
3509
|
+
# view_id: "ViewId", # required
|
3510
|
+
# view_version: 1, # required
|
3511
|
+
# })
|
3512
|
+
#
|
3513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteViewVersion AWS API Documentation
|
3514
|
+
#
|
3515
|
+
# @overload delete_view_version(params = {})
|
3516
|
+
# @param [Hash] params ({})
|
3517
|
+
def delete_view_version(params = {}, options = {})
|
3518
|
+
req = build_request(:delete_view_version, params)
|
3519
|
+
req.send_request(options)
|
3520
|
+
end
|
3521
|
+
|
3255
3522
|
# Deletes the vocabulary that has the given identifier.
|
3256
3523
|
#
|
3257
3524
|
# @option params [required, String] :instance_id
|
@@ -4272,6 +4539,7 @@ module Aws::Connect
|
|
4272
4539
|
# resp.traffic_distribution_group.status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
|
4273
4540
|
# resp.traffic_distribution_group.tags #=> Hash
|
4274
4541
|
# resp.traffic_distribution_group.tags["TagKey"] #=> String
|
4542
|
+
# resp.traffic_distribution_group.is_default #=> Boolean
|
4275
4543
|
#
|
4276
4544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeTrafficDistributionGroup AWS API Documentation
|
4277
4545
|
#
|
@@ -4449,6 +4717,68 @@ module Aws::Connect
|
|
4449
4717
|
req.send_request(options)
|
4450
4718
|
end
|
4451
4719
|
|
4720
|
+
# Retrieves the view for the specified Amazon Connect instance and view
|
4721
|
+
# identifier.
|
4722
|
+
#
|
4723
|
+
# The view identifier can be supplied as a ViewId or ARN.
|
4724
|
+
#
|
4725
|
+
# `$SAVED` needs to be supplied if a view is unpublished.
|
4726
|
+
#
|
4727
|
+
# The view identifier can contain an optional qualifier, for example,
|
4728
|
+
# `<view-id>:$SAVED`, which is either an actual version number or an
|
4729
|
+
# Amazon Connect managed qualifier `$SAVED | $LATEST`. If it is not
|
4730
|
+
# supplied, then `$LATEST` is assumed for customer managed views and an
|
4731
|
+
# error is returned if there is no published content available. Version
|
4732
|
+
# 1 is assumed for Amazon Web Services managed views.
|
4733
|
+
#
|
4734
|
+
# @option params [required, String] :instance_id
|
4735
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4736
|
+
# instanceId in the ARN of the instance.
|
4737
|
+
#
|
4738
|
+
# @option params [required, String] :view_id
|
4739
|
+
# The ViewId of the view. This must be an ARN for Amazon Web Services
|
4740
|
+
# managed views.
|
4741
|
+
#
|
4742
|
+
# @return [Types::DescribeViewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4743
|
+
#
|
4744
|
+
# * {Types::DescribeViewResponse#view #view} => Types::View
|
4745
|
+
#
|
4746
|
+
# @example Request syntax with placeholder values
|
4747
|
+
#
|
4748
|
+
# resp = client.describe_view({
|
4749
|
+
# instance_id: "ViewsInstanceId", # required
|
4750
|
+
# view_id: "ViewId", # required
|
4751
|
+
# })
|
4752
|
+
#
|
4753
|
+
# @example Response structure
|
4754
|
+
#
|
4755
|
+
# resp.view.id #=> String
|
4756
|
+
# resp.view.arn #=> String
|
4757
|
+
# resp.view.name #=> String
|
4758
|
+
# resp.view.status #=> String, one of "PUBLISHED", "SAVED"
|
4759
|
+
# resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
4760
|
+
# resp.view.description #=> String
|
4761
|
+
# resp.view.version #=> Integer
|
4762
|
+
# resp.view.version_description #=> String
|
4763
|
+
# resp.view.content.input_schema #=> String
|
4764
|
+
# resp.view.content.template #=> String
|
4765
|
+
# resp.view.content.actions #=> Array
|
4766
|
+
# resp.view.content.actions[0] #=> String
|
4767
|
+
# resp.view.tags #=> Hash
|
4768
|
+
# resp.view.tags["TagKey"] #=> String
|
4769
|
+
# resp.view.created_time #=> Time
|
4770
|
+
# resp.view.last_modified_time #=> Time
|
4771
|
+
# resp.view.view_content_sha_256 #=> String
|
4772
|
+
#
|
4773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeView AWS API Documentation
|
4774
|
+
#
|
4775
|
+
# @overload describe_view(params = {})
|
4776
|
+
# @param [Hash] params ({})
|
4777
|
+
def describe_view(params = {}, options = {})
|
4778
|
+
req = build_request(:describe_view, params)
|
4779
|
+
req.send_request(options)
|
4780
|
+
end
|
4781
|
+
|
4452
4782
|
# Describes the specified vocabulary.
|
4453
4783
|
#
|
4454
4784
|
# @option params [required, String] :instance_id
|
@@ -4845,6 +5175,45 @@ module Aws::Connect
|
|
4845
5175
|
req.send_request(options)
|
4846
5176
|
end
|
4847
5177
|
|
5178
|
+
# Disassociates an agent from a traffic distribution group.
|
5179
|
+
#
|
5180
|
+
# @option params [required, String] :traffic_distribution_group_id
|
5181
|
+
# The identifier of the traffic distribution group. This can be the ID
|
5182
|
+
# or the ARN if the API is being called in the Region where the traffic
|
5183
|
+
# distribution group was created. The ARN must be provided if the call
|
5184
|
+
# is from the replicated Region.
|
5185
|
+
#
|
5186
|
+
# @option params [required, String] :user_id
|
5187
|
+
# The identifier for the user. This can be the ID or the ARN of the
|
5188
|
+
# user.
|
5189
|
+
#
|
5190
|
+
# @option params [required, String] :instance_id
|
5191
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
5192
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
5193
|
+
#
|
5194
|
+
#
|
5195
|
+
#
|
5196
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
5197
|
+
#
|
5198
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5199
|
+
#
|
5200
|
+
# @example Request syntax with placeholder values
|
5201
|
+
#
|
5202
|
+
# resp = client.disassociate_traffic_distribution_group_user({
|
5203
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
5204
|
+
# user_id: "UserId", # required
|
5205
|
+
# instance_id: "InstanceId", # required
|
5206
|
+
# })
|
5207
|
+
#
|
5208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateTrafficDistributionGroupUser AWS API Documentation
|
5209
|
+
#
|
5210
|
+
# @overload disassociate_traffic_distribution_group_user(params = {})
|
5211
|
+
# @param [Hash] params ({})
|
5212
|
+
def disassociate_traffic_distribution_group_user(params = {}, options = {})
|
5213
|
+
req = build_request(:disassociate_traffic_distribution_group_user, params)
|
5214
|
+
req.send_request(options)
|
5215
|
+
end
|
5216
|
+
|
4848
5217
|
# Dismisses contacts from an agent’s CCP and returns the agent to an
|
4849
5218
|
# available state, which allows the agent to receive a new routed
|
4850
5219
|
# contact. Contacts can only be dismissed if they are in a `MISSED`,
|
@@ -6294,6 +6663,8 @@ module Aws::Connect
|
|
6294
6663
|
# * {Types::GetTrafficDistributionResponse#telephony_config #telephony_config} => Types::TelephonyConfig
|
6295
6664
|
# * {Types::GetTrafficDistributionResponse#id #id} => String
|
6296
6665
|
# * {Types::GetTrafficDistributionResponse#arn #arn} => String
|
6666
|
+
# * {Types::GetTrafficDistributionResponse#sign_in_config #sign_in_config} => Types::SignInConfig
|
6667
|
+
# * {Types::GetTrafficDistributionResponse#agent_config #agent_config} => Types::AgentConfig
|
6297
6668
|
#
|
6298
6669
|
# @example Request syntax with placeholder values
|
6299
6670
|
#
|
@@ -6308,6 +6679,12 @@ module Aws::Connect
|
|
6308
6679
|
# resp.telephony_config.distributions[0].percentage #=> Integer
|
6309
6680
|
# resp.id #=> String
|
6310
6681
|
# resp.arn #=> String
|
6682
|
+
# resp.sign_in_config.distributions #=> Array
|
6683
|
+
# resp.sign_in_config.distributions[0].region #=> String
|
6684
|
+
# resp.sign_in_config.distributions[0].enabled #=> Boolean
|
6685
|
+
# resp.agent_config.distributions #=> Array
|
6686
|
+
# resp.agent_config.distributions[0].region #=> String
|
6687
|
+
# resp.agent_config.distributions[0].percentage #=> Integer
|
6311
6688
|
#
|
6312
6689
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTrafficDistribution AWS API Documentation
|
6313
6690
|
#
|
@@ -7336,17 +7713,23 @@ module Aws::Connect
|
|
7336
7713
|
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
7337
7714
|
# Guide*.
|
7338
7715
|
#
|
7339
|
-
#
|
7340
|
-
#
|
7341
|
-
#
|
7342
|
-
#
|
7343
|
-
#
|
7716
|
+
# * We recommend using [ListPhoneNumbersV2][2] to return phone number
|
7717
|
+
# types. ListPhoneNumbers doesn't support number types `UIFN`,
|
7718
|
+
# `SHARED`, `THIRD_PARTY_TF`, and `THIRD_PARTY_DID`. While it returns
|
7719
|
+
# numbers of those types, it incorrectly lists them as `TOLL_FREE` or
|
7720
|
+
# `DID`.
|
7721
|
+
#
|
7722
|
+
# * The phone number `Arn` value that is returned from each of the items
|
7723
|
+
# in the [PhoneNumberSummaryList][3] cannot be used to tag phone
|
7724
|
+
# number resources. It will fail with a `ResourceNotFoundException`.
|
7725
|
+
# Instead, use the [ListPhoneNumbersV2][2] API. It returns the new
|
7726
|
+
# phone number ARN that can be used to tag phone number resources.
|
7344
7727
|
#
|
7345
7728
|
#
|
7346
7729
|
#
|
7347
7730
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
7348
|
-
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
7349
|
-
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
7731
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html
|
7732
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList
|
7350
7733
|
#
|
7351
7734
|
# @option params [required, String] :instance_id
|
7352
7735
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -7416,6 +7799,15 @@ module Aws::Connect
|
|
7416
7799
|
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
7417
7800
|
# Guide*.
|
7418
7801
|
#
|
7802
|
+
# <note markdown="1"> * When given an instance ARN, `ListPhoneNumbersV2` returns only the
|
7803
|
+
# phone numbers claimed to the instance.
|
7804
|
+
#
|
7805
|
+
# * When given a traffic distribution group ARN `ListPhoneNumbersV2`
|
7806
|
+
# returns only the phone numbers claimed to the traffic distribution
|
7807
|
+
# group.
|
7808
|
+
#
|
7809
|
+
# </note>
|
7810
|
+
#
|
7419
7811
|
#
|
7420
7812
|
#
|
7421
7813
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
@@ -8182,6 +8574,52 @@ module Aws::Connect
|
|
8182
8574
|
req.send_request(options)
|
8183
8575
|
end
|
8184
8576
|
|
8577
|
+
# Lists traffic distribution group users.
|
8578
|
+
#
|
8579
|
+
# @option params [required, String] :traffic_distribution_group_id
|
8580
|
+
# The identifier of the traffic distribution group. This can be the ID
|
8581
|
+
# or the ARN if the API is being called in the Region where the traffic
|
8582
|
+
# distribution group was created. The ARN must be provided if the call
|
8583
|
+
# is from the replicated Region.
|
8584
|
+
#
|
8585
|
+
# @option params [Integer] :max_results
|
8586
|
+
# The maximum number of results to return per page.
|
8587
|
+
#
|
8588
|
+
# @option params [String] :next_token
|
8589
|
+
# The token for the next set of results. Use the value returned in the
|
8590
|
+
# previous response in the next request to retrieve the next set of
|
8591
|
+
# results.
|
8592
|
+
#
|
8593
|
+
# @return [Types::ListTrafficDistributionGroupUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8594
|
+
#
|
8595
|
+
# * {Types::ListTrafficDistributionGroupUsersResponse#next_token #next_token} => String
|
8596
|
+
# * {Types::ListTrafficDistributionGroupUsersResponse#traffic_distribution_group_user_summary_list #traffic_distribution_group_user_summary_list} => Array<Types::TrafficDistributionGroupUserSummary>
|
8597
|
+
#
|
8598
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8599
|
+
#
|
8600
|
+
# @example Request syntax with placeholder values
|
8601
|
+
#
|
8602
|
+
# resp = client.list_traffic_distribution_group_users({
|
8603
|
+
# traffic_distribution_group_id: "TrafficDistributionGroupIdOrArn", # required
|
8604
|
+
# max_results: 1,
|
8605
|
+
# next_token: "NextToken",
|
8606
|
+
# })
|
8607
|
+
#
|
8608
|
+
# @example Response structure
|
8609
|
+
#
|
8610
|
+
# resp.next_token #=> String
|
8611
|
+
# resp.traffic_distribution_group_user_summary_list #=> Array
|
8612
|
+
# resp.traffic_distribution_group_user_summary_list[0].user_id #=> String
|
8613
|
+
#
|
8614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTrafficDistributionGroupUsers AWS API Documentation
|
8615
|
+
#
|
8616
|
+
# @overload list_traffic_distribution_group_users(params = {})
|
8617
|
+
# @param [Hash] params ({})
|
8618
|
+
def list_traffic_distribution_group_users(params = {}, options = {})
|
8619
|
+
req = build_request(:list_traffic_distribution_group_users, params)
|
8620
|
+
req.send_request(options)
|
8621
|
+
end
|
8622
|
+
|
8185
8623
|
# Lists traffic distribution groups.
|
8186
8624
|
#
|
8187
8625
|
# @option params [Integer] :max_results
|
@@ -8224,6 +8662,7 @@ module Aws::Connect
|
|
8224
8662
|
# resp.traffic_distribution_group_summary_list[0].name #=> String
|
8225
8663
|
# resp.traffic_distribution_group_summary_list[0].instance_arn #=> String
|
8226
8664
|
# resp.traffic_distribution_group_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "PENDING_DELETION", "DELETION_FAILED", "UPDATE_IN_PROGRESS"
|
8665
|
+
# resp.traffic_distribution_group_summary_list[0].is_default #=> Boolean
|
8227
8666
|
#
|
8228
8667
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTrafficDistributionGroups AWS API Documentation
|
8229
8668
|
#
|
@@ -8399,6 +8838,120 @@ module Aws::Connect
|
|
8399
8838
|
req.send_request(options)
|
8400
8839
|
end
|
8401
8840
|
|
8841
|
+
# Returns all the available versions for the specified Amazon Connect
|
8842
|
+
# instance and view identifier.
|
8843
|
+
#
|
8844
|
+
# Results will be sorted from highest to lowest.
|
8845
|
+
#
|
8846
|
+
# @option params [required, String] :instance_id
|
8847
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8848
|
+
# instanceId in the ARN of the instance.
|
8849
|
+
#
|
8850
|
+
# @option params [required, String] :view_id
|
8851
|
+
# The identifier of the view. Both `ViewArn` and `ViewId` can be used.
|
8852
|
+
#
|
8853
|
+
# @option params [String] :next_token
|
8854
|
+
# The token for the next set of results. Use the value returned in the
|
8855
|
+
# previous response in the next request to retrieve the next set of
|
8856
|
+
# results.
|
8857
|
+
#
|
8858
|
+
# @option params [Integer] :max_results
|
8859
|
+
# The maximum number of results to return per page. The default
|
8860
|
+
# MaxResult size is 100.
|
8861
|
+
#
|
8862
|
+
# @return [Types::ListViewVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8863
|
+
#
|
8864
|
+
# * {Types::ListViewVersionsResponse#view_version_summary_list #view_version_summary_list} => Array<Types::ViewVersionSummary>
|
8865
|
+
# * {Types::ListViewVersionsResponse#next_token #next_token} => String
|
8866
|
+
#
|
8867
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8868
|
+
#
|
8869
|
+
# @example Request syntax with placeholder values
|
8870
|
+
#
|
8871
|
+
# resp = client.list_view_versions({
|
8872
|
+
# instance_id: "ViewsInstanceId", # required
|
8873
|
+
# view_id: "ViewId", # required
|
8874
|
+
# next_token: "ViewsNextToken",
|
8875
|
+
# max_results: 1,
|
8876
|
+
# })
|
8877
|
+
#
|
8878
|
+
# @example Response structure
|
8879
|
+
#
|
8880
|
+
# resp.view_version_summary_list #=> Array
|
8881
|
+
# resp.view_version_summary_list[0].id #=> String
|
8882
|
+
# resp.view_version_summary_list[0].arn #=> String
|
8883
|
+
# resp.view_version_summary_list[0].description #=> String
|
8884
|
+
# resp.view_version_summary_list[0].name #=> String
|
8885
|
+
# resp.view_version_summary_list[0].type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
8886
|
+
# resp.view_version_summary_list[0].version #=> Integer
|
8887
|
+
# resp.view_version_summary_list[0].version_description #=> String
|
8888
|
+
# resp.next_token #=> String
|
8889
|
+
#
|
8890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListViewVersions AWS API Documentation
|
8891
|
+
#
|
8892
|
+
# @overload list_view_versions(params = {})
|
8893
|
+
# @param [Hash] params ({})
|
8894
|
+
def list_view_versions(params = {}, options = {})
|
8895
|
+
req = build_request(:list_view_versions, params)
|
8896
|
+
req.send_request(options)
|
8897
|
+
end
|
8898
|
+
|
8899
|
+
# Returns views in the given instance.
|
8900
|
+
#
|
8901
|
+
# Results are sorted primarily by type, and secondarily by name.
|
8902
|
+
#
|
8903
|
+
# @option params [required, String] :instance_id
|
8904
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8905
|
+
# instanceId in the ARN of the instance.
|
8906
|
+
#
|
8907
|
+
# @option params [String] :type
|
8908
|
+
# The type of the view.
|
8909
|
+
#
|
8910
|
+
# @option params [String] :next_token
|
8911
|
+
# The token for the next set of results. Use the value returned in the
|
8912
|
+
# previous response in the next request to retrieve the next set of
|
8913
|
+
# results.
|
8914
|
+
#
|
8915
|
+
# @option params [Integer] :max_results
|
8916
|
+
# The maximum number of results to return per page. The default
|
8917
|
+
# MaxResult size is 100.
|
8918
|
+
#
|
8919
|
+
# @return [Types::ListViewsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8920
|
+
#
|
8921
|
+
# * {Types::ListViewsResponse#views_summary_list #views_summary_list} => Array<Types::ViewSummary>
|
8922
|
+
# * {Types::ListViewsResponse#next_token #next_token} => String
|
8923
|
+
#
|
8924
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8925
|
+
#
|
8926
|
+
# @example Request syntax with placeholder values
|
8927
|
+
#
|
8928
|
+
# resp = client.list_views({
|
8929
|
+
# instance_id: "ViewsInstanceId", # required
|
8930
|
+
# type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, AWS_MANAGED
|
8931
|
+
# next_token: "ViewsNextToken",
|
8932
|
+
# max_results: 1,
|
8933
|
+
# })
|
8934
|
+
#
|
8935
|
+
# @example Response structure
|
8936
|
+
#
|
8937
|
+
# resp.views_summary_list #=> Array
|
8938
|
+
# resp.views_summary_list[0].id #=> String
|
8939
|
+
# resp.views_summary_list[0].arn #=> String
|
8940
|
+
# resp.views_summary_list[0].name #=> String
|
8941
|
+
# resp.views_summary_list[0].type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
8942
|
+
# resp.views_summary_list[0].status #=> String, one of "PUBLISHED", "SAVED"
|
8943
|
+
# resp.views_summary_list[0].description #=> String
|
8944
|
+
# resp.next_token #=> String
|
8945
|
+
#
|
8946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListViews AWS API Documentation
|
8947
|
+
#
|
8948
|
+
# @overload list_views(params = {})
|
8949
|
+
# @param [Hash] params ({})
|
8950
|
+
def list_views(params = {}, options = {})
|
8951
|
+
req = build_request(:list_views, params)
|
8952
|
+
req.send_request(options)
|
8953
|
+
end
|
8954
|
+
|
8402
8955
|
# Initiates silent monitoring of a contact. The Contact Control Panel
|
8403
8956
|
# (CCP) of the user specified by *userId* will be set to silent
|
8404
8957
|
# monitoring mode on the contact.
|
@@ -10283,8 +10836,8 @@ module Aws::Connect
|
|
10283
10836
|
req.send_request(options)
|
10284
10837
|
end
|
10285
10838
|
|
10286
|
-
# Ends the specified contact. This call does not work for
|
10287
|
-
# initiation methods:
|
10839
|
+
# Ends the specified contact. This call does not work for voice contacts
|
10840
|
+
# that use the following initiation methods:
|
10288
10841
|
#
|
10289
10842
|
# * DISCONNECT
|
10290
10843
|
#
|
@@ -10292,6 +10845,9 @@ module Aws::Connect
|
|
10292
10845
|
#
|
10293
10846
|
# * QUEUE\_TRANSFER
|
10294
10847
|
#
|
10848
|
+
# Chat and task contacts, however, can be terminated in any state,
|
10849
|
+
# regardless of initiation method.
|
10850
|
+
#
|
10295
10851
|
# @option params [required, String] :contact_id
|
10296
10852
|
# The ID of the contact.
|
10297
10853
|
#
|
@@ -10595,7 +11151,8 @@ module Aws::Connect
|
|
10595
11151
|
# The identifier for the queue.
|
10596
11152
|
#
|
10597
11153
|
# @option params [String] :user_id
|
10598
|
-
# The identifier for the user.
|
11154
|
+
# The identifier for the user. This can be the ID or the ARN of the
|
11155
|
+
# user.
|
10599
11156
|
#
|
10600
11157
|
# @option params [required, String] :contact_flow_id
|
10601
11158
|
# The identifier of the flow.
|
@@ -11786,28 +12343,32 @@ module Aws::Connect
|
|
11786
12343
|
# Updates the outbound caller ID name, number, and outbound whisper flow
|
11787
12344
|
# for a specified queue.
|
11788
12345
|
#
|
11789
|
-
# If the number
|
11790
|
-
#
|
11791
|
-
#
|
11792
|
-
#
|
11793
|
-
#
|
11794
|
-
#
|
11795
|
-
#
|
11796
|
-
#
|
11797
|
-
#
|
11798
|
-
#
|
11799
|
-
# will receive a `ResourceNotFoundException`.
|
12346
|
+
# * If the phone number is claimed to a traffic distribution group that
|
12347
|
+
# was created in the same Region as the Amazon Connect instance where
|
12348
|
+
# you are calling this API, then you can use a full phone number ARN
|
12349
|
+
# or a UUID for `OutboundCallerIdNumberId`. However, if the phone
|
12350
|
+
# number is claimed to a traffic distribution group that is in one
|
12351
|
+
# Region, and you are calling this API from an instance in another
|
12352
|
+
# Amazon Web Services Region that is associated with the traffic
|
12353
|
+
# distribution group, you must provide a full phone number ARN. If a
|
12354
|
+
# UUID is provided in this scenario, you will receive a
|
12355
|
+
# `ResourceNotFoundException`.
|
11800
12356
|
#
|
11801
|
-
#
|
11802
|
-
# in the path, for example,
|
11803
|
-
#
|
11804
|
-
# same ARN format that is returned when you call the
|
11805
|
-
#
|
12357
|
+
# * Only use the phone number ARN format that doesn't contain
|
12358
|
+
# `instance` in the path, for example,
|
12359
|
+
# `arn:aws:connect:us-east-1:1234567890:phone-number/uuid`. This is
|
12360
|
+
# the same ARN format that is returned when you call the
|
12361
|
+
# [ListPhoneNumbersV2][1] API.
|
11806
12362
|
#
|
12363
|
+
# * If you plan to use IAM policies to allow/deny access to this API for
|
12364
|
+
# phone number resources claimed to a traffic distribution group, see
|
12365
|
+
# [Allow or Deny queue API actions for phone numbers in a replica
|
12366
|
+
# Region][2].
|
11807
12367
|
#
|
11808
12368
|
#
|
11809
|
-
#
|
11810
|
-
# [
|
12369
|
+
#
|
12370
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html
|
12371
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region
|
11811
12372
|
#
|
11812
12373
|
# @option params [required, String] :instance_id
|
11813
12374
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -12477,13 +13038,23 @@ module Aws::Connect
|
|
12477
13038
|
# Updates the traffic distribution for a given traffic distribution
|
12478
13039
|
# group.
|
12479
13040
|
#
|
13041
|
+
# <note markdown="1"> You can change the `SignInConfig` distribution only for a default
|
13042
|
+
# `TrafficDistributionGroup` (see the `IsDefault` parameter in the
|
13043
|
+
# [TrafficDistributionGroup][1] data type). If you call
|
13044
|
+
# `UpdateTrafficDistribution` with a modified `SignInConfig` and a
|
13045
|
+
# non-default `TrafficDistributionGroup`, an `InvalidRequestException`
|
13046
|
+
# is returned.
|
13047
|
+
#
|
13048
|
+
# </note>
|
13049
|
+
#
|
12480
13050
|
# For more information about updating a traffic distribution group, see
|
12481
13051
|
# [Update telephony traffic distribution across Amazon Web Services
|
12482
|
-
# Regions ][
|
13052
|
+
# Regions ][2] in the *Amazon Connect Administrator Guide*.
|
12483
13053
|
#
|
12484
13054
|
#
|
12485
13055
|
#
|
12486
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
13056
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html
|
13057
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html
|
12487
13058
|
#
|
12488
13059
|
# @option params [required, String] :id
|
12489
13060
|
# The identifier of the traffic distribution group. This can be the ID
|
@@ -12494,6 +13065,13 @@ module Aws::Connect
|
|
12494
13065
|
# @option params [Types::TelephonyConfig] :telephony_config
|
12495
13066
|
# The distribution of traffic between the instance and its replica(s).
|
12496
13067
|
#
|
13068
|
+
# @option params [Types::SignInConfig] :sign_in_config
|
13069
|
+
# The distribution of allowing signing in to the instance and its
|
13070
|
+
# replica(s).
|
13071
|
+
#
|
13072
|
+
# @option params [Types::AgentConfig] :agent_config
|
13073
|
+
# The distribution of agents between the instance and its replica(s).
|
13074
|
+
#
|
12497
13075
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
12498
13076
|
#
|
12499
13077
|
# @example Request syntax with placeholder values
|
@@ -12508,6 +13086,22 @@ module Aws::Connect
|
|
12508
13086
|
# },
|
12509
13087
|
# ],
|
12510
13088
|
# },
|
13089
|
+
# sign_in_config: {
|
13090
|
+
# distributions: [ # required
|
13091
|
+
# {
|
13092
|
+
# region: "AwsRegion", # required
|
13093
|
+
# enabled: false, # required
|
13094
|
+
# },
|
13095
|
+
# ],
|
13096
|
+
# },
|
13097
|
+
# agent_config: {
|
13098
|
+
# distributions: [ # required
|
13099
|
+
# {
|
13100
|
+
# region: "AwsRegion", # required
|
13101
|
+
# percentage: 1, # required
|
13102
|
+
# },
|
13103
|
+
# ],
|
13104
|
+
# },
|
12511
13105
|
# })
|
12512
13106
|
#
|
12513
13107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTrafficDistribution AWS API Documentation
|
@@ -12800,6 +13394,113 @@ module Aws::Connect
|
|
12800
13394
|
req.send_request(options)
|
12801
13395
|
end
|
12802
13396
|
|
13397
|
+
# Updates the view content of the given view identifier in the specified
|
13398
|
+
# Amazon Connect instance.
|
13399
|
+
#
|
13400
|
+
# It performs content validation if `Status` is set to `SAVED` and
|
13401
|
+
# performs full content validation if `Status` is `PUBLISHED`. Note that
|
13402
|
+
# the `$SAVED` alias' content will always be updated, but the `$LATEST`
|
13403
|
+
# alias' content will only be updated if `Status` is `PUBLISHED`.
|
13404
|
+
#
|
13405
|
+
# @option params [required, String] :instance_id
|
13406
|
+
# The identifier of the Amazon Connect instance. You can find the
|
13407
|
+
# instanceId in the ARN of the instance.
|
13408
|
+
#
|
13409
|
+
# @option params [required, String] :view_id
|
13410
|
+
# The identifier of the view. Both `ViewArn` and `ViewId` can be used.
|
13411
|
+
#
|
13412
|
+
# @option params [required, String] :status
|
13413
|
+
# Indicates the view status as either `SAVED` or `PUBLISHED`. The
|
13414
|
+
# `PUBLISHED` status will initiate validation on the content.
|
13415
|
+
#
|
13416
|
+
# @option params [required, Types::ViewInputContent] :content
|
13417
|
+
# View content containing all content necessary to render a view except
|
13418
|
+
# for runtime input data and the runtime input schema, which is
|
13419
|
+
# auto-generated by this operation.
|
13420
|
+
#
|
13421
|
+
# The total uncompressed content has a maximum file size of 400kB.
|
13422
|
+
#
|
13423
|
+
# @return [Types::UpdateViewContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13424
|
+
#
|
13425
|
+
# * {Types::UpdateViewContentResponse#view #view} => Types::View
|
13426
|
+
#
|
13427
|
+
# @example Request syntax with placeholder values
|
13428
|
+
#
|
13429
|
+
# resp = client.update_view_content({
|
13430
|
+
# instance_id: "ViewsInstanceId", # required
|
13431
|
+
# view_id: "ViewId", # required
|
13432
|
+
# status: "PUBLISHED", # required, accepts PUBLISHED, SAVED
|
13433
|
+
# content: { # required
|
13434
|
+
# template: "ViewTemplate",
|
13435
|
+
# actions: ["ViewAction"],
|
13436
|
+
# },
|
13437
|
+
# })
|
13438
|
+
#
|
13439
|
+
# @example Response structure
|
13440
|
+
#
|
13441
|
+
# resp.view.id #=> String
|
13442
|
+
# resp.view.arn #=> String
|
13443
|
+
# resp.view.name #=> String
|
13444
|
+
# resp.view.status #=> String, one of "PUBLISHED", "SAVED"
|
13445
|
+
# resp.view.type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
13446
|
+
# resp.view.description #=> String
|
13447
|
+
# resp.view.version #=> Integer
|
13448
|
+
# resp.view.version_description #=> String
|
13449
|
+
# resp.view.content.input_schema #=> String
|
13450
|
+
# resp.view.content.template #=> String
|
13451
|
+
# resp.view.content.actions #=> Array
|
13452
|
+
# resp.view.content.actions[0] #=> String
|
13453
|
+
# resp.view.tags #=> Hash
|
13454
|
+
# resp.view.tags["TagKey"] #=> String
|
13455
|
+
# resp.view.created_time #=> Time
|
13456
|
+
# resp.view.last_modified_time #=> Time
|
13457
|
+
# resp.view.view_content_sha_256 #=> String
|
13458
|
+
#
|
13459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateViewContent AWS API Documentation
|
13460
|
+
#
|
13461
|
+
# @overload update_view_content(params = {})
|
13462
|
+
# @param [Hash] params ({})
|
13463
|
+
def update_view_content(params = {}, options = {})
|
13464
|
+
req = build_request(:update_view_content, params)
|
13465
|
+
req.send_request(options)
|
13466
|
+
end
|
13467
|
+
|
13468
|
+
# Updates the view metadata. Note that either `Name` or `Description`
|
13469
|
+
# must be provided.
|
13470
|
+
#
|
13471
|
+
# @option params [required, String] :instance_id
|
13472
|
+
# The identifier of the Amazon Connect instance. You can find the
|
13473
|
+
# instanceId in the ARN of the instance.
|
13474
|
+
#
|
13475
|
+
# @option params [required, String] :view_id
|
13476
|
+
# The identifier of the view. Both `ViewArn` and `ViewId` can be used.
|
13477
|
+
#
|
13478
|
+
# @option params [String] :name
|
13479
|
+
# The name of the view.
|
13480
|
+
#
|
13481
|
+
# @option params [String] :description
|
13482
|
+
# The description of the view.
|
13483
|
+
#
|
13484
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13485
|
+
#
|
13486
|
+
# @example Request syntax with placeholder values
|
13487
|
+
#
|
13488
|
+
# resp = client.update_view_metadata({
|
13489
|
+
# instance_id: "ViewsInstanceId", # required
|
13490
|
+
# view_id: "ViewId", # required
|
13491
|
+
# name: "ViewName",
|
13492
|
+
# description: "ViewDescription",
|
13493
|
+
# })
|
13494
|
+
#
|
13495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateViewMetadata AWS API Documentation
|
13496
|
+
#
|
13497
|
+
# @overload update_view_metadata(params = {})
|
13498
|
+
# @param [Hash] params ({})
|
13499
|
+
def update_view_metadata(params = {}, options = {})
|
13500
|
+
req = build_request(:update_view_metadata, params)
|
13501
|
+
req.send_request(options)
|
13502
|
+
end
|
13503
|
+
|
12803
13504
|
# @!endgroup
|
12804
13505
|
|
12805
13506
|
# @param params ({})
|
@@ -12813,7 +13514,7 @@ module Aws::Connect
|
|
12813
13514
|
params: params,
|
12814
13515
|
config: config)
|
12815
13516
|
context[:gem_name] = 'aws-sdk-connect'
|
12816
|
-
context[:gem_version] = '1.
|
13517
|
+
context[:gem_version] = '1.125.0'
|
12817
13518
|
Seahorse::Client::Request.new(handlers, context)
|
12818
13519
|
end
|
12819
13520
|
|