Get-CONNCurrentMetricData Cmdlet

Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig

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: 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

The channel to use to filter the metrics.

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.

A list of up to 100 routing profile IDs or ARNs.

A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.

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 identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

The maximum number of results to return per page.

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.
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.

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.

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.

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.

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.

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

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.

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.

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.

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.

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.

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.

The session token if the access and secret keys are temporary session-based credentials.