AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Connect Service GetMetricData API operation.

Syntax

Get-CONNMetricData
-InstanceId <String>
-Filters_AgentStatus <String[]>
-Filters_Channel <String[]>
-EndTime <DateTime>
-Grouping <String[]>
-HistoricalMetric <HistoricalMetric[]>
-Filters_Queue <String[]>
-Filters_RoutingProfile <String[]>
-Filters_RoutingStepExpression <String[]>
-StartTime <DateTime>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonConnectConfig>

Description

Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-ClientConfig <AmazonConnectConfig>
Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndTime <DateTime>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filters_AgentStatus <String[]>
A list of up to 50 agent status IDs or ARNs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_AgentStatuses
-Filters_Channel <String[]>
The channel to use to filter the metrics. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_Channels
-Filters_Queue <String[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_Queues
-Filters_RoutingProfile <String[]>
A list of up to 100 routing profile IDs or ARNs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_RoutingProfiles
-Filters_RoutingStepExpression <String[]>
A list of expressions as a filter, in which an expression is an object of a step in a routing criteria. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_RoutingStepExpressions
-Grouping <String[]>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGroupings
-HistoricalMetric <HistoricalMetric[]>
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 Metrics definition in the Amazon Connect Administrator Guide.This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
ABANDON_TIME
Unit: SECONDSStatistic: AVGUI name: Average queue abandon time
AFTER_CONTACT_WORK_TIME
Unit: SECONDSStatistic: AVGUI name: After contact work time
API_CONTACTS_HANDLED
Unit: COUNTStatistic: SUMUI name: API contacts handled
AVG_HOLD_TIME
Unit: SECONDSStatistic: AVGUI name: Average customer hold time
CALLBACK_CONTACTS_HANDLED
Unit: COUNTStatistic: SUMUI name: Callback contacts handled
CONTACTS_ABANDONED
Unit: COUNTStatistic: SUMUI name: Contacts abandoned
CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNTStatistic: SUMUI name: Contacts agent hung up first
CONTACTS_CONSULTED
Unit: COUNTStatistic: SUMUI name: Contacts consulted
CONTACTS_HANDLED
Unit: COUNTStatistic: SUMUI name: Contacts handled
CONTACTS_HANDLED_INCOMING
Unit: COUNTStatistic: SUMUI name: Contacts handled incoming
CONTACTS_HANDLED_OUTBOUND
Unit: COUNTStatistic: SUMUI name: Contacts handled outbound
CONTACTS_HOLD_ABANDONS
Unit: COUNTStatistic: SUMUI name: Contacts hold disconnect
CONTACTS_MISSED
Unit: COUNTStatistic: SUMUI name: AGENT_NON_RESPONSE
CONTACTS_QUEUED
Unit: COUNTStatistic: SUMUI name: Contacts queued
CONTACTS_TRANSFERRED_IN
Unit: COUNTStatistic: SUMUI name: Contacts transferred in
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNTStatistic: SUMUI name: Contacts transferred out queue
CONTACTS_TRANSFERRED_OUT
Unit: COUNTStatistic: SUMUI name: Contacts transferred out
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNTStatistic: SUMUI name: Contacts transferred out queue
HANDLE_TIME
Unit: SECONDSStatistic: AVGUI name: Average handle time
INTERACTION_AND_HOLD_TIME
Unit: SECONDSStatistic: AVGUI name: Average agent interaction and customer hold time
INTERACTION_TIME
Unit: SECONDSStatistic: AVGUI name: Average agent interaction time
OCCUPANCY
Unit: PERCENTStatistic: AVGUI name: Occupancy
QUEUE_ANSWER_TIME
Unit: SECONDSStatistic: AVGUI name: Average queue answer time
QUEUED_TIME
Unit: SECONDSStatistic: MAXUI name: Minimum flow time
SERVICE_LEVEL
You can include up to 20 SERVICE_LEVEL metrics in a request.Unit: PERCENTStatistic: AVGThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Average queue abandon time
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHistoricalMetrics
-InstanceId <String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MaxResult <Int32>
The maximum number of results to return per page.
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.If a value for this parameter is not specified the cmdlet will use a default value of '100'.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxResults
-NextToken <String>
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.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MetricResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetMetricDataResponse). Specifying the name of a property of type Amazon.Connect.Model.GetMetricDataResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTime <DateTime>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Connect.Model.HistoricalMetricResult or Amazon.Connect.Model.GetMetricDataResponse
This cmdlet returns a collection of Amazon.Connect.Model.HistoricalMetricResult objects. The service call response (type Amazon.Connect.Model.GetMetricDataResponse) can be returned by specifying '-Select *'.
Administrator Guide
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z