aws-sdk-connect 1.98.0 → 1.100.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f743495f317c7663c592dc09e1a3c0bada465cfe5a034dde787e7510916a837c
-  data.tar.gz: 1f3fd412666fec0dd5a6c49f125cb67fcfa19e0817496f23100344150d8268cd
+  metadata.gz: 6466cda0d66fccf0693bd20bed3d1385d63f4b18c9d7d0b5855a902bd5040c53
+  data.tar.gz: 772ecb8d31e7ead9d5e513d839b4b71285cc2229b4f316123b13dfec73a324ed
 SHA512:
-  metadata.gz: b4acdea589c17b8797a288cc4cedeb5ef161bef6f62132a8b5885196bfb8e17e2295f3ccdf1cfd74de4e70e30311244f17c709290a749f249ccaaf4fed28dc91
-  data.tar.gz: 550cdf5002ddebe73d6da936f5ed3330a38622a509798c3aa0c22f37746b69d460689f9719014f26f9f1e93d86912181478fd3db1675b100a8687dec80df783b
+  metadata.gz: 4d3e37c3dc53c114a4ab983cacedbf924187db440e81481389fe51ccd3b05e5cf9b1df3ac3a5887253a841f417c0a6077118e38afa7c6fc25fa5f9760949ec3a
+  data.tar.gz: fa737a57a0407cc7cc783038b94014e7ed624202b4f90e11916c084c9ce0de2277fbe470ba3e7af9928c041a34350c7c4454be39b0603a26d9f2c23eb88d65ac

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.100.0 (2023-03-27)
+------------------
+
+* Feature - This release introduces support for RelatedContactId in the StartChatContact API. Interactive message and interactive message response have been added to the list of supported message content types for this API as well.
+
+1.99.0 (2023-03-09)
+------------------
+
+* Feature - This release adds a new API, GetMetricDataV2, which returns metric data for Amazon Connect.
+
 1.98.0 (2023-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.98.0
+1.100.0

data/lib/aws-sdk-connect/client.rb

@@ -4805,6 +4805,389 @@ module Aws::Connect
       req.send_request(options)
     end
 
+    # Gets metric data from the specified Amazon Connect instance.
+    #
+    # `GetMetricDataV2` offers more features than [GetMetricData][1], the
+    # previous version of this API. It has new metrics, offers filtering at
+    # a metric level, and offers the ability to filter and group data by
+    # channels, queues, routing profiles, agents, and agent hierarchy
+    # levels. It can retrieve historical data for the last 14 days, in
+    # 24-hour intervals.
+    #
+    # For a description of the historical metrics that are supported by
+    # `GetMetricDataV2` and `GetMetricData`, see [Historical metrics
+    # definitions][2] in the *Amazon Connect Administrator's Guide*.
+    #
+    # This API is not available in the Amazon Web Services GovCloud (US)
+    # Regions.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html
+    # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Name (ARN) of the resource. This includes the
+    #   `instanceId` an Amazon Connect instance.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :start_time
+    #   The timestamp, in UNIX Epoch time format, at which to start the
+    #   reporting interval for the retrieval of historical metrics data. The
+    #   time must be before the end time timestamp. The time range between the
+    #   start and end time must be less than 24 hours. The start time cannot
+    #   be earlier than 14 days before the time of the request. Historical
+    #   metrics are available for 14 days.
+    #
+    # @option params [required, Time,DateTime,Date,Integer,String] :end_time
+    #   The timestamp, in UNIX Epoch time format, at which to end the
+    #   reporting interval for the retrieval of historical metrics data. The
+    #   time must be later than the start time timestamp.
+    #
+    #   The time range between the start and end time must be less than 24
+    #   hours.
+    #
+    # @option params [required, Array<Types::FilterV2>] :filters
+    #   The filters to apply to returned metrics. You can filter on the
+    #   following resources:
+    #
+    #   * Queues
+    #
+    #   * Routing profiles
+    #
+    #   * Agents
+    #
+    #   * Channels
+    #
+    #   * User hierarchy groups
+    #
+    #   At least one filter must be passed from queues, routing profiles,
+    #   agents, or user hierarchy groups.
+    #
+    #   To filter by phone number, see [Create a historical metrics report][1]
+    #   in the *Amazon Connect Administrator's Guide*.
+    #
+    #   Note the following limits:
+    #
+    #   * **Filter keys**: A maximum of 5 filter keys are supported in a
+    #     single request. Valid filter keys: `QUEUE` \| `ROUTING_PROFILE` \|
+    #     `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
+    #     `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
+    #     `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
+    #
+    #   * **Filter values**: A maximum of 100 filter values are supported in a
+    #     single request. For example, a `GetMetricDataV2` request can filter
+    #     by 50 queues, 35 agents, and 15 routing profiles for a total of 100
+    #     filter values. `VOICE`, `CHAT`, and `TASK` are valid `filterValue`
+    #     for the `CHANNEL` filter key.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
+    #
+    # @option params [Array<String>] :groupings
+    #   The grouping applied to the metrics that are returned. For example,
+    #   when results are grouped by queue, the metrics returned are grouped by
+    #   queue. The values that are returned apply to the metrics for each
+    #   queue. They are not aggregated for all queues.
+    #
+    #   If no grouping is specified, a summary of all metrics is returned.
+    #
+    #   Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
+    #   `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
+    #   `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
+    #   `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
+    #
+    # @option params [required, Array<Types::MetricV2>] :metrics
+    #   The metrics to retrieve. Specify the name, groupings, and filters for
+    #   each metric. The following historical metrics are available. For a
+    #   description of each metric, see [Historical metrics definitions][1] in
+    #   the *Amazon Connect Administrator's Guide*.
+    #
+    #   AGENT\_ADHERENT\_TIME
+    #
+    #   : This metric is available only in Amazon Web Services Regions where
+    #     [Forecasting, capacity planning, and scheduling][2] is available.
+    #
+    #     Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AGENT\_NON\_RESPONSE
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AGENT\_OCCUPANCY
+    #
+    #   : Unit: Percentage
+    #
+    #     Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
+    #
+    #   AGENT\_SCHEDULE\_ADHERENCE
+    #
+    #   : This metric is available only in Amazon Web Services Regions where
+    #     [Forecasting, capacity planning, and scheduling][2] is available.
+    #
+    #     Unit: Percent
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AGENT\_SCHEDULED\_TIME
+    #
+    #   : This metric is available only in Amazon Web Services Regions where
+    #     [Forecasting, capacity planning, and scheduling][2] is available.
+    #
+    #     Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_ABANDON\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_AFTER\_CONTACT\_WORK\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_AGENT\_CONNECTING\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid metric filter key: `INITIATION_METHOD`. For now, this metric
+    #     only supports the following as `INITIATION_METHOD`: `INBOUND` \|
+    #     `OUTBOUND` \| `CALLBACK` \| `API`
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_HANDLE\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_HOLD\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_INTERACTION\_AND\_HOLD\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   AVG\_INTERACTION\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #   AVG\_QUEUE\_ANSWER\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #   CONTACTS\_ABANDONED
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   CONTACTS\_CREATED
+    #
+    #   : Unit: Count
+    #
+    #     Valid metric filter key: `INITIATION_METHOD`
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #   CONTACTS\_HANDLED
+    #
+    #   : Unit: Count
+    #
+    #     Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   CONTACTS\_HOLD\_ABANDONS
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   CONTACTS\_QUEUED
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   CONTACTS\_TRANSFERRED\_OUT
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   MAX\_QUEUED\_TIME
+    #
+    #   : Unit: Seconds
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
+    #     Agent Hierarchy
+    #
+    #   SERVICE\_LEVEL
+    #
+    #   : You can include up to 20 SERVICE\_LEVEL metrics in a request.
+    #
+    #     Unit: Percent
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #     Threshold: For `ThresholdValue`, enter any whole number from 1 to
+    #     604800 (inclusive), in seconds. For `Comparison`, you must enter
+    #     `LT` (for "Less than").
+    #
+    #   SUM\_CONTACTS\_ANSWERED\_IN\_X
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #   SUM\_CONTACTS\_ABANDONED\_IN\_X
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #   SUM\_CONTACTS\_DISCONNECTED
+    #
+    #   : Valid metric filter key: `DISCONNECT_REASON`
+    #
+    #     Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #   SUM\_RETRY\_CALLBACK\_ATTEMPTS
+    #
+    #   : Unit: Count
+    #
+    #     Valid groupings and filters: Queue, Channel, Routing Profile
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
+    #   [2]: https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response in the next request to retrieve the next set of
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page.
+    #
+    # @return [Types::GetMetricDataV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetMetricDataV2Response#next_token #next_token} => String
+    #   * {Types::GetMetricDataV2Response#metric_results #metric_results} => Array&lt;Types::MetricResultV2&gt;
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_metric_data_v2({
+    #     resource_arn: "ARN", # required
+    #     start_time: Time.now, # required
+    #     end_time: Time.now, # required
+    #     filters: [ # required
+    #       {
+    #         filter_key: "ResourceArnOrId",
+    #         filter_values: ["ResourceArnOrId"],
+    #       },
+    #     ],
+    #     groupings: ["GroupingV2"],
+    #     metrics: [ # required
+    #       {
+    #         name: "MetricNameV2",
+    #         threshold: [
+    #           {
+    #             comparison: "ResourceArnOrId",
+    #             threshold_value: 1.0,
+    #           },
+    #         ],
+    #         metric_filters: [
+    #           {
+    #             metric_filter_key: "String",
+    #             metric_filter_values: ["String"],
+    #           },
+    #         ],
+    #       },
+    #     ],
+    #     next_token: "NextToken2500",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.metric_results #=> Array
+    #   resp.metric_results[0].dimensions #=> Hash
+    #   resp.metric_results[0].dimensions["DimensionsV2Key"] #=> String
+    #   resp.metric_results[0].collections #=> Array
+    #   resp.metric_results[0].collections[0].metric.name #=> String
+    #   resp.metric_results[0].collections[0].metric.threshold #=> Array
+    #   resp.metric_results[0].collections[0].metric.threshold[0].comparison #=> String
+    #   resp.metric_results[0].collections[0].metric.threshold[0].threshold_value #=> Float
+    #   resp.metric_results[0].collections[0].metric.metric_filters #=> Array
+    #   resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_key #=> String
+    #   resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values #=> Array
+    #   resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values[0] #=> String
+    #   resp.metric_results[0].collections[0].value #=> Float
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetMetricDataV2 AWS API Documentation
+    #
+    # @overload get_metric_data_v2(params = {})
+    # @param [Hash] params ({})
+    def get_metric_data_v2(params = {}, options = {})
+      req = build_request(:get_metric_data_v2, params)
+      req.send_request(options)
+    end
+
     # Gets details about a specific task template in the specified Amazon
     # Connect instance.
     #
@@ -7410,7 +7793,7 @@ module Aws::Connect
     #
     #    </note>
     #
-    #   <note markdown="1"> The currently supported value for `FieldName`\: `name`
+    #   <note markdown="1"> The currently supported value for `FieldName`: `name`
     #
     #    </note>
     #
@@ -7773,17 +8156,31 @@ module Aws::Connect
     #
     # @option params [Integer] :chat_duration_in_minutes
     #   The total duration of the newly started chat session. If not
-    #   specified, the chat session duration defaults to 25 hour. The minumum
+    #   specified, the chat session duration defaults to 25 hour. The minimum
     #   configurable time is 60 minutes. The maximum configurable time is
     #   10,080 minutes (7 days).
     #
     # @option params [Array<String>] :supported_messaging_content_types
-    #   The supported chat message content types. Content types must always
-    #   contain `text/plain`. You can then put any other supported type in the
-    #   list. For example, all the following lists are valid because they
-    #   contain `text/plain`\: `[text/plain, text/markdown,
-    #   application/json]`, `[text/markdown, text/plain]`, `[text/plain,
-    #   application/json]`.
+    #   The supported chat message content types. Supported types are
+    #   `text/plain`, `text/markdown`, `application/json`,
+    #   `application/vnd.amazonaws.connect.message.interactive`, and
+    #   `application/vnd.amazonaws.connect.message.interactive.response`.
+    #
+    #   Content types must always contain `text/plain`. You can then put any
+    #   other supported type in the list. For example, all the following lists
+    #   are valid because they contain `text/plain`: `[text/plain,
+    #   text/markdown, application/json]`, `[text/markdown, text/plain]`,
+    #   `[text/plain, application/json,
+    #   application/vnd.amazonaws.connect.message.interactive.response]`.
+    #
+    #   <note markdown="1"> The type `application/vnd.amazonaws.connect.message.interactive` is
+    #   required to use the [Show view][1] flow block.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html
     #
     # @option params [Types::PersistentChat] :persistent_chat
     #   Enable persistent chats. For more information about enabling
@@ -7794,6 +8191,14 @@ module Aws::Connect
     #
     #   [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html
     #
+    # @option params [String] :related_contact_id
+    #   The unique identifier for an Amazon Connect contact. This identifier
+    #   is related to the chat starting.
+    #
+    #   <note markdown="1"> You cannot provide data for both RelatedContactId and PersistentChat.
+    #
+    #    </note>
+    #
     # @return [Types::StartChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartChatContactResponse#contact_id #contact_id} => String
@@ -7823,6 +8228,7 @@ module Aws::Connect
     #       rehydration_type: "ENTIRE_PAST_SESSION", # accepts ENTIRE_PAST_SESSION, FROM_SEGMENT
     #       source_contact_id: "ContactId",
     #     },
+    #     related_contact_id: "ContactId",
     #   })
     #
     # @example Response structure
@@ -10367,7 +10773,7 @@ module Aws::Connect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connect'
-      context[:gem_version] = '1.98.0'
+      context[:gem_version] = '1.100.0'
       Seahorse::Client::Request.new(handlers, context)
     end