Get-CONNMetricData Cmdlet

Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig

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.

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.

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.

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.This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDSStatistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDSStatistic: AVG

API_CONTACTS_HANDLED

Unit: COUNTStatistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNTStatistic: SUM

CONTACTS_ABANDONED

Unit: COUNTStatistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNTStatistic: SUM

CONTACTS_CONSULTED

Unit: COUNTStatistic: SUM

CONTACTS_HANDLED

Unit: COUNTStatistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNTStatistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNTStatistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNTStatistic: SUM

CONTACTS_MISSED

Unit: COUNTStatistic: SUM

CONTACTS_QUEUED

Unit: COUNTStatistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNTStatistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNTStatistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNTStatistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNTStatistic: SUM

HANDLE_TIME

Unit: SECONDSStatistic: AVG

HOLD_TIME

Unit: SECONDSStatistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDSStatistic: AVG

INTERACTION_TIME

Unit: SECONDSStatistic: AVG

OCCUPANCY

Unit: PERCENTStatistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDSStatistic: AVG

QUEUED_TIME

Unit: SECONDSStatistic: MAX

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").

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

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, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.

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.

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

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.

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.