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_Channel <String[]>
-EndTime <DateTime>
-Grouping <String[]>
-HistoricalMetric <HistoricalMetric[]>
-Filters_Queue <String[]>
-StartTime <DateTime>
-MaxResult <Int32>
-NextToken <String>

Description

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance. If you are using an IAM account, it must have permission to the connect:GetMetricData action.

This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.

Parameters

-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 StartTime timestamp.The time range between StartTime and EndTime must be less than 24 hours.
Required?False
Position?Named
Accept pipeline input?False
-Filters_Channel <String[]>
The Channel to use as a filter for the metrics returned. Only VOICE is supported.
Required?False
Position?Named
Accept pipeline input?False
AliasesFilters_Channels
-Filters_Queue <String[]>
A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.
Required?False
Position?Named
Accept pipeline input?False
AliasesFilters_Queues
-Grouping <String[]>
The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.The current version supports grouping by QueueIf no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.
Required?False
Position?Named
Accept pipeline input?False
AliasesGroupings
-HistoricalMetric <HistoricalMetric[]>
A list of HistoricalMetric objects that contain the metrics to retrieve with the request.A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.You must list each metric to retrieve data for in the request. For each historical metric you include in the request, you must include a Unit and a Statistic.The following historical metrics are available:
CONTACTS_QUEUED
Unit: COUNTStatistic: SUM
CONTACTS_HANDLED
Unit: COUNTStatistics: SUM
CONTACTS_ABANDONED
Unit: COUNTStatistics: SUM
CONTACTS_CONSULTED
Unit: COUNTStatistics: SUM
CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNTStatistics: SUM
CONTACTS_HANDLED_INCOMING
Unit: COUNTStatistics: SUM
CONTACTS_HANDLED_OUTBOUND
Unit: COUNTStatistics: SUM
CONTACTS_HOLD_ABANDONS
Unit: COUNTStatistics: SUM
CONTACTS_TRANSFERRED_IN
Unit: COUNTStatistics: SUM
CONTACTS_TRANSFERRED_OUT
Unit: COUNTStatistics: SUM
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNTStatistics: SUM
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNTStatistics: SUM
CALLBACK_CONTACTS_HANDLED
Unit: COUNTStatistics: SUM
CALLBACK_CONTACTS_HANDLED
Unit: COUNTStatistics: SUM
API_CONTACTS_HANDLED
Unit: COUNTStatistics: SUM
CONTACTS_MISSED
Unit: COUNTStatistics: SUM
OCCUPANCY
Unit: PERCENTStatistics: AVG
HANDLE_TIME
Unit: SECONDSStatistics: AVG
AFTER_CONTACT_WORK_TIME
Unit: SECONDSStatistics: AVG
QUEUED_TIME
Unit: SECONDSStatistics: MAX
ABANDON_TIME
Unit: COUNTStatistics: SUM
QUEUE_ANSWER_TIME
Unit: SECONDSStatistics: AVG
HOLD_TIME
Unit: SECONDSStatistics: AVG
INTERACTION_TIME
Unit: SECONDSStatistics: AVG
INTERACTION_AND_HOLD_TIME
Unit: SECONDSStatistics: AVG
SERVICE_LEVEL
Unit: PERCENTStatistics: AVGThreshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
Required?False
Position?Named
Accept pipeline input?False
AliasesHistoricalMetrics
-InstanceId <String>
The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MaxResult <Int32>
Indicates the maximum number of results to return per page in the response, between 1-100.
Required?False
Position?Named
Accept pipeline input?False
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.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
Required?False
Position?Named
Accept pipeline input?False
-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.StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the InstanceId parameter.

Outputs

This cmdlet returns a collection of Amazon.Connect.Model.HistoricalMetricResult objects. The service call response (type Amazon.Connect.Model.GetMetricDataResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)

Supported Version

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