aws-sdk-connect 1.124.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +581 -54
- data/lib/aws-sdk-connect/client_api.rb +317 -0
- data/lib/aws-sdk-connect/endpoints.rb +126 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +18 -0
- data/lib/aws-sdk-connect/types.rb +597 -6
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -1702,28 +1702,32 @@ module Aws::Connect
|
|
1702
1702
|
#
|
1703
1703
|
# Creates a new queue for the specified Amazon Connect instance.
|
1704
1704
|
#
|
1705
|
-
# If the number
|
1706
|
-
#
|
1707
|
-
#
|
1708
|
-
#
|
1709
|
-
#
|
1710
|
-
#
|
1711
|
-
#
|
1712
|
-
#
|
1713
|
-
#
|
1714
|
-
#
|
1715
|
-
# 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`.
|
1716
1715
|
#
|
1717
|
-
#
|
1718
|
-
# in the path, for example,
|
1719
|
-
#
|
1720
|
-
# same ARN format that is returned when you call the
|
1721
|
-
#
|
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.
|
1722
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].
|
1723
1726
|
#
|
1724
1727
|
#
|
1725
|
-
#
|
1726
|
-
# [
|
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
|
1727
1731
|
#
|
1728
1732
|
# @option params [required, String] :instance_id
|
1729
1733
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -2273,13 +2277,23 @@ module Aws::Connect
|
|
2273
2277
|
# Creates a traffic distribution group given an Amazon Connect instance
|
2274
2278
|
# that has been replicated.
|
2275
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
|
+
#
|
2276
2289
|
# For more information about creating traffic distribution groups, see
|
2277
|
-
# [Set up traffic distribution groups][
|
2290
|
+
# [Set up traffic distribution groups][2] in the *Amazon Connect
|
2278
2291
|
# Administrator Guide*.
|
2279
2292
|
#
|
2280
2293
|
#
|
2281
2294
|
#
|
2282
|
-
# [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
|
2283
2297
|
#
|
2284
2298
|
# @option params [required, String] :name
|
2285
2299
|
# The name for the traffic distribution group.
|
@@ -2554,6 +2568,161 @@ module Aws::Connect
|
|
2554
2568
|
req.send_request(options)
|
2555
2569
|
end
|
2556
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
|
+
|
2557
2726
|
# Creates a custom vocabulary associated with your Amazon Connect
|
2558
2727
|
# instance. You can set a custom vocabulary to be your default
|
2559
2728
|
# vocabulary for a given language. Contact Lens for Amazon Connect uses
|
@@ -3291,6 +3460,65 @@ module Aws::Connect
|
|
3291
3460
|
req.send_request(options)
|
3292
3461
|
end
|
3293
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
|
+
|
3294
3522
|
# Deletes the vocabulary that has the given identifier.
|
3295
3523
|
#
|
3296
3524
|
# @option params [required, String] :instance_id
|
@@ -4489,6 +4717,68 @@ module Aws::Connect
|
|
4489
4717
|
req.send_request(options)
|
4490
4718
|
end
|
4491
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
|
+
|
4492
4782
|
# Describes the specified vocabulary.
|
4493
4783
|
#
|
4494
4784
|
# @option params [required, String] :instance_id
|
@@ -7423,17 +7713,23 @@ module Aws::Connect
|
|
7423
7713
|
# for Your Contact Center][1] in the *Amazon Connect Administrator
|
7424
7714
|
# Guide*.
|
7425
7715
|
#
|
7426
|
-
#
|
7427
|
-
#
|
7428
|
-
#
|
7429
|
-
#
|
7430
|
-
#
|
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.
|
7431
7727
|
#
|
7432
7728
|
#
|
7433
7729
|
#
|
7434
7730
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html
|
7435
|
-
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/
|
7436
|
-
# [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
|
7437
7733
|
#
|
7438
7734
|
# @option params [required, String] :instance_id
|
7439
7735
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -8542,6 +8838,120 @@ module Aws::Connect
|
|
8542
8838
|
req.send_request(options)
|
8543
8839
|
end
|
8544
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
|
+
|
8545
8955
|
# Initiates silent monitoring of a contact. The Contact Control Panel
|
8546
8956
|
# (CCP) of the user specified by *userId* will be set to silent
|
8547
8957
|
# monitoring mode on the contact.
|
@@ -10426,8 +10836,8 @@ module Aws::Connect
|
|
10426
10836
|
req.send_request(options)
|
10427
10837
|
end
|
10428
10838
|
|
10429
|
-
# Ends the specified contact. This call does not work for
|
10430
|
-
# initiation methods:
|
10839
|
+
# Ends the specified contact. This call does not work for voice contacts
|
10840
|
+
# that use the following initiation methods:
|
10431
10841
|
#
|
10432
10842
|
# * DISCONNECT
|
10433
10843
|
#
|
@@ -10435,6 +10845,9 @@ module Aws::Connect
|
|
10435
10845
|
#
|
10436
10846
|
# * QUEUE\_TRANSFER
|
10437
10847
|
#
|
10848
|
+
# Chat and task contacts, however, can be terminated in any state,
|
10849
|
+
# regardless of initiation method.
|
10850
|
+
#
|
10438
10851
|
# @option params [required, String] :contact_id
|
10439
10852
|
# The ID of the contact.
|
10440
10853
|
#
|
@@ -11930,28 +12343,32 @@ module Aws::Connect
|
|
11930
12343
|
# Updates the outbound caller ID name, number, and outbound whisper flow
|
11931
12344
|
# for a specified queue.
|
11932
12345
|
#
|
11933
|
-
# If the number
|
11934
|
-
#
|
11935
|
-
#
|
11936
|
-
#
|
11937
|
-
#
|
11938
|
-
#
|
11939
|
-
#
|
11940
|
-
#
|
11941
|
-
#
|
11942
|
-
#
|
11943
|
-
# 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`.
|
11944
12356
|
#
|
11945
|
-
#
|
11946
|
-
# in the path, for example,
|
11947
|
-
#
|
11948
|
-
# same ARN format that is returned when you call the
|
11949
|
-
#
|
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.
|
11950
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].
|
11951
12367
|
#
|
11952
12368
|
#
|
11953
|
-
#
|
11954
|
-
# [
|
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
|
11955
12372
|
#
|
11956
12373
|
# @option params [required, String] :instance_id
|
11957
12374
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -12621,20 +13038,23 @@ module Aws::Connect
|
|
12621
13038
|
# Updates the traffic distribution for a given traffic distribution
|
12622
13039
|
# group.
|
12623
13040
|
#
|
12624
|
-
# <note markdown="1"> You can change the `SignInConfig` only for a default
|
12625
|
-
# `TrafficDistributionGroup
|
12626
|
-
#
|
12627
|
-
# `
|
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.
|
12628
13047
|
#
|
12629
13048
|
# </note>
|
12630
13049
|
#
|
12631
13050
|
# For more information about updating a traffic distribution group, see
|
12632
13051
|
# [Update telephony traffic distribution across Amazon Web Services
|
12633
|
-
# Regions ][
|
13052
|
+
# Regions ][2] in the *Amazon Connect Administrator Guide*.
|
12634
13053
|
#
|
12635
13054
|
#
|
12636
13055
|
#
|
12637
|
-
# [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
|
12638
13058
|
#
|
12639
13059
|
# @option params [required, String] :id
|
12640
13060
|
# The identifier of the traffic distribution group. This can be the ID
|
@@ -12974,6 +13394,113 @@ module Aws::Connect
|
|
12974
13394
|
req.send_request(options)
|
12975
13395
|
end
|
12976
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
|
+
|
12977
13504
|
# @!endgroup
|
12978
13505
|
|
12979
13506
|
# @param params ({})
|
@@ -12987,7 +13514,7 @@ module Aws::Connect
|
|
12987
13514
|
params: params,
|
12988
13515
|
config: config)
|
12989
13516
|
context[:gem_name] = 'aws-sdk-connect'
|
12990
|
-
context[:gem_version] = '1.
|
13517
|
+
context[:gem_version] = '1.125.0'
|
12991
13518
|
Seahorse::Client::Request.new(handlers, context)
|
12992
13519
|
end
|
12993
13520
|
|