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

Syntax

Get-CONNMetricDataV2
-EndTime <DateTime>
-Filter <FilterV2[]>
-Grouping <String[]>
-Interval_IntervalPeriod <IntervalPeriod>
-Metric <MetricV2[]>
-ResourceArn <String>
-StartTime <DateTime>
-Interval_TimeZone <String>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonConnectConfig>

Description

Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, 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:
    • Narrow the time range of your request
    • Add filters to reduce the amount of data returned


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 later than the start time timestamp. It cannot be later than the current timestamp.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter <FilterV2[]>
The filters to apply to returned metrics. You can filter on the following resources:
  • Agents
  • Campaigns
  • Channels
  • Feature
  • Queues
  • Routing profiles
  • Routing step expression
  • User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.Note the following limits:
  • Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FEATURE | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | QUEUE | Q_CONNECT_ENABLED |
  • Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
    • TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
    • FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
    This filter is available only for contact record-driven metrics. Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
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)
AliasesFilters
-Grouping <String[]>
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.If no grouping is specified, a summary of all metrics is returned.Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSIONType: Array of stringsArray Members: Maximum number of 4 itemsRequired: No 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
-Interval_IntervalPeriod <IntervalPeriod>
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL. For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period. The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.
  • FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
  • THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
  • HOUR: The difference between StartTime and EndTime must be less than 3 days.
  • DAY: The difference between StartTime and EndTime must be less than 35 days.
  • WEEK: The difference between StartTime and EndTime must be less than 35 days.
  • TOTAL: The difference between StartTime and EndTime must be less than 35 days.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Interval_TimeZone <String>
The timezone applied to requested metrics.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
The maximum number of results to return per page.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-Metric <MetricV2[]>
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
ABANDONMENT_RATE
Unit: PercentValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Abandonment rate
AGENT_ADHERENT_TIME
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Adherent time
AGENT_ANSWER_RATE
Unit: PercentValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Agent answer rate
AGENT_NON_ADHERENT_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Non-adherent time
AGENT_NON_RESPONSE
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Agent non-response
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyData for this metric is available starting from October 1, 2023 0:00:00 GMT.UI name: Agent non-response without customer abandons
AGENT_OCCUPANCY
Unit: PercentageValid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Occupancy
AGENT_SCHEDULE_ADHERENCE
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.Unit: PercentValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Adherence
AGENT_SCHEDULED_TIME
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Scheduled time
AVG_ABANDON_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average queue abandon time
AVG_ACTIVE_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Average active time
AVG_AFTER_CONTACT_WORK_TIME
Unit: SecondsValid metric filter key: INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average after contact work timeFeature is a valid filter but not a valid grouping.
AVG_AGENT_CONNECTING_TIME
Unit: SecondsValid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Average agent API connecting timeThe Negate key in metric-level filters is not applicable for this metric.
AVG_AGENT_PAUSE_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Average agent pause time
AVG_BOT_CONVERSATION_TIME
Unit: SecondsValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource IDUI name: Average bot conversation time
AVG_BOT_CONVERSATION_TURNS
Unit: CountValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource IDUI name: Average bot conversation turns
AVG_CASE_RELATED_CONTACTS
Unit: CountRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Average contacts per case
AVG_CASE_RESOLUTION_TIME
Unit: SecondsRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Average case resolution time
AVG_CONTACT_DURATION
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average contact durationFeature is a valid filter but not a valid grouping.
AVG_CONTACT_FIRST_RESPONSE_TIME_AGENT
Unit: SecondsValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Agent average contact first response wait time
AVG_CONVERSATION_CLOSE_TIME
Unit: SecondsValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average conversation close time
AVG_CONVERSATION_DURATION
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average conversation duration
AVG_DIALS_PER_MINUTE
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.Unit: CountValid groupings and filters: Agent, Campaign, Queue, Routing ProfileUI name: Average dials per minute
AVG_EVALUATION_SCORE
Unit: PercentValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing ProfileUI name: Average evaluation score
AVG_FIRST_RESPONSE_TIME_AGENT
Unit: SecondsValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average agent first response time
AVG_FLOW_TIME
Unit: SecondsValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestampUI name: Average flow time
AVG_GREETING_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average agent greeting time
AVG_HANDLE_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpressionUI name: Average handle timeFeature is a valid filter but not a valid grouping.
AVG_HOLD_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average customer hold timeFeature is a valid filter but not a valid grouping.
AVG_HOLD_TIME_ALL_CONTACTS
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average customer hold time all contacts
AVG_HOLDS
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average holdsFeature is a valid filter but not a valid grouping.
AVG_INTERACTION_AND_HOLD_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average agent interaction and customer hold time
AVG_INTERACTION_TIME
Unit: SecondsValid metric filter key: INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average agent interaction timeFeature is a valid filter but not a valid grouping.
AVG_INTERRUPTIONS_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average agent interruptions
AVG_INTERRUPTION_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average agent interruption time
AVG_MESSAGE_LENGTH_AGENT
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average agent message length
AVG_MESSAGE_LENGTH_CUSTOMER
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average customer message length
AVG_MESSAGES
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average messages
AVG_MESSAGES_AGENT
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average agent messages
AVG_MESSAGES_BOT
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average bot messages
AVG_MESSAGES_CUSTOMER
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average customer messages
AVG_NON_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average non-talk time
AVG_QUEUE_ANSWER_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average queue answer timeFeature is a valid filter but not a valid grouping.
AVG_RESPONSE_TIME_AGENT
Unit: SecondsValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average agent response time
AVG_RESPONSE_TIME_CUSTOMER
Unit: SecondsValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Average customer response time
AVG_RESOLUTION_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average resolution time
AVG_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average talk time
AVG_TALK_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average agent talk time
AVG_TALK_TIME_CUSTOMER
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Average customer talk time
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.Unit: SecondsValid groupings and filters: CampaignUI name: Average wait time after customer connection
AVG_WEIGHTED_EVALUATION_SCORE
Unit: PercentValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing ProfileUI name: Average weighted evaluation score
BOT_CONVERSATIONS_COMPLETED
Unit: CountValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource IDUI name: Bot conversations completed
BOT_INTENTS_COMPLETED
Unit: CountValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource IDUI name: Bot intents completed
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.Unit: CountValid groupings and filters: Agent, CampaignThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).UI name: Campaign contacts abandoned after X
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.Unit: PercentValid groupings and filters: Agent, CampaignThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).UI name: Campaign contacts abandoned after X rate
CAMPAIGN_INTERACTIONS
This metric is available only for outbound campaigns using the email delivery mode.Unit: CountValid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPEValid groupings and filters: CampaignUI name: Campaign interactions
CAMPAIGN_PROGRESS_RATE
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.Unit: PercentValid groupings and filters: Campaign, Campaign Execution TimestampUI name: Campaign progress rate
CAMPAIGN_SEND_ATTEMPTS
This metric is available only for outbound campaigns.Unit: CountValid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:SubtypeUI name: Campaign send attempts
CAMPAIGN_SEND_EXCLUSIONS
This metric is available only for outbound campaigns.Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPEUnit: CountValid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution TimestampUI name: Campaign send exclusions
CASES_CREATED
Unit: CountRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Cases created
CONTACTS_CREATED
Unit: CountValid metric filter key: INITIATION_METHODValid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts createdFeature is a valid filter but not a valid grouping.
CONTACTS_HANDLED
Unit: CountValid metric filter key: INITIATION_METHOD, DISCONNECT_REASONValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in ConnectUI name: API contacts handledFeature is a valid filter but not a valid grouping.
CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
Unit: CountValid metric filter key: INITIATION_METHODValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts handled (connected to agent timestamp)
CONTACTS_HOLD_ABANDONS
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts hold disconnect
CONTACTS_ON_HOLD_AGENT_DISCONNECT
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contacts hold agent disconnect
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contacts hold customer disconnect
CONTACTS_PUT_ON_HOLD
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contacts put on hold
CONTACTS_TRANSFERRED_OUT_EXTERNAL
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contacts transferred out external
CONTACTS_TRANSFERRED_OUT_INTERNAL
Unit: PercentValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contacts transferred out internal
CONTACTS_QUEUED
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts queued
CONTACTS_QUEUED_BY_ENQUEUE
Unit: CountValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:SubtypeUI name: Contacts queued (enqueue timestamp)
CONTACTS_REMOVED_FROM_QUEUE_IN_X
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Q in ConnectThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").UI name: Contacts removed from queue in X seconds
CONTACTS_RESOLVED_IN_X
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in ConnectThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").UI name: Contacts resolved in X
CONTACTS_TRANSFERRED_OUT
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts transferred outFeature is a valid filter but not a valid grouping.
CONTACTS_TRANSFERRED_OUT_BY_AGENT
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts transferred out by agent
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contacts transferred out queue
CURRENT_CASES
Unit: CountRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Current cases
CONVERSATIONS_ABANDONED
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in ConnectUI name: Conversations abandoned
DELIVERY_ATTEMPTS
This metric is available only for outbound campaigns.Unit: CountValid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASONValid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing ProfileUI name: Delivery attemptsCampaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
DELIVERY_ATTEMPT_DISPOSITION_RATE
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.Unit: PercentValid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASONValid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing ProfileUI name: Delivery attempt disposition rateCampaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.
EVALUATIONS_PERFORMED
Unit: CountValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing ProfileUI name: Evaluations performed
FLOWS_OUTCOME
Unit: CountValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestampUI name: Flows outcome
FLOWS_STARTED
Unit: CountValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestampUI name: Flows started
HUMAN_ANSWERED_CALLS
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. Unit: CountValid groupings and filters: Agent, CampaignUI name: Human answered
MAX_FLOW_TIME
Unit: SecondsValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestampUI name: Maximum flow time
MAX_QUEUED_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Maximum queued time
MIN_FLOW_TIME
Unit: SecondsValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestampUI name: Minimum flow time
PERCENT_AUTOMATIC_FAILS
Unit: PercentValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing ProfileUI name: Automatic fails percent
PERCENT_BOT_CONVERSATIONS_OUTCOME
Unit: PercentValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource IDUI name: Percent bot conversations outcome
PERCENT_BOT_INTENTS_OUTCOME
Unit: PercentValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource IDUI name: Percent bot intents outcome
PERCENT_CASES_FIRST_CONTACT_RESOLVED
Unit: PercentRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Cases resolved on first contact
PERCENT_CONTACTS_STEP_EXPIRED
Unit: PercentValid groupings and filters: Queue, RoutingStepExpressionUI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
PERCENT_CONTACTS_STEP_JOINED
Unit: PercentValid groupings and filters: Queue, RoutingStepExpressionUI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
PERCENT_FLOWS_OUTCOME
Unit: PercentValid metric filter key: FLOWS_OUTCOME_TYPEValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestampUI name: Flows outcome percentage.The FLOWS_OUTCOME_TYPE is not a valid grouping.
PERCENT_NON_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: PercentageValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Non-talk time percent
PERCENT_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: PercentageValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Talk time percent
PERCENT_TALK_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: PercentageValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Agent talk time percent
PERCENT_TALK_TIME_CUSTOMER
This metric is available only for contacts analyzed by Contact Lens conversational analytics.Unit: PercentageValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Customer talk time percent
RECIPIENTS_ATTEMPTED
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.Unit: CountValid groupings and filters: Campaign, Campaign Execution TimestampUI name: Recipients attempted
RECIPIENTS_INTERACTED
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPEUnit: CountValid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution TimestampUI name: Recipients interacted
RECIPIENTS_TARGETED
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.Unit: CountValid groupings and filters: Campaign, Campaign Execution TimestampUI name: Recipients targeted
REOPENED_CASE_ACTIONS
Unit: CountRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Cases reopened
RESOLVED_CASE_ACTIONS
Unit: CountRequired filter key: CASE_TEMPLATE_ARNValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUSUI name: Cases resolved
SERVICE_LEVEL
You can include up to 20 SERVICE_LEVEL metrics in a request.Unit: PercentValid groupings and filters: Queue, Channel, Routing Profile, Q in ConnectThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").UI name: Service level X
STEP_CONTACTS_QUEUED
Unit: CountValid groupings and filters: Queue, RoutingStepExpressionUI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
SUM_AFTER_CONTACT_WORK_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: After contact work time
SUM_CONNECTING_TIME_AGENT
Unit: SecondsValid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | APIValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Agent API connecting timeThe Negate key in metric-level filters is not applicable for this metric.
CONTACTS_ABANDONED
Unit: CountMetric filter:
  • Valid values: API| Incoming | Outbound | Transfer | Callback | Queue_Transfer| Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in ConnectUI name: Contact abandoned
SUM_CONTACTS_ABANDONED_IN_X
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in ConnectThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").UI name: Contacts abandoned in X seconds
SUM_CONTACTS_ANSWERED_IN_X
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in ConnectThreshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").UI name: Contacts answered in X seconds
SUM_CONTACT_FLOW_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contact flow time
SUM_CONTACT_TIME_AGENT
Unit: SecondsValid groupings and filters: Routing Profile, Agent, Agent HierarchyUI name: Agent on contact time
SUM_CONTACTS_DISCONNECTED
Valid metric filter key: DISCONNECT_REASONUnit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Contact disconnected
SUM_ERROR_STATUS_TIME_AGENT
Unit: SecondsValid groupings and filters: Routing Profile, Agent, Agent HierarchyUI name: Error status time
SUM_HANDLE_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Contact handle time
SUM_HOLD_TIME
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Customer hold time
SUM_IDLE_TIME_AGENT
Unit: SecondsValid groupings and filters: Routing Profile, Agent, Agent HierarchyUI name: Agent idle time
SUM_INTERACTION_AND_HOLD_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in ConnectUI name: Agent interaction and hold time
SUM_INTERACTION_TIME
Unit: SecondsValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent HierarchyUI name: Agent interaction time
SUM_NON_PRODUCTIVE_TIME_AGENT
Unit: SecondsValid groupings and filters: Routing Profile, Agent, Agent HierarchyUI name: Agent non-productive time
SUM_ONLINE_TIME_AGENT
Unit: SecondsValid groupings and filters: Routing Profile, Agent, Agent HierarchyUI name: Online time
SUM_RETRY_CALLBACK_ATTEMPTS
Unit: CountValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in ConnectUI name: Callback attempts
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)
AliasesMetrics
-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)
-ResourceArn <String>
The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
Required?True
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.GetMetricDataV2Response). Specifying the name of a property of type Amazon.Connect.Model.GetMetricDataV2Response 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 before the end time timestamp. The start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
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.MetricResultV2 or Amazon.Connect.Model.GetMetricDataV2Response
This cmdlet returns a collection of Amazon.Connect.Model.MetricResultV2 objects. The service call response (type Amazon.Connect.Model.GetMetricDataV2Response) 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