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 GetCurrentMetricData API operation.

Syntax

Get-CONNCurrentMetricData
-InstanceId <String>
-Filters_AgentStatus <String[]>
-Filters_Channel <String[]>
-CurrentMetric <CurrentMetric[]>
-Grouping <String[]>
-Filters_Queue <String[]>
-Filters_RoutingProfile <String[]>
-Filters_RoutingStepExpression <String[]>
-SortCriterion <CurrentMetricSortCriteria[]>
-Filters_Subtype <String[]>
-Filters_ValidationTestType <String[]>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-PassThru <SwitchParameter>
-ClientConfig <AmazonConnectConfig>

Description

Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response:
  1. Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data
  2. Metric value is a number (including 0) of defined type: The number provided is the calculation result
  3. MetricResult list is empty: The request cannot find any data in the system
The following guidelines can help you work with the API:
  • Each dimension in the metric response must contain a value
  • Each item in MetricResult must include all requested metrics
  • If the response is slow due to large result sets, try these approaches:
    • Add filters to reduce the amount of data returned


In the AWS.Tools.Connect module, 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)
-CurrentMetric <CurrentMetric[]>
The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a description of all the metrics, see Metrics definitions in the Amazon Connect Administrator Guide. MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.
AGENTS_AFTER_CONTACT_WORK
Unit: COUNTName in real-time metrics report: ACW
AGENTS_AVAILABLE
Unit: COUNTName in real-time metrics report: Available
AGENTS_ERROR
Unit: COUNTName in real-time metrics report: Error
AGENTS_NON_PRODUCTIVE
Unit: COUNTName in real-time metrics report: NPT (Non-Productive Time)
AGENTS_ON_CALL
Unit: COUNTName in real-time metrics report: On contact
AGENTS_ON_CONTACT
Unit: COUNTName in real-time metrics report: On contact
AGENTS_ONLINE
Unit: COUNTName in real-time metrics report: Online
AGENTS_STAFFED
Unit: COUNTName in real-time metrics report: Staffed
CONTACTS_IN_QUEUE
Unit: COUNTName in real-time metrics report: In queue
CONTACTS_SCHEDULED
Unit: COUNTName in real-time metrics report: Scheduled
OLDEST_CONTACT_AGE
Unit: SECONDSWhen 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
SLOTS_ACTIVE
Unit: COUNTName in real-time metrics report: Active
SLOTS_AVAILABLE
Unit: COUNTName in real-time metrics report: Availability
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCurrentMetrics
-Filters_AgentStatus <String[]>
A list of up to 50 agent status IDs or ARNs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_AgentStatuses
-Filters_Channel <String[]>
The channel to use to filter the metrics.
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.
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.
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_RoutingStepExpressions
-Filters_Subtype <String[]>
A list of up to 10 subtypes can be provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_Subtypes
-Filters_ValidationTestType <String[]>
A list of up to 10 validationTestTypes can be provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_ValidationTestTypes
-Grouping <String[]>
Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting items into buckets based on a common characteristic, then counting or calculating something for each bucket. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. The grouping list is an ordered list, with the first item in the list defined as the primary grouping. If no grouping is included in the request, the aggregation happens at the instance-level.
  • If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
  • If you group by AGENT_STATUS, you must include the QUEUE as the primary grouping and use queue filter. When you group by AGENT_STATUS, the only metric available is the AGENTS_ONLINE metric.
  • If you group by SUBTYPE or VALIDATION_TEST_TYPE as secondary grouping then you must include QUEUE as primary grouping and use Queue as filter
  • 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.
  • When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesGroupings
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-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.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.
Note: In the AWS.Tools.Connect module, 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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetCurrentMetricDataResponse). Specifying the name of a property of type Amazon.Connect.Model.GetCurrentMetricDataResponse 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)
-SortCriterion <CurrentMetricSortCriteria[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSortCriteria

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.GetCurrentMetricDataResponse
This cmdlet returns an Amazon.Connect.Model.GetCurrentMetricDataResponse object containing multiple properties.
Administrator Guide
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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