aws-sdk-connect 1.98.0 → 1.100.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +415 -9
- data/lib/aws-sdk-connect/client_api.rb +103 -0
- data/lib/aws-sdk-connect/endpoints.rb +14 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-connect/types.rb +526 -18
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -3903,6 +3903,36 @@ module Aws::Connect
|
|
3903
3903
|
include Aws::Structure
|
3904
3904
|
end
|
3905
3905
|
|
3906
|
+
# Contains the filter to apply when retrieving metrics with the
|
3907
|
+
# [GetMetricDataV2][1] API.
|
3908
|
+
#
|
3909
|
+
#
|
3910
|
+
#
|
3911
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html
|
3912
|
+
#
|
3913
|
+
# @!attribute [rw] filter_key
|
3914
|
+
# The key to use for filtering data. For example, `QUEUE`,
|
3915
|
+
# `ROUTING_PROFILE, AGENT`, `CHANNEL`, `AGENT_HIERARCHY_LEVEL_ONE`,
|
3916
|
+
# `AGENT_HIERARCHY_LEVEL_TWO`, `AGENT_HIERARCHY_LEVEL_THREE`,
|
3917
|
+
# `AGENT_HIERARCHY_LEVEL_FOUR`, `AGENT_HIERARCHY_LEVEL_FIVE`. There
|
3918
|
+
# must be at least 1 key and a maximum 5 keys.
|
3919
|
+
# @return [String]
|
3920
|
+
#
|
3921
|
+
# @!attribute [rw] filter_values
|
3922
|
+
# The identifiers to use for filtering data. For example, if you have
|
3923
|
+
# a filter key of `QUEUE`, you would add queue IDs or ARNs in
|
3924
|
+
# `FilterValues`.
|
3925
|
+
# @return [Array<String>]
|
3926
|
+
#
|
3927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/FilterV2 AWS API Documentation
|
3928
|
+
#
|
3929
|
+
class FilterV2 < Struct.new(
|
3930
|
+
:filter_key,
|
3931
|
+
:filter_values)
|
3932
|
+
SENSITIVE = []
|
3933
|
+
include Aws::Structure
|
3934
|
+
end
|
3935
|
+
|
3906
3936
|
# Contains the filter to apply when retrieving metrics.
|
3907
3937
|
#
|
3908
3938
|
# @!attribute [rw] queues
|
@@ -4584,6 +4614,344 @@ module Aws::Connect
|
|
4584
4614
|
include Aws::Structure
|
4585
4615
|
end
|
4586
4616
|
|
4617
|
+
# @!attribute [rw] resource_arn
|
4618
|
+
# The Amazon Resource Name (ARN) of the resource. This includes the
|
4619
|
+
# `instanceId` an Amazon Connect instance.
|
4620
|
+
# @return [String]
|
4621
|
+
#
|
4622
|
+
# @!attribute [rw] start_time
|
4623
|
+
# The timestamp, in UNIX Epoch time format, at which to start the
|
4624
|
+
# reporting interval for the retrieval of historical metrics data. The
|
4625
|
+
# time must be before the end time timestamp. The time range between
|
4626
|
+
# the start and end time must be less than 24 hours. The start time
|
4627
|
+
# cannot be earlier than 14 days before the time of the request.
|
4628
|
+
# Historical metrics are available for 14 days.
|
4629
|
+
# @return [Time]
|
4630
|
+
#
|
4631
|
+
# @!attribute [rw] end_time
|
4632
|
+
# The timestamp, in UNIX Epoch time format, at which to end the
|
4633
|
+
# reporting interval for the retrieval of historical metrics data. The
|
4634
|
+
# time must be later than the start time timestamp.
|
4635
|
+
#
|
4636
|
+
# The time range between the start and end time must be less than 24
|
4637
|
+
# hours.
|
4638
|
+
# @return [Time]
|
4639
|
+
#
|
4640
|
+
# @!attribute [rw] filters
|
4641
|
+
# The filters to apply to returned metrics. You can filter on the
|
4642
|
+
# following resources:
|
4643
|
+
#
|
4644
|
+
# * Queues
|
4645
|
+
#
|
4646
|
+
# * Routing profiles
|
4647
|
+
#
|
4648
|
+
# * Agents
|
4649
|
+
#
|
4650
|
+
# * Channels
|
4651
|
+
#
|
4652
|
+
# * User hierarchy groups
|
4653
|
+
#
|
4654
|
+
# At least one filter must be passed from queues, routing profiles,
|
4655
|
+
# agents, or user hierarchy groups.
|
4656
|
+
#
|
4657
|
+
# To filter by phone number, see [Create a historical metrics
|
4658
|
+
# report][1] in the *Amazon Connect Administrator's Guide*.
|
4659
|
+
#
|
4660
|
+
# Note the following limits:
|
4661
|
+
#
|
4662
|
+
# * **Filter keys**: A maximum of 5 filter keys are supported in a
|
4663
|
+
# single request. Valid filter keys: `QUEUE` \| `ROUTING_PROFILE` \|
|
4664
|
+
# `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
|
4665
|
+
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
4666
|
+
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
|
4667
|
+
#
|
4668
|
+
# * **Filter values**: A maximum of 100 filter values are supported in
|
4669
|
+
# a single request. For example, a `GetMetricDataV2` request can
|
4670
|
+
# filter by 50 queues, 35 agents, and 15 routing profiles for a
|
4671
|
+
# total of 100 filter values. `VOICE`, `CHAT`, and `TASK` are valid
|
4672
|
+
# `filterValue` for the `CHANNEL` filter key.
|
4673
|
+
#
|
4674
|
+
#
|
4675
|
+
#
|
4676
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
|
4677
|
+
# @return [Array<Types::FilterV2>]
|
4678
|
+
#
|
4679
|
+
# @!attribute [rw] groupings
|
4680
|
+
# The grouping applied to the metrics that are returned. For example,
|
4681
|
+
# when results are grouped by queue, the metrics returned are grouped
|
4682
|
+
# by queue. The values that are returned apply to the metrics for each
|
4683
|
+
# queue. They are not aggregated for all queues.
|
4684
|
+
#
|
4685
|
+
# If no grouping is specified, a summary of all metrics is returned.
|
4686
|
+
#
|
4687
|
+
# Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
|
4688
|
+
# `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
|
4689
|
+
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
4690
|
+
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
|
4691
|
+
# @return [Array<String>]
|
4692
|
+
#
|
4693
|
+
# @!attribute [rw] metrics
|
4694
|
+
# The metrics to retrieve. Specify the name, groupings, and filters
|
4695
|
+
# for each metric. The following historical metrics are available. For
|
4696
|
+
# a description of each metric, see [Historical metrics
|
4697
|
+
# definitions][1] in the *Amazon Connect Administrator's Guide*.
|
4698
|
+
#
|
4699
|
+
# AGENT\_ADHERENT\_TIME
|
4700
|
+
#
|
4701
|
+
# : This metric is available only in Amazon Web Services Regions where
|
4702
|
+
# [Forecasting, capacity planning, and scheduling][2] is available.
|
4703
|
+
#
|
4704
|
+
# Unit: Seconds
|
4705
|
+
#
|
4706
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4707
|
+
# Agent, Agent Hierarchy
|
4708
|
+
#
|
4709
|
+
# AGENT\_NON\_RESPONSE
|
4710
|
+
#
|
4711
|
+
# : Unit: Count
|
4712
|
+
#
|
4713
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4714
|
+
# Agent, Agent Hierarchy
|
4715
|
+
#
|
4716
|
+
# AGENT\_OCCUPANCY
|
4717
|
+
#
|
4718
|
+
# : Unit: Percentage
|
4719
|
+
#
|
4720
|
+
# Valid groupings and filters: Routing Profile, Agent, Agent
|
4721
|
+
# Hierarchy
|
4722
|
+
#
|
4723
|
+
# AGENT\_SCHEDULE\_ADHERENCE
|
4724
|
+
#
|
4725
|
+
# : This metric is available only in Amazon Web Services Regions where
|
4726
|
+
# [Forecasting, capacity planning, and scheduling][2] is available.
|
4727
|
+
#
|
4728
|
+
# Unit: Percent
|
4729
|
+
#
|
4730
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4731
|
+
# Agent, Agent Hierarchy
|
4732
|
+
#
|
4733
|
+
# AGENT\_SCHEDULED\_TIME
|
4734
|
+
#
|
4735
|
+
# : This metric is available only in Amazon Web Services Regions where
|
4736
|
+
# [Forecasting, capacity planning, and scheduling][2] is available.
|
4737
|
+
#
|
4738
|
+
# Unit: Seconds
|
4739
|
+
#
|
4740
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4741
|
+
# Agent, Agent Hierarchy
|
4742
|
+
#
|
4743
|
+
# AVG\_ABANDON\_TIME
|
4744
|
+
#
|
4745
|
+
# : Unit: Seconds
|
4746
|
+
#
|
4747
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4748
|
+
# Agent, Agent Hierarchy
|
4749
|
+
#
|
4750
|
+
# AVG\_AFTER\_CONTACT\_WORK\_TIME
|
4751
|
+
#
|
4752
|
+
# : Unit: Seconds
|
4753
|
+
#
|
4754
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4755
|
+
# Agent, Agent Hierarchy
|
4756
|
+
#
|
4757
|
+
# AVG\_AGENT\_CONNECTING\_TIME
|
4758
|
+
#
|
4759
|
+
# : Unit: Seconds
|
4760
|
+
#
|
4761
|
+
# Valid metric filter key: `INITIATION_METHOD`. For now, this metric
|
4762
|
+
# only supports the following as `INITIATION_METHOD`: `INBOUND` \|
|
4763
|
+
# `OUTBOUND` \| `CALLBACK` \| `API`
|
4764
|
+
#
|
4765
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4766
|
+
# Agent, Agent Hierarchy
|
4767
|
+
#
|
4768
|
+
# AVG\_HANDLE\_TIME
|
4769
|
+
#
|
4770
|
+
# : Unit: Seconds
|
4771
|
+
#
|
4772
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4773
|
+
# Agent, Agent Hierarchy
|
4774
|
+
#
|
4775
|
+
# AVG\_HOLD\_TIME
|
4776
|
+
#
|
4777
|
+
# : Unit: Seconds
|
4778
|
+
#
|
4779
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4780
|
+
# Agent, Agent Hierarchy
|
4781
|
+
#
|
4782
|
+
# AVG\_INTERACTION\_AND\_HOLD\_TIME
|
4783
|
+
#
|
4784
|
+
# : Unit: Seconds
|
4785
|
+
#
|
4786
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4787
|
+
# Agent, Agent Hierarchy
|
4788
|
+
#
|
4789
|
+
# AVG\_INTERACTION\_TIME
|
4790
|
+
#
|
4791
|
+
# : Unit: Seconds
|
4792
|
+
#
|
4793
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4794
|
+
#
|
4795
|
+
# AVG\_QUEUE\_ANSWER\_TIME
|
4796
|
+
#
|
4797
|
+
# : Unit: Seconds
|
4798
|
+
#
|
4799
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4800
|
+
#
|
4801
|
+
# CONTACTS\_ABANDONED
|
4802
|
+
#
|
4803
|
+
# : Unit: Count
|
4804
|
+
#
|
4805
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4806
|
+
# Agent, Agent Hierarchy
|
4807
|
+
#
|
4808
|
+
# CONTACTS\_CREATED
|
4809
|
+
#
|
4810
|
+
# : Unit: Count
|
4811
|
+
#
|
4812
|
+
# Valid metric filter key: `INITIATION_METHOD`
|
4813
|
+
#
|
4814
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4815
|
+
#
|
4816
|
+
# CONTACTS\_HANDLED
|
4817
|
+
#
|
4818
|
+
# : Unit: Count
|
4819
|
+
#
|
4820
|
+
# Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
|
4821
|
+
#
|
4822
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4823
|
+
# Agent, Agent Hierarchy
|
4824
|
+
#
|
4825
|
+
# CONTACTS\_HOLD\_ABANDONS
|
4826
|
+
#
|
4827
|
+
# : Unit: Count
|
4828
|
+
#
|
4829
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4830
|
+
# Agent, Agent Hierarchy
|
4831
|
+
#
|
4832
|
+
# CONTACTS\_QUEUED
|
4833
|
+
#
|
4834
|
+
# : Unit: Count
|
4835
|
+
#
|
4836
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4837
|
+
# Agent, Agent Hierarchy
|
4838
|
+
#
|
4839
|
+
# CONTACTS\_TRANSFERRED\_OUT
|
4840
|
+
#
|
4841
|
+
# : Unit: Count
|
4842
|
+
#
|
4843
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4844
|
+
# Agent, Agent Hierarchy
|
4845
|
+
#
|
4846
|
+
# CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
|
4847
|
+
#
|
4848
|
+
# : Unit: Count
|
4849
|
+
#
|
4850
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4851
|
+
# Agent, Agent Hierarchy
|
4852
|
+
#
|
4853
|
+
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
4854
|
+
#
|
4855
|
+
# : Unit: Count
|
4856
|
+
#
|
4857
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4858
|
+
# Agent, Agent Hierarchy
|
4859
|
+
#
|
4860
|
+
# MAX\_QUEUED\_TIME
|
4861
|
+
#
|
4862
|
+
# : Unit: Seconds
|
4863
|
+
#
|
4864
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
4865
|
+
# Agent, Agent Hierarchy
|
4866
|
+
#
|
4867
|
+
# SERVICE\_LEVEL
|
4868
|
+
#
|
4869
|
+
# : You can include up to 20 SERVICE\_LEVEL metrics in a request.
|
4870
|
+
#
|
4871
|
+
# Unit: Percent
|
4872
|
+
#
|
4873
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4874
|
+
#
|
4875
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
4876
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
4877
|
+
# `LT` (for "Less than").
|
4878
|
+
#
|
4879
|
+
# SUM\_CONTACTS\_ANSWERED\_IN\_X
|
4880
|
+
#
|
4881
|
+
# : Unit: Count
|
4882
|
+
#
|
4883
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4884
|
+
#
|
4885
|
+
# SUM\_CONTACTS\_ABANDONED\_IN\_X
|
4886
|
+
#
|
4887
|
+
# : Unit: Count
|
4888
|
+
#
|
4889
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4890
|
+
#
|
4891
|
+
# SUM\_CONTACTS\_DISCONNECTED
|
4892
|
+
#
|
4893
|
+
# : Valid metric filter key: `DISCONNECT_REASON`
|
4894
|
+
#
|
4895
|
+
# Unit: Count
|
4896
|
+
#
|
4897
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4898
|
+
#
|
4899
|
+
# SUM\_RETRY\_CALLBACK\_ATTEMPTS
|
4900
|
+
#
|
4901
|
+
# : Unit: Count
|
4902
|
+
#
|
4903
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile
|
4904
|
+
#
|
4905
|
+
#
|
4906
|
+
#
|
4907
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
4908
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region
|
4909
|
+
# @return [Array<Types::MetricV2>]
|
4910
|
+
#
|
4911
|
+
# @!attribute [rw] next_token
|
4912
|
+
# The token for the next set of results. Use the value returned in the
|
4913
|
+
# previous response in the next request to retrieve the next set of
|
4914
|
+
# results.
|
4915
|
+
# @return [String]
|
4916
|
+
#
|
4917
|
+
# @!attribute [rw] max_results
|
4918
|
+
# The maximum number of results to return per page.
|
4919
|
+
# @return [Integer]
|
4920
|
+
#
|
4921
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2Request AWS API Documentation
|
4922
|
+
#
|
4923
|
+
class GetMetricDataV2Request < Struct.new(
|
4924
|
+
:resource_arn,
|
4925
|
+
:start_time,
|
4926
|
+
:end_time,
|
4927
|
+
:filters,
|
4928
|
+
:groupings,
|
4929
|
+
:metrics,
|
4930
|
+
:next_token,
|
4931
|
+
:max_results)
|
4932
|
+
SENSITIVE = []
|
4933
|
+
include Aws::Structure
|
4934
|
+
end
|
4935
|
+
|
4936
|
+
# @!attribute [rw] next_token
|
4937
|
+
# If there are additional results, this is the token for the next set
|
4938
|
+
# of results.
|
4939
|
+
# @return [String]
|
4940
|
+
#
|
4941
|
+
# @!attribute [rw] metric_results
|
4942
|
+
# Information about the metrics requested in the API request If no
|
4943
|
+
# grouping is specified, a summary of metric data is returned.
|
4944
|
+
# @return [Array<Types::MetricResultV2>]
|
4945
|
+
#
|
4946
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2Response AWS API Documentation
|
4947
|
+
#
|
4948
|
+
class GetMetricDataV2Response < Struct.new(
|
4949
|
+
:next_token,
|
4950
|
+
:metric_results)
|
4951
|
+
SENSITIVE = []
|
4952
|
+
include Aws::Structure
|
4953
|
+
end
|
4954
|
+
|
4587
4955
|
# @!attribute [rw] instance_id
|
4588
4956
|
# The identifier of the Amazon Connect instance. You can [find the
|
4589
4957
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -7336,11 +7704,11 @@ module Aws::Connect
|
|
7336
7704
|
# The number of contacts an agent can have on a channel
|
7337
7705
|
# simultaneously.
|
7338
7706
|
#
|
7339
|
-
# Valid Range for `VOICE
|
7707
|
+
# Valid Range for `VOICE`: Minimum value of 1. Maximum value of 1.
|
7340
7708
|
#
|
7341
|
-
# Valid Range for `CHAT
|
7709
|
+
# Valid Range for `CHAT`: Minimum value of 1. Maximum value of 10.
|
7342
7710
|
#
|
7343
|
-
# Valid Range for `TASK
|
7711
|
+
# Valid Range for `TASK`: Minimum value of 1. Maximum value of 10.
|
7344
7712
|
# @return [Integer]
|
7345
7713
|
#
|
7346
7714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaConcurrency AWS API Documentation
|
@@ -7352,6 +7720,101 @@ module Aws::Connect
|
|
7352
7720
|
include Aws::Structure
|
7353
7721
|
end
|
7354
7722
|
|
7723
|
+
# Contains the name, thresholds, and metric filters.
|
7724
|
+
#
|
7725
|
+
# @!attribute [rw] metric
|
7726
|
+
# The metric name, thresholds, and metric filters of the returned
|
7727
|
+
# metric.
|
7728
|
+
# @return [Types::MetricV2]
|
7729
|
+
#
|
7730
|
+
# @!attribute [rw] value
|
7731
|
+
# The corresponding value of the metric returned in the response.
|
7732
|
+
# @return [Float]
|
7733
|
+
#
|
7734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricDataV2 AWS API Documentation
|
7735
|
+
#
|
7736
|
+
class MetricDataV2 < Struct.new(
|
7737
|
+
:metric,
|
7738
|
+
:value)
|
7739
|
+
SENSITIVE = []
|
7740
|
+
include Aws::Structure
|
7741
|
+
end
|
7742
|
+
|
7743
|
+
# Contains information about the filter used when retrieving metrics.
|
7744
|
+
# `MetricFiltersV2` can be used on the following metrics:
|
7745
|
+
# `AVG_AGENT_CONNECTING_TIME`, `CONTACTS_CREATED`, `CONTACTS_HANDLED`,
|
7746
|
+
# `SUM_CONTACTS_DISCONNECTED`.
|
7747
|
+
#
|
7748
|
+
# @!attribute [rw] metric_filter_key
|
7749
|
+
# The key to use for filtering data.
|
7750
|
+
#
|
7751
|
+
# Valid metric filter keys: `INITIATION_METHOD`, `DISCONNECT_REASON`
|
7752
|
+
# @return [String]
|
7753
|
+
#
|
7754
|
+
# @!attribute [rw] metric_filter_values
|
7755
|
+
# The values to use for filtering data.
|
7756
|
+
#
|
7757
|
+
# Valid metric filter values for `INITIATION_METHOD`: `INBOUND` \|
|
7758
|
+
# `OUTBOUND` \| `TRANSFER` \| `QUEUE_TRANSFER` \| `CALLBACK` \| `API`
|
7759
|
+
#
|
7760
|
+
# Valid metric filter values for `DISCONNECT_REASON`:
|
7761
|
+
# `CUSTOMER_DISCONNECT` \| `AGENT_DISCONNECT` \|
|
7762
|
+
# `THIRD_PARTY_DISCONNECT` \| `TELECOM_PROBLEM` \| `BARGED` \|
|
7763
|
+
# `CONTACT_FLOW_DISCONNECT` \| `OTHER` \| `EXPIRED` \| `API`
|
7764
|
+
# @return [Array<String>]
|
7765
|
+
#
|
7766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricFilterV2 AWS API Documentation
|
7767
|
+
#
|
7768
|
+
class MetricFilterV2 < Struct.new(
|
7769
|
+
:metric_filter_key,
|
7770
|
+
:metric_filter_values)
|
7771
|
+
SENSITIVE = []
|
7772
|
+
include Aws::Structure
|
7773
|
+
end
|
7774
|
+
|
7775
|
+
# Contains information about the metric results.
|
7776
|
+
#
|
7777
|
+
# @!attribute [rw] dimensions
|
7778
|
+
# The dimension for the metrics.
|
7779
|
+
# @return [Hash<String,String>]
|
7780
|
+
#
|
7781
|
+
# @!attribute [rw] collections
|
7782
|
+
# The set of metrics.
|
7783
|
+
# @return [Array<Types::MetricDataV2>]
|
7784
|
+
#
|
7785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricResultV2 AWS API Documentation
|
7786
|
+
#
|
7787
|
+
class MetricResultV2 < Struct.new(
|
7788
|
+
:dimensions,
|
7789
|
+
:collections)
|
7790
|
+
SENSITIVE = []
|
7791
|
+
include Aws::Structure
|
7792
|
+
end
|
7793
|
+
|
7794
|
+
# Contains information about the metric.
|
7795
|
+
#
|
7796
|
+
# @!attribute [rw] name
|
7797
|
+
# The name of the metric.
|
7798
|
+
# @return [String]
|
7799
|
+
#
|
7800
|
+
# @!attribute [rw] threshold
|
7801
|
+
# Contains information about the threshold for service level metrics.
|
7802
|
+
# @return [Array<Types::ThresholdV2>]
|
7803
|
+
#
|
7804
|
+
# @!attribute [rw] metric_filters
|
7805
|
+
# Contains the filters to be used when returning data.
|
7806
|
+
# @return [Array<Types::MetricFilterV2>]
|
7807
|
+
#
|
7808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MetricV2 AWS API Documentation
|
7809
|
+
#
|
7810
|
+
class MetricV2 < Struct.new(
|
7811
|
+
:name,
|
7812
|
+
:threshold,
|
7813
|
+
:metric_filters)
|
7814
|
+
SENSITIVE = []
|
7815
|
+
include Aws::Structure
|
7816
|
+
end
|
7817
|
+
|
7355
7818
|
# @!attribute [rw] instance_id
|
7356
7819
|
# The identifier of the Amazon Connect instance. You can find the
|
7357
7820
|
# instanceId in the ARN of the instance.
|
@@ -7595,7 +8058,7 @@ module Aws::Connect
|
|
7595
8058
|
# The contactId that is used for rehydration depends on the
|
7596
8059
|
# rehydration type. RehydrationType is required for persistent chat.
|
7597
8060
|
#
|
7598
|
-
# * `ENTIRE_PAST_SESSION
|
8061
|
+
# * `ENTIRE_PAST_SESSION`: Rehydrates a chat from the most recently
|
7599
8062
|
# terminated past chat contact of the specified past ended chat
|
7600
8063
|
# session. To use this type, provide the `initialContactId` of the
|
7601
8064
|
# past ended chat session in the `sourceContactId` field. In this
|
@@ -7603,7 +8066,7 @@ module Aws::Connect
|
|
7603
8066
|
# the specified chat session that has ended, and uses it to start a
|
7604
8067
|
# persistent chat.
|
7605
8068
|
#
|
7606
|
-
# * `FROM_SEGMENT
|
8069
|
+
# * `FROM_SEGMENT`: Rehydrates a chat from the past chat contact that
|
7607
8070
|
# is specified in the `sourceContactId` field.
|
7608
8071
|
#
|
7609
8072
|
# The actual contactId used for rehydration is provided in the
|
@@ -7964,7 +8427,7 @@ module Aws::Connect
|
|
7964
8427
|
# A leaf node condition which can be used to specify a string
|
7965
8428
|
# condition.
|
7966
8429
|
#
|
7967
|
-
# <note markdown="1"> The currently supported value for `FieldName
|
8430
|
+
# <note markdown="1"> The currently supported value for `FieldName`: `name`
|
7968
8431
|
#
|
7969
8432
|
# </note>
|
7970
8433
|
# @return [Types::StringCondition]
|
@@ -8656,7 +9119,7 @@ module Aws::Connect
|
|
8656
9119
|
# A leaf node condition which can be used to specify a string
|
8657
9120
|
# condition.
|
8658
9121
|
#
|
8659
|
-
# <note markdown="1"> The currently supported value for `FieldName
|
9122
|
+
# <note markdown="1"> The currently supported value for `FieldName`: `name`
|
8660
9123
|
#
|
8661
9124
|
# </note>
|
8662
9125
|
# @return [Types::StringCondition]
|
@@ -9144,7 +9607,7 @@ module Aws::Connect
|
|
9144
9607
|
#
|
9145
9608
|
# </note>
|
9146
9609
|
#
|
9147
|
-
# <note markdown="1"> The currently supported value for `FieldName
|
9610
|
+
# <note markdown="1"> The currently supported value for `FieldName`: `name`
|
9148
9611
|
#
|
9149
9612
|
# </note>
|
9150
9613
|
# @return [Types::SecurityProfileSearchCriteria]
|
@@ -9426,7 +9889,7 @@ module Aws::Connect
|
|
9426
9889
|
# A leaf node condition which can be used to specify a string
|
9427
9890
|
# condition.
|
9428
9891
|
#
|
9429
|
-
# <note markdown="1"> The currently supported value for `FieldName
|
9892
|
+
# <note markdown="1"> The currently supported value for `FieldName`: `name`
|
9430
9893
|
#
|
9431
9894
|
# </note>
|
9432
9895
|
# @return [Types::StringCondition]
|
@@ -9642,17 +10105,31 @@ module Aws::Connect
|
|
9642
10105
|
# @!attribute [rw] chat_duration_in_minutes
|
9643
10106
|
# The total duration of the newly started chat session. If not
|
9644
10107
|
# specified, the chat session duration defaults to 25 hour. The
|
9645
|
-
#
|
10108
|
+
# minimum configurable time is 60 minutes. The maximum configurable
|
9646
10109
|
# time is 10,080 minutes (7 days).
|
9647
10110
|
# @return [Integer]
|
9648
10111
|
#
|
9649
10112
|
# @!attribute [rw] supported_messaging_content_types
|
9650
|
-
# The supported chat message content types.
|
9651
|
-
#
|
9652
|
-
#
|
9653
|
-
#
|
9654
|
-
#
|
9655
|
-
#
|
10113
|
+
# The supported chat message content types. Supported types are
|
10114
|
+
# `text/plain`, `text/markdown`, `application/json`,
|
10115
|
+
# `application/vnd.amazonaws.connect.message.interactive`, and
|
10116
|
+
# `application/vnd.amazonaws.connect.message.interactive.response`.
|
10117
|
+
#
|
10118
|
+
# Content types must always contain `text/plain`. You can then put any
|
10119
|
+
# other supported type in the list. For example, all the following
|
10120
|
+
# lists are valid because they contain `text/plain`: `[text/plain,
|
10121
|
+
# text/markdown, application/json]`, `[text/markdown, text/plain]`,
|
10122
|
+
# `[text/plain, application/json,
|
10123
|
+
# application/vnd.amazonaws.connect.message.interactive.response]`.
|
10124
|
+
#
|
10125
|
+
# <note markdown="1"> The type `application/vnd.amazonaws.connect.message.interactive` is
|
10126
|
+
# required to use the [Show view][1] flow block.
|
10127
|
+
#
|
10128
|
+
# </note>
|
10129
|
+
#
|
10130
|
+
#
|
10131
|
+
#
|
10132
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html
|
9656
10133
|
# @return [Array<String>]
|
9657
10134
|
#
|
9658
10135
|
# @!attribute [rw] persistent_chat
|
@@ -9665,6 +10142,16 @@ module Aws::Connect
|
|
9665
10142
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
|
9666
10143
|
# @return [Types::PersistentChat]
|
9667
10144
|
#
|
10145
|
+
# @!attribute [rw] related_contact_id
|
10146
|
+
# The unique identifier for an Amazon Connect contact. This identifier
|
10147
|
+
# is related to the chat starting.
|
10148
|
+
#
|
10149
|
+
# <note markdown="1"> You cannot provide data for both RelatedContactId and
|
10150
|
+
# PersistentChat.
|
10151
|
+
#
|
10152
|
+
# </note>
|
10153
|
+
# @return [String]
|
10154
|
+
#
|
9668
10155
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartChatContactRequest AWS API Documentation
|
9669
10156
|
#
|
9670
10157
|
class StartChatContactRequest < Struct.new(
|
@@ -9676,7 +10163,8 @@ module Aws::Connect
|
|
9676
10163
|
:client_token,
|
9677
10164
|
:chat_duration_in_minutes,
|
9678
10165
|
:supported_messaging_content_types,
|
9679
|
-
:persistent_chat
|
10166
|
+
:persistent_chat,
|
10167
|
+
:related_contact_id)
|
9680
10168
|
SENSITIVE = []
|
9681
10169
|
include Aws::Structure
|
9682
10170
|
end
|
@@ -10126,7 +10614,7 @@ module Aws::Connect
|
|
10126
10614
|
|
10127
10615
|
# A leaf node condition which can be used to specify a string condition.
|
10128
10616
|
#
|
10129
|
-
# <note markdown="1"> The currently supported value for `FieldName
|
10617
|
+
# <note markdown="1"> The currently supported value for `FieldName`: `name`
|
10130
10618
|
#
|
10131
10619
|
# </note>
|
10132
10620
|
#
|
@@ -10467,6 +10955,26 @@ module Aws::Connect
|
|
10467
10955
|
include Aws::Structure
|
10468
10956
|
end
|
10469
10957
|
|
10958
|
+
# Contains information about the threshold for service level metrics.
|
10959
|
+
#
|
10960
|
+
# @!attribute [rw] comparison
|
10961
|
+
# The type of comparison. Only "less than" (LT) comparisons are
|
10962
|
+
# supported.
|
10963
|
+
# @return [String]
|
10964
|
+
#
|
10965
|
+
# @!attribute [rw] threshold_value
|
10966
|
+
# The threshold value to compare.
|
10967
|
+
# @return [Float]
|
10968
|
+
#
|
10969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ThresholdV2 AWS API Documentation
|
10970
|
+
#
|
10971
|
+
class ThresholdV2 < Struct.new(
|
10972
|
+
:comparison,
|
10973
|
+
:threshold_value)
|
10974
|
+
SENSITIVE = []
|
10975
|
+
include Aws::Structure
|
10976
|
+
end
|
10977
|
+
|
10470
10978
|
# The throttling limit has been exceeded.
|
10471
10979
|
#
|
10472
10980
|
# @!attribute [rw] message
|
data/lib/aws-sdk-connect.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.100.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-
|
11
|
+
date: 2023-03-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|