diff --git a/AWSConnect/AWSConnect.h b/AWSConnect/AWSConnect.h index fdfc03828a4..7cac3eec19a 100644 --- a/AWSConnect/AWSConnect.h +++ b/AWSConnect/AWSConnect.h @@ -1,5 +1,5 @@ // -// Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. +// Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. diff --git a/AWSConnect/AWSConnectModel.h b/AWSConnect/AWSConnectModel.h index 8778aa63e56..fd25760d7b5 100644 --- a/AWSConnect/AWSConnectModel.h +++ b/AWSConnect/AWSConnectModel.h @@ -1,5 +1,5 @@ // -// Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. +// Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. @@ -342,6 +342,7 @@ typedef NS_ENUM(NSInteger, AWSConnectInstanceAttributeType) { AWSConnectInstanceAttributeTypeMultiPartyConference, AWSConnectInstanceAttributeTypeHighVolumeOutbound, AWSConnectInstanceAttributeTypeEnhancedContactMonitoring, + AWSConnectInstanceAttributeTypeEnhancedChatMonitoring, }; typedef NS_ENUM(NSInteger, AWSConnectInstanceStatus) { @@ -439,6 +440,7 @@ typedef NS_ENUM(NSInteger, AWSConnectParticipantRole) { AWSConnectParticipantRoleCustomer, AWSConnectParticipantRoleSystem, AWSConnectParticipantRoleCustomBot, + AWSConnectParticipantRoleSupervisor, }; typedef NS_ENUM(NSInteger, AWSConnectParticipantTimerAction) { @@ -1808,7 +1810,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end /** -
A structure that defines agent hierarchy group levels which can be used to filter search results. Important: Agent hierarchy group level information in search result is a snapshot, it does not represent current agent hierarchy who handled the contact.
+A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
*/ @interface AWSConnectAgentHierarchyGroups : AWSModel @@ -3056,13 +3058,13 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end /** -A structure that defines filters can be used to search within outputs analyzed by Amazon Connect Contact Lens in a contact.
+A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
*/ @interface AWSConnectContactAnalysis : AWSModel /** -A structure that defines filters can be used to search with text within an Amazon Connect Contact Lens analyzed transcript.
+Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
*/ @property (nonatomic, strong) AWSConnectTranscript * _Nullable transcript; @@ -3288,7 +3290,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, strong) AWSConnectContactSearchSummaryAgentInfo * _Nullable agentInfo; /** -The Amazon Resource Name (ARN) of the contact
+The Amazon Resource Name (ARN) of the contact.
*/ @property (nonatomic, strong) NSString * _Nullable arn; @@ -3318,7 +3320,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, assign) AWSConnectContactInitiationMethod initiationMethod; /** -The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
+The date and time this contact was initiated, in UTC time. For INBOUND
, this is when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For CALLBACK
, this is when the callback contact was created. For TRANSFER
and QUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. For MONITOR
, this is when the supervisor started listening to a contact.
The note for an item (section or question) in a contact evaluation.
+The note for an item (section or question) in a contact evaluation.
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1>
for 10 seconds has expired and <Expression 2>
becomes active, then OLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
+The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using RoutingStepExpression
, you need to pass exactly one QueueId
.
Currently tagging is only supported on the resources that are passed in the filter.
*/ @property (nonatomic, strong) AWSConnectFilters * _Nullable filters; /** -The grouping applied to the metrics returned. For example, when grouped by QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED
, CONTACTS_IN_QUEUE
, and OLDEST_CONTACT_AGE
.
If no Grouping
is included in the request, a summary of metrics is returned.
The grouping applied to the metrics returned. For example, when grouped by QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED
, CONTACTS_IN_QUEUE
, and OLDEST_CONTACT_AGE
.
If no Grouping
is included in the request, a summary of metrics is returned.
When using the RoutingStepExpression
filter, group by ROUTING_STEP_EXPRESSION
is required.
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
+The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
*/ @property (nonatomic, strong) NSArrayThe filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
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 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
| FEATURE
| contact/segmentAttributes/connect:Subtype
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
Routing step expression
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 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
| FEATURE
| contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length.
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
, contact/segmentAttributes/connect:Subtype
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
, contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
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 in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
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
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
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").
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
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 in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
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
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
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").
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for "Less than").
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
+Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
*/ @property (nonatomic, strong) NSArrayThe identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance
+The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
*/ @property (nonatomic, strong) NSString * _Nullable instanceId; @@ -13426,12 +13428,12 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, strong) AWSConnectSearchCriteria * _Nullable searchCriteria; /** -Specifies a field to sort by and a sort order
+Specifies a field to sort by and a sort order.
*/ @property (nonatomic, strong) AWSConnectSort * _Nullable sort; /** -Time range that you want to search results
+Time range that you want to search results.
*/ @property (nonatomic, strong) AWSConnectSearchContactsTimeRange * _Nullable timeRange; @@ -13461,7 +13463,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end /** -A structure of time range that you want to search results
+A structure of time range that you want to search results.
Required parameters: [Type, StartTime, EndTime] */ @interface AWSConnectSearchContactsTimeRange : AWSModel @@ -13478,50 +13480,50 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, strong) NSDate * _Nullable startTime; /** -The type of timestamp to search
+The type of timestamp to search.
*/ @property (nonatomic, assign) AWSConnectSearchContactsTimeRangeType types; @end /** -A structure of search criteria to be used to return contacts
+A structure of search criteria to be used to return contacts.
*/ @interface AWSConnectSearchCriteria : AWSModel /** -The agent hierarchy groups
+The agent hierarchy groups of the agent at the time of handling the contact.
*/ @property (nonatomic, strong) AWSConnectAgentHierarchyGroups * _Nullable agentHierarchyGroups; /** -The array of agent ids
+The identifiers of agents who handled the contacts.
*/ @property (nonatomic, strong) NSArrayThe array of channels
+The list of channels associated with contacts.
*/ @property (nonatomic, strong) NSArrayThe ContactAnalysis object used in search criteria
+Search criteria based on analysis outputs from Amazon Connect Contact Lens.
*/ @property (nonatomic, strong) AWSConnectContactAnalysis * _Nullable contactAnalysis; /** -The array of initiaton methods
+The list of initiation methods associated with contacts.
*/ @property (nonatomic, strong) NSArrayThe array of queue ids.
+The list of queue IDs associated with contacts.
*/ @property (nonatomic, strong) NSArrayThe SearchableContactAttributes object used in search criteria
+The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
A structure that defines searchable contact attributes which can be used to filter search results.
+A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
Required parameters: [Criteria] */ @interface AWSConnectSearchableContactAttributes : AWSModel /** -The array of searhale contact attribute criteria
+The list of criteria based on user-defined contact attributes that are configured for contact search.
*/ @property (nonatomic, strong) NSArrayThe match type of multiple searchable contact attributes criteria.
+The match type combining search criteria using multiple searchable contact attributes.
*/ @property (nonatomic, assign) AWSConnectSearchContactsMatchType matchType; @end /** -The criteria of searchable contact attributes.
+The search criteria based on user-defned contact attribute key and values to search on.
Required parameters: [Key, Values] */ @interface AWSConnectSearchableContactAttributesCriteria : AWSModel /** -The searchable contact attribute key
+The key containing a searchable user-defined contact attribute.
*/ @property (nonatomic, strong) NSString * _Nullable key; /** -The array of contact attribute values used to filter search results.
+The list of values to search for within a user-defined contact attribute.
*/ @property (nonatomic, strong) NSArrayA structure that defines the sort by and a sort order
+A structure that defineds the field name to sort by and a sort order.
Required parameters: [FieldName, Order] */ @interface AWSConnectSort : AWSModel @@ -15604,33 +15606,33 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @end /** -The transcript object used to search results.
+A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
Required parameters: [Criteria] */ @interface AWSConnectTranscript : AWSModel /** -The array of transcript search criteria
+The list of search criteria based on Contact Lens conversational analytics transcript.
*/ @property (nonatomic, strong) NSArrayThe match type of multiple transcript criteira
+The match type combining search criteria using multiple transcript criteria.
*/ @property (nonatomic, assign) AWSConnectSearchContactsMatchType matchType; @end /** -The transcript criteria used to search
+A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
Required parameters: [ParticipantRole, SearchText, MatchType] */ @interface AWSConnectTranscriptCriteria : AWSModel /** -The match type of search texts in a transcript criteria.
+The match type combining search criteria using multiple search texts in a transcript criteria.
*/ @property (nonatomic, assign) AWSConnectSearchContactsMatchType matchType; @@ -17687,7 +17689,7 @@ typedef NS_ENUM(NSInteger, AWSConnectVoiceRecordingTrack) { @property (nonatomic, strong) NSArrayA leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are username
, firstname
, lastname
, resourceId
, routingProfileId
, securityProfileId
, agentGroupId
, and agentGroupPathIds
.
The identifiers for level 5 hierarchy groups.
\"\ }\ },\ - \"documentation\":\"A structure that defines agent hierarchy group levels which can be used to filter search results. Important: Agent hierarchy group level information in search result is a snapshot, it does not represent current agent hierarchy who handled the contact.
\"\ + \"documentation\":\"A structure that defines search criteria for contacts using agent hierarchy group levels. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
\"\ },\ \"AgentInfo\":{\ \"type\":\"structure\",\ @@ -4451,7 +4452,8 @@ - (NSString *)definitionString { \"AgentLastName\":{\ \"type\":\"string\",\ \"max\":100,\ - \"min\":1\ + \"min\":1,\ + \"sensitive\":true\ },\ \"AgentPauseDurationInSeconds\":{\ \"type\":\"integer\",\ @@ -5738,10 +5740,10 @@ - (NSString *)definitionString { \"members\":{\ \"Transcript\":{\ \"shape\":\"Transcript\",\ - \"documentation\":\"A structure that defines filters can be used to search with text within an Amazon Connect Contact Lens analyzed transcript.
\"\ + \"documentation\":\"Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
\"\ }\ },\ - \"documentation\":\"A structure that defines filters can be used to search within outputs analyzed by Amazon Connect Contact Lens in a contact.
\"\ + \"documentation\":\"A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact Lens.
\"\ },\ \"ContactDataRequest\":{\ \"type\":\"structure\",\ @@ -6043,7 +6045,7 @@ - (NSString *)definitionString { \"members\":{\ \"Arn\":{\ \"shape\":\"ARN\",\ - \"documentation\":\"The Amazon Resource Name (ARN) of the contact
\"\ + \"documentation\":\"The Amazon Resource Name (ARN) of the contact.
\"\ },\ \"Id\":{\ \"shape\":\"ContactId\",\ @@ -6075,7 +6077,7 @@ - (NSString *)definitionString { },\ \"InitiationTimestamp\":{\ \"shape\":\"timestamp\",\ - \"documentation\":\"The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
\"\ + \"documentation\":\"The date and time this contact was initiated, in UTC time. For INBOUND
, this is when the contact arrived. For OUTBOUND
, this is when the agent began dialing. For CALLBACK
, this is when the callback contact was created. For TRANSFER
and QUEUE_TRANSFER
, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND
, this is when the agent started dialing the external participant. For MONITOR
, this is when the supervisor started listening to a contact.
Renews the expiration timer for a generated token.
\"\ }\ },\ - \"documentation\":\"Contains credentials to use for federation.
\"\ + \"documentation\":\"Contains credentials to use for federation.
\",\ + \"sensitive\":true\ },\ \"CrossChannelBehavior\":{\ \"type\":\"structure\",\ @@ -8872,7 +8875,8 @@ - (NSString *)definitionString { \"Description\":{\ \"type\":\"string\",\ \"max\":4096,\ - \"min\":0\ + \"min\":0,\ + \"sensitive\":true\ },\ \"Description250\":{\ \"type\":\"string\",\ @@ -9348,7 +9352,10 @@ - (NSString *)definitionString { \"error\":{\"httpStatusCode\":409},\ \"exception\":true\ },\ - \"Email\":{\"type\":\"string\"},\ + \"Email\":{\ + \"type\":\"string\",\ + \"sensitive\":true\ + },\ \"EmailReference\":{\ \"type\":\"structure\",\ \"members\":{\ @@ -10181,14 +10188,14 @@ - (NSString *)definitionString { \"members\":{\ \"Value\":{\ \"shape\":\"EvaluationNoteString\",\ - \"documentation\":\"The note for an item (section or question) in a contact evaluation.
\"\ + \"documentation\":\"The note for an item (section or question) in a contact evaluation.
Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.
Information about notes for a contact evaluation.
\"\ },\ \"EvaluationNoteString\":{\ \"type\":\"string\",\ - \"max\":1024,\ + \"max\":3072,\ \"min\":0\ },\ \"EvaluationNotesMap\":{\ @@ -10541,15 +10548,15 @@ - (NSString *)definitionString { },\ \"Filters\":{\ \"shape\":\"Filters\",\ - \"documentation\":\"The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
\"\ + \"documentation\":\"The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using RoutingStepExpression
, you need to pass exactly one QueueId
.
Currently tagging is only supported on the resources that are passed in the filter.
\"\ },\ \"Groupings\":{\ \"shape\":\"Groupings\",\ - \"documentation\":\"The grouping applied to the metrics returned. For example, when grouped by QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED
, CONTACTS_IN_QUEUE
, and OLDEST_CONTACT_AGE
.
If no Grouping
is included in the request, a summary of metrics is returned.
The grouping applied to the metrics returned. For example, when grouped by QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED
, CONTACTS_IN_QUEUE
, and OLDEST_CONTACT_AGE
.
If no Grouping
is included in the request, a summary of metrics is returned.
When using the RoutingStepExpression
filter, group by ROUTING_STEP_EXPRESSION
is required.
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \\\"Metric\\\": { \\\"Name\\\": \\\"OLDEST_CONTACT_AGE\\\", \\\"Unit\\\": \\\"SECONDS\\\" }, \\\"Value\\\": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \\\"Metric\\\": { \\\"Name\\\": \\\"OLDEST_CONTACT_AGE\\\", \\\"Unit\\\": \\\"SECONDS\\\" }, \\\"Value\\\": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
When the filter RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <Expression 1>
for 10 seconds has expired and <Expression 2>
becomes active, then OLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
\"\ + \"documentation\":\"The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
\"\ },\ \"HistoricalMetrics\":{\ \"shape\":\"HistoricalMetrics\",\ @@ -10798,15 +10805,15 @@ - (NSString *)definitionString { },\ \"Filters\":{\ \"shape\":\"FiltersV2List\",\ - \"documentation\":\"The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
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 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
| FEATURE
| contact/segmentAttributes/connect:Subtype
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
The filters to apply to returned metrics. You can filter on the following resources:
Queues
Routing profiles
Agents
Channels
User hierarchy groups
Feature
Routing step expression
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 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
| FEATURE
| contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
contact_lens_conversational_analytics
is a valid filterValue for the FEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
connect:Chat
, connect:SMS
, connect:Telephony
, and connect:WebRTC
are valid filterValue
examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter
key.
ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length.
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
, contact/segmentAttributes/connect:Subtype
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
, contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
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 in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
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
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \\\"Less than\\\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
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\\\").
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \\\"Less than\\\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \\\"Less than\\\").
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
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 in the Amazon Connect Administrator's Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
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
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid metric filter key: INITIATION_METHOD
, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \\\"Less than\\\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
Feature is a valid filter but not a valid grouping.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
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\\\").
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
. This metric only supports the following filter keys as INITIATION_METHOD
: INBOUND
| OUTBOUND
| CALLBACK
| API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
The Negate
key in Metric Level Filters is not applicable for this metric.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \\\"Less than\\\").
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison
, you must enter LT
(for \\\"Less than\\\").
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge.
\"\ + \"documentation\":\"Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
\"\ },\ \"ClientToken\":{\ \"shape\":\"ClientToken\",\ @@ -14386,7 +14394,8 @@ - (NSString *)definitionString { \"Name\":{\ \"type\":\"string\",\ \"max\":512,\ - \"min\":0\ + \"min\":0,\ + \"sensitive\":true\ },\ \"Name128\":{\ \"type\":\"string\",\ @@ -14586,7 +14595,8 @@ - (NSString *)definitionString { \"AGENT\",\ \"CUSTOMER\",\ \"SYSTEM\",\ - \"CUSTOM_BOT\"\ + \"CUSTOM_BOT\",\ + \"SUPERVISOR\"\ ]\ },\ \"ParticipantTimerAction\":{\ @@ -14670,7 +14680,8 @@ - (NSString *)definitionString { },\ \"Password\":{\ \"type\":\"string\",\ - \"pattern\":\"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\\\d)[a-zA-Z\\\\d\\\\S]{8,64}$/\"\ + \"pattern\":\"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\\\d)[a-zA-Z\\\\d\\\\S]{8,64}$/\",\ + \"sensitive\":true\ },\ \"PauseContactRequest\":{\ \"type\":\"structure\",\ @@ -17071,11 +17082,11 @@ - (NSString *)definitionString { \"members\":{\ \"InstanceId\":{\ \"shape\":\"InstanceId\",\ - \"documentation\":\"The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance
\"\ + \"documentation\":\"The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
\"\ },\ \"TimeRange\":{\ \"shape\":\"SearchContactsTimeRange\",\ - \"documentation\":\"Time range that you want to search results
\"\ + \"documentation\":\"Time range that you want to search results.
\"\ },\ \"SearchCriteria\":{\ \"shape\":\"SearchCriteria\",\ @@ -17092,7 +17103,7 @@ - (NSString *)definitionString { },\ \"Sort\":{\ \"shape\":\"Sort\",\ - \"documentation\":\"Specifies a field to sort by and a sort order
\"\ + \"documentation\":\"Specifies a field to sort by and a sort order.
\"\ }\ }\ },\ @@ -17124,7 +17135,7 @@ - (NSString *)definitionString { \"members\":{\ \"Type\":{\ \"shape\":\"SearchContactsTimeRangeType\",\ - \"documentation\":\"The type of timestamp to search
\"\ + \"documentation\":\"The type of timestamp to search.
\"\ },\ \"StartTime\":{\ \"shape\":\"Timestamp\",\ @@ -17135,7 +17146,7 @@ - (NSString *)definitionString { \"documentation\":\"The end time of the time range.
\"\ }\ },\ - \"documentation\":\"A structure of time range that you want to search results
\"\ + \"documentation\":\"A structure of time range that you want to search results.
\"\ },\ \"SearchContactsTimeRangeType\":{\ \"type\":\"string\",\ @@ -17151,34 +17162,34 @@ - (NSString *)definitionString { \"members\":{\ \"AgentIds\":{\ \"shape\":\"AgentResourceIdList\",\ - \"documentation\":\"The array of agent ids
\"\ + \"documentation\":\"The identifiers of agents who handled the contacts.
\"\ },\ \"AgentHierarchyGroups\":{\ \"shape\":\"AgentHierarchyGroups\",\ - \"documentation\":\"The agent hierarchy groups
\"\ + \"documentation\":\"The agent hierarchy groups of the agent at the time of handling the contact.
\"\ },\ \"Channels\":{\ \"shape\":\"ChannelList\",\ - \"documentation\":\"The array of channels
\"\ + \"documentation\":\"The list of channels associated with contacts.
\"\ },\ \"ContactAnalysis\":{\ \"shape\":\"ContactAnalysis\",\ - \"documentation\":\"The ContactAnalysis object used in search criteria
\"\ + \"documentation\":\"Search criteria based on analysis outputs from Amazon Connect Contact Lens.
\"\ },\ \"InitiationMethods\":{\ \"shape\":\"InitiationMethodList\",\ - \"documentation\":\"The array of initiaton methods
\"\ + \"documentation\":\"The list of initiation methods associated with contacts.
\"\ },\ \"QueueIds\":{\ \"shape\":\"QueueIdList\",\ - \"documentation\":\"The array of queue ids.
\"\ + \"documentation\":\"The list of queue IDs associated with contacts.
\"\ },\ \"SearchableContactAttributes\":{\ \"shape\":\"SearchableContactAttributes\",\ - \"documentation\":\"The SearchableContactAttributes object used in search criteria
\"\ + \"documentation\":\"The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by customer contact attributes in the Amazon Connect Administrator Guide.
To use SearchableContactAttributes
in a search request, the GetContactAttributes
action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions defined by Amazon Connect.
A structure of search criteria to be used to return contacts
\"\ + \"documentation\":\"A structure of search criteria to be used to return contacts.
\"\ },\ \"SearchHoursOfOperationsRequest\":{\ \"type\":\"structure\",\ @@ -17645,14 +17656,14 @@ - (NSString *)definitionString { \"members\":{\ \"Criteria\":{\ \"shape\":\"SearchableContactAttributesCriteriaList\",\ - \"documentation\":\"The array of searhale contact attribute criteria
\"\ + \"documentation\":\"The list of criteria based on user-defined contact attributes that are configured for contact search.
\"\ },\ \"MatchType\":{\ \"shape\":\"SearchContactsMatchType\",\ - \"documentation\":\"The match type of multiple searchable contact attributes criteria.
\"\ + \"documentation\":\"The match type combining search criteria using multiple searchable contact attributes.
\"\ }\ },\ - \"documentation\":\"A structure that defines searchable contact attributes which can be used to filter search results.
\"\ + \"documentation\":\"A structure that defines search criteria based on user-defined contact attributes that are configured for contact search.
\"\ },\ \"SearchableContactAttributesCriteria\":{\ \"type\":\"structure\",\ @@ -17663,14 +17674,14 @@ - (NSString *)definitionString { \"members\":{\ \"Key\":{\ \"shape\":\"SearchableContactAttributeKey\",\ - \"documentation\":\"The searchable contact attribute key
\"\ + \"documentation\":\"The key containing a searchable user-defined contact attribute.
\"\ },\ \"Values\":{\ \"shape\":\"SearchableContactAttributeValueList\",\ - \"documentation\":\"The array of contact attribute values used to filter search results.
\"\ + \"documentation\":\"The list of values to search for within a user-defined contact attribute.
\"\ }\ },\ - \"documentation\":\"The criteria of searchable contact attributes.
\"\ + \"documentation\":\"The search criteria based on user-defned contact attribute key and values to search on.
\"\ },\ \"SearchableContactAttributesCriteriaList\":{\ \"type\":\"list\",\ @@ -18068,7 +18079,7 @@ - (NSString *)definitionString { \"documentation\":\"An ascending or descending sort.
\"\ }\ },\ - \"documentation\":\"A structure that defines the sort by and a sort order
\"\ + \"documentation\":\"A structure that defineds the field name to sort by and a sort order.
\"\ },\ \"SortOrder\":{\ \"type\":\"string\",\ @@ -19345,14 +19356,14 @@ - (NSString *)definitionString { \"members\":{\ \"Criteria\":{\ \"shape\":\"TranscriptCriteriaList\",\ - \"documentation\":\"The array of transcript search criteria
\"\ + \"documentation\":\"The list of search criteria based on Contact Lens conversational analytics transcript.
\"\ },\ \"MatchType\":{\ \"shape\":\"SearchContactsMatchType\",\ - \"documentation\":\"The match type of multiple transcript criteira
\"\ + \"documentation\":\"The match type combining search criteria using multiple transcript criteria.
\"\ }\ },\ - \"documentation\":\"The transcript object used to search results.
\"\ + \"documentation\":\"A structure that defines search criteria and matching logic to search for contacts by matching text with transcripts analyzed by Amazon Connect Contact Lens.
\"\ },\ \"TranscriptCriteria\":{\ \"type\":\"structure\",\ @@ -19372,10 +19383,10 @@ - (NSString *)definitionString { },\ \"MatchType\":{\ \"shape\":\"SearchContactsMatchType\",\ - \"documentation\":\"The match type of search texts in a transcript criteria.
\"\ + \"documentation\":\"The match type combining search criteria using multiple search texts in a transcript criteria.
\"\ }\ },\ - \"documentation\":\"The transcript criteria used to search
\"\ + \"documentation\":\"A structure that defines search criteria base on words or phrases, participants in the Contact Lens conversational analytics transcript.
\"\ },\ \"TranscriptCriteriaList\":{\ \"type\":\"list\",\ @@ -21415,7 +21426,7 @@ - (NSString *)definitionString { },\ \"StringCondition\":{\ \"shape\":\"StringCondition\",\ - \"documentation\":\"A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are name
, description
, and resourceID
.
A leaf node condition which can be used to specify a string condition.
The currently supported values for FieldName
are username
, firstname
, lastname
, resourceId
, routingProfileId
, securityProfileId
, agentGroupId
, and agentGroupPathIds
.