AWS API Changes

2022/12/23 - Amazon Connect Service - 3 updated api methods

Changes Support for Routing Profile filter, SortCriteria, and grouping by Routing Profiles for GetCurrentMetricData API. Support for RoutingProfiles, UserHierarchyGroups, and Agents as filters, NextStatus and AgentStatusName for GetCurrentUserData. Adds ApproximateTotalCount to both APIs.

GetCurrentMetricData (updated)

Link ¶
Changes (request, response)
Request

{'Filters': {'RoutingProfiles': ['string']},
 'Groupings': {'ROUTING_PROFILE'},
 'SortCriteria': [{'SortByMetric': 'AGENTS_ONLINE | AGENTS_AVAILABLE | '
                                   'AGENTS_ON_CALL | AGENTS_NON_PRODUCTIVE | '
                                   'AGENTS_AFTER_CONTACT_WORK | AGENTS_ERROR | '
                                   'AGENTS_STAFFED | CONTACTS_IN_QUEUE | '
                                   'OLDEST_CONTACT_AGE | CONTACTS_SCHEDULED | '
                                   'AGENTS_ON_CONTACT | SLOTS_ACTIVE | '
                                   'SLOTS_AVAILABLE',
                   'SortOrder': 'ASCENDING | DESCENDING'}]}

Response

{'ApproximateTotalCount': 'long',
 'MetricResults': {'Dimensions': {'RoutingProfile': {'Arn': 'string',
                                                     'Id': 'string'}}}}

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.get_current_metric_data(
    InstanceId='string',
    Filters={
        'Queues': [
            'string',
        ],
        'Channels': [
            'VOICE'|'CHAT'|'TASK',
        ],
        'RoutingProfiles': [
            'string',
        ]
    },
    Groupings=[
        'QUEUE'|'CHANNEL'|'ROUTING_PROFILE',
    ],
    CurrentMetrics=[
        {
            'Name': 'AGENTS_ONLINE'|'AGENTS_AVAILABLE'|'AGENTS_ON_CALL'|'AGENTS_NON_PRODUCTIVE'|'AGENTS_AFTER_CONTACT_WORK'|'AGENTS_ERROR'|'AGENTS_STAFFED'|'CONTACTS_IN_QUEUE'|'OLDEST_CONTACT_AGE'|'CONTACTS_SCHEDULED'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
            'Unit': 'SECONDS'|'COUNT'|'PERCENT'
        },
    ],
    NextToken='string',
    MaxResults=123,
    SortCriteria=[
        {
            'SortByMetric': 'AGENTS_ONLINE'|'AGENTS_AVAILABLE'|'AGENTS_ON_CALL'|'AGENTS_NON_PRODUCTIVE'|'AGENTS_AFTER_CONTACT_WORK'|'AGENTS_ERROR'|'AGENTS_STAFFED'|'CONTACTS_IN_QUEUE'|'OLDEST_CONTACT_AGE'|'CONTACTS_SCHEDULED'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
            'SortOrder': 'ASCENDING'|'DESCENDING'
        },
    ]
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Filters

dict

param Filters

[REQUIRED]

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.

Queues (list) --

The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
- (string) --
Channels (list) --

The channel to use to filter the metrics.
- (string) --
RoutingProfiles (list) --

A list of up to 100 routing profile IDs or ARNs.
- (string) --

type Groupings

list

param Groupings

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.

(string) --

type CurrentMetrics

list

param CurrentMetrics

[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 .

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE

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

SLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

(dict) --

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide .
- Name (string) --
  
  The name of the metric.
- Unit (string) --
  
  The unit for the metric.

type NextToken

string

param NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

type SortCriteria

list

param SortCriteria

The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on AGENTS_ONLINE , DESCENDING . The metric collection is sorted based on the input metrics.

Note the following:

Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.

(dict) --

The way to sort the resulting response based on metrics. By default resources are sorted based on AGENTS_ONLINE , DESCENDING . The metric collection is sorted based on the input metrics.
- SortByMetric (string) --
  
  The current metric names.
- SortOrder (string) --
  
  The way to sort.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'MetricResults': [
        {
            'Dimensions': {
                'Queue': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'Channel': 'VOICE'|'CHAT'|'TASK',
                'RoutingProfile': {
                    'Id': 'string',
                    'Arn': 'string'
                }
            },
            'Collections': [
                {
                    'Metric': {
                        'Name': 'AGENTS_ONLINE'|'AGENTS_AVAILABLE'|'AGENTS_ON_CALL'|'AGENTS_NON_PRODUCTIVE'|'AGENTS_AFTER_CONTACT_WORK'|'AGENTS_ERROR'|'AGENTS_STAFFED'|'CONTACTS_IN_QUEUE'|'OLDEST_CONTACT_AGE'|'CONTACTS_SCHEDULED'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
                        'Unit': 'SECONDS'|'COUNT'|'PERCENT'
                    },
                    'Value': 123.0
                },
            ]
        },
    ],
    'DataSnapshotTime': datetime(2015, 1, 1),
    'ApproximateTotalCount': 123
}

Response Structure

(dict) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
  
  The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
- MetricResults (list) --
  
  Information about the real-time metrics.
  - (dict) --
    
    Contains information about a set of real-time metrics.
    - Dimensions (dict) --
      
      The dimensions for the metrics.
      - Queue (dict) --
        
        Information about the queue for which metrics are returned.
        
        Id (string) --
        
        The identifier of the queue.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the queue.
      - Channel (string) --
        
        The channel used for grouping and filters.
      - RoutingProfile (dict) --
        
        Information about the routing profile assigned to the user.
        
        Id (string) --
        
        The identifier of the routing profile.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the routing profile.
    - Collections (list) --
      
      The set of metrics.
      - (dict) --
        
        Contains the data for a real-time metric.
        
        Metric (dict) --
        
        Information about the metric.
        
        Name (string) --
        
        The name of the metric.
        
        Unit (string) --
        
        The unit for the metric.
        
        Value (float) --
        
        The value of the metric.
- DataSnapshotTime (datetime) --
  
  The time at which the metrics were retrieved and cached for pagination.
- ApproximateTotalCount (integer) --
  
  The total count of the result, regardless of the current page size.

GetCurrentUserData (updated)

Link ¶
Changes (request, response)
Request

{'Filters': {'Agents': ['string'],
             'RoutingProfiles': ['string'],
             'UserHierarchyGroups': ['string']}}

Response

{'ApproximateTotalCount': 'long',
 'UserDataList': {'NextStatus': 'string', 'Status': {'StatusName': 'string'}}}

Gets the real-time active user data from the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.get_current_user_data(
    InstanceId='string',
    Filters={
        'Queues': [
            'string',
        ],
        'ContactFilter': {
            'ContactStates': [
                'INCOMING'|'PENDING'|'CONNECTING'|'CONNECTED'|'CONNECTED_ONHOLD'|'MISSED'|'ERROR'|'ENDED'|'REJECTED',
            ]
        },
        'RoutingProfiles': [
            'string',
        ],
        'Agents': [
            'string',
        ],
        'UserHierarchyGroups': [
            'string',
        ]
    },
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Filters

dict

param Filters

[REQUIRED]

The filters to apply to returned user data. You can filter up to the following limits:

Queues: 100
Routing profiles: 100
Agents: 100
Contact states: 9
User hierarchy groups: 1

The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

Currently tagging is only supported on the resources that are passed in the filter.

Queues (list) --

A list of up to 100 queues or ARNs.
- (string) --
ContactFilter (dict) --

A filter for the user data based on the contact information that is associated to the user. It contains a list of contact states.
- ContactStates (list) --
  
  A list of up to 9 contact states.
  - (string) --
RoutingProfiles (list) --

A list of up to 100 routing profile IDs or ARNs.
- (string) --
Agents (list) --

A list of up to 100 agent IDs or ARNs.
- (string) --
UserHierarchyGroups (list) --

A UserHierarchyGroup ID or ARN.
- (string) --

type NextToken

string

param NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'UserDataList': [
        {
            'User': {
                'Id': 'string',
                'Arn': 'string'
            },
            'RoutingProfile': {
                'Id': 'string',
                'Arn': 'string'
            },
            'HierarchyPath': {
                'LevelOne': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'LevelTwo': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'LevelThree': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'LevelFour': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'LevelFive': {
                    'Id': 'string',
                    'Arn': 'string'
                }
            },
            'Status': {
                'StatusStartTimestamp': datetime(2015, 1, 1),
                'StatusArn': 'string',
                'StatusName': 'string'
            },
            'AvailableSlotsByChannel': {
                'string': 123
            },
            'MaxSlotsByChannel': {
                'string': 123
            },
            'ActiveSlotsByChannel': {
                'string': 123
            },
            'Contacts': [
                {
                    'ContactId': 'string',
                    'Channel': 'VOICE'|'CHAT'|'TASK',
                    'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API',
                    'AgentContactState': 'INCOMING'|'PENDING'|'CONNECTING'|'CONNECTED'|'CONNECTED_ONHOLD'|'MISSED'|'ERROR'|'ENDED'|'REJECTED',
                    'StateStartTimestamp': datetime(2015, 1, 1),
                    'ConnectedToAgentTimestamp': datetime(2015, 1, 1),
                    'Queue': {
                        'Id': 'string',
                        'Arn': 'string'
                    }
                },
            ],
            'NextStatus': 'string'
        },
    ],
    'ApproximateTotalCount': 123
}

Response Structure

(dict) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
- UserDataList (list) --
  
  A list of the user data that is returned.
  - (dict) --
    
    Data for a user.
    - User (dict) --
      
      Information about the user for the data that is returned. It contains the resourceId and ARN of the user.
      - Id (string) --
        
        The unique identifier for the user.
      - Arn (string) --
        
        The Amazon Resource Name (ARN) for the user.
    - RoutingProfile (dict) --
      
      Information about the routing profile that is assigned to the user.
      - Id (string) --
        
        The identifier of the routing profile.
      - Arn (string) --
        
        The Amazon Resource Name (ARN) of the routing profile.
    - HierarchyPath (dict) --
      
      Contains information about the levels of a hierarchy group assigned to a user.
      - LevelOne (dict) --
        
        Information about level one.
        
        Id (string) --
        
        The unique identifier for the hierarchy group.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) for the hierarchy group.
      - LevelTwo (dict) --
        
        Information about level two.
        
        Id (string) --
        
        The unique identifier for the hierarchy group.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) for the hierarchy group.
      - LevelThree (dict) --
        
        Information about level three.
        
        Id (string) --
        
        The unique identifier for the hierarchy group.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) for the hierarchy group.
      - LevelFour (dict) --
        
        Information about level four.
        
        Id (string) --
        
        The unique identifier for the hierarchy group.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) for the hierarchy group.
      - LevelFive (dict) --
        
        Information about level five.
        
        Id (string) --
        
        The unique identifier for the hierarchy group.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) for the hierarchy group.
    - Status (dict) --
      
      The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor manually changes in the real-time metrics report.
      - StatusStartTimestamp (datetime) --
        
        The start timestamp of the agent's status.
      - StatusArn (string) --
        
        The Amazon Resource Name (ARN) of the agent's status.
      - StatusName (string) --
        
        The name of the agent status.
    - AvailableSlotsByChannel (dict) --
      
      A map of available slots by channel. The key is a channel name. The value is an integer: the available number of slots.
      - (string) --
        
        (integer) --
    - MaxSlotsByChannel (dict) --
      
      A map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
      - (string) --
        
        (integer) --
    - ActiveSlotsByChannel (dict) --
      
      A map of active slots by channel. The key is a channel name. The value is an integer: the number of active slots.
      - (string) --
        
        (integer) --
    - Contacts (list) --
      
      A list of contact reference information.
      - (dict) --
        
        Information about the contact associated to the user.
        
        ContactId (string) --
        
        The identifier of the contact in this instance of Amazon Connect.
        
        Channel (string) --
        
        The channel of the contact.
        
        InitiationMethod (string) --
        
        How the contact was initiated.
        
        AgentContactState (string) --
        
        The state of the contact.
        
        StateStartTimestamp (datetime) --
        
        The epoch timestamp when the contact state started.
        
        ConnectedToAgentTimestamp (datetime) --
        
        The time at which the contact was connected to an agent.
        
        Queue (dict) --
        
        Contains information about a queue resource for which metrics are returned.
        
        Id (string) --
        
        The identifier of the queue.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the queue.
    - NextStatus (string) --
      
      The Next status of the agent.
- ApproximateTotalCount (integer) --
  
  The total count of the result, regardless of the current page size.

GetMetricData (updated)

Link ¶
Changes (request, response)
Request

{'Filters': {'RoutingProfiles': ['string']}, 'Groupings': {'ROUTING_PROFILE'}}

Response

{'MetricResults': {'Dimensions': {'RoutingProfile': {'Arn': 'string',
                                                     'Id': 'string'}}}}

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

See also: AWS API Documentation

Request Syntax

client.get_metric_data(
    InstanceId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Filters={
        'Queues': [
            'string',
        ],
        'Channels': [
            'VOICE'|'CHAT'|'TASK',
        ],
        'RoutingProfiles': [
            'string',
        ]
    },
    Groupings=[
        'QUEUE'|'CHANNEL'|'ROUTING_PROFILE',
    ],
    HistoricalMetrics=[
        {
            'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
            'Threshold': {
                'Comparison': 'LT',
                'ThresholdValue': 123.0
            },
            'Statistic': 'SUM'|'MAX'|'AVG',
            'Unit': 'SECONDS'|'COUNT'|'PERCENT'
        },
    ],
    NextToken='string',
    MaxResults=123
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type StartTime

datetime

param StartTime

[REQUIRED]

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

type EndTime

datetime

param EndTime

[REQUIRED]

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

type Filters

dict

param Filters

[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.

Note

To filter by Queues , enter the queue ID/ARN, not the name of the queue.

Queues (list) --

The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
- (string) --
Channels (list) --

The channel to use to filter the metrics.
- (string) --
RoutingProfiles (list) --

A list of up to 100 routing profile IDs or ARNs.
- (string) --

type Groupings

list

param Groupings

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.

(string) --

type HistoricalMetrics

list

param HistoricalMetrics

[REQUIRED]

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .

Note

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue , enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison , you must enter LT (for "Less than").

(dict) --

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide .
- Name (string) --
  
  The name of the metric.
- Threshold (dict) --
  
  The threshold for the metric, used with service level metrics.
  - Comparison (string) --
    
    The type of comparison. Only "less than" (LT) comparisons are supported.
  - ThresholdValue (float) --
    
    The threshold value to compare.
- Statistic (string) --
  
  The statistic for the metric.
- Unit (string) --
  
  The unit for the metric.

type NextToken

string

param NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'MetricResults': [
        {
            'Dimensions': {
                'Queue': {
                    'Id': 'string',
                    'Arn': 'string'
                },
                'Channel': 'VOICE'|'CHAT'|'TASK',
                'RoutingProfile': {
                    'Id': 'string',
                    'Arn': 'string'
                }
            },
            'Collections': [
                {
                    'Metric': {
                        'Name': 'CONTACTS_QUEUED'|'CONTACTS_HANDLED'|'CONTACTS_ABANDONED'|'CONTACTS_CONSULTED'|'CONTACTS_AGENT_HUNG_UP_FIRST'|'CONTACTS_HANDLED_INCOMING'|'CONTACTS_HANDLED_OUTBOUND'|'CONTACTS_HOLD_ABANDONS'|'CONTACTS_TRANSFERRED_IN'|'CONTACTS_TRANSFERRED_OUT'|'CONTACTS_TRANSFERRED_IN_FROM_QUEUE'|'CONTACTS_TRANSFERRED_OUT_FROM_QUEUE'|'CONTACTS_MISSED'|'CALLBACK_CONTACTS_HANDLED'|'API_CONTACTS_HANDLED'|'OCCUPANCY'|'HANDLE_TIME'|'AFTER_CONTACT_WORK_TIME'|'QUEUED_TIME'|'ABANDON_TIME'|'QUEUE_ANSWER_TIME'|'HOLD_TIME'|'INTERACTION_TIME'|'INTERACTION_AND_HOLD_TIME'|'SERVICE_LEVEL',
                        'Threshold': {
                            'Comparison': 'LT',
                            'ThresholdValue': 123.0
                        },
                        'Statistic': 'SUM'|'MAX'|'AVG',
                        'Unit': 'SECONDS'|'COUNT'|'PERCENT'
                    },
                    'Value': 123.0
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  If there are additional results, this is the token for the next set of results.
  
  The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
- MetricResults (list) --
  
  Information about the historical metrics.
  
  If no grouping is specified, a summary of metric data is returned.
  - (dict) --
    
    Contains information about the historical metrics retrieved.
    - Dimensions (dict) --
      
      The dimension for the metrics.
      - Queue (dict) --
        
        Information about the queue for which metrics are returned.
        
        Id (string) --
        
        The identifier of the queue.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the queue.
      - Channel (string) --
        
        The channel used for grouping and filters.
      - RoutingProfile (dict) --
        
        Information about the routing profile assigned to the user.
        
        Id (string) --
        
        The identifier of the routing profile.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the routing profile.
    - Collections (list) --
      
      The set of metrics.
      - (dict) --
        
        Contains the data for a historical metric.
        
        Metric (dict) --
        
        Information about the metric.
        
        Name (string) --
        
        The name of the metric.
        
        Threshold (dict) --
        
        The threshold for the metric, used with service level metrics.
        
        Comparison (string) --
        
        The type of comparison. Only "less than" (LT) comparisons are supported.
        
        ThresholdValue (float) --
        
        The threshold value to compare.
        
        Statistic (string) --
        
        The statistic for the metric.
        
        Unit (string) --
        
        The unit for the metric.
        
        Value (float) --
        
        The value of the metric.