diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index d9638bf9669..79572817244 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -1252,6 +1252,12 @@ { "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" }, + { + "target": "com.amazonaws.connect#SearchContactFlowModules" + }, + { + "target": "com.amazonaws.connect#SearchContactFlows" + }, { "target": "com.amazonaws.connect#SearchContacts" }, @@ -3541,7 +3547,7 @@ } }, "traits": { - "smithy.api#documentation": "
Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.
" + "smithy.api#documentation": "Error describing a failure to retrieve attached file metadata through\n BatchGetAttachedFileMetadata action.
" } }, "com.amazonaws.connect#AttachedFileErrorsList": { @@ -5038,6 +5044,12 @@ "smithy.api#documentation": "The type of flow.
" } }, + "Status": { + "target": "com.amazonaws.connect#ContactFlowStatus", + "traits": { + "smithy.api#documentation": "The status of the contact flow.
" + } + }, "Description": { "target": "com.amazonaws.connect#ContactFlowDescription", "traits": { @@ -5170,6 +5182,52 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.connect#ContactFlowModuleSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowModuleSearchCriteria" + } + }, + "com.amazonaws.connect#ContactFlowModuleSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#ContactFlowModuleSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR
\n condition.
A list of conditions which would be applied together with an AND
\n condition.
The search criteria to be used to return flow modules.
" + } + }, + "com.amazonaws.connect#ContactFlowModuleSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "The search criteria to be used to return flow modules.
" + } + }, + "com.amazonaws.connect#ContactFlowModuleSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowModule" + } + }, "com.amazonaws.connect#ContactFlowModuleState": { "type": "enum", "members": { @@ -5263,6 +5321,70 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.connect#ContactFlowSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlowSearchCriteria" + } + }, + "com.amazonaws.connect#ContactFlowSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#ContactFlowSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR
\n condition.
A list of conditions which would be applied together with an AND
\n condition.
The type of flow.
" + } + }, + "StateCondition": { + "target": "com.amazonaws.connect#ContactFlowState", + "traits": { + "smithy.api#documentation": "The state of the flow.
" + } + }, + "StatusCondition": { + "target": "com.amazonaws.connect#ContactFlowStatus", + "traits": { + "smithy.api#documentation": "The status of the flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The search criteria to be used to return contact flows.
" + } + }, + "com.amazonaws.connect#ContactFlowSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "com.amazonaws.connect#ContactFlowSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ContactFlow" + } + }, "com.amazonaws.connect#ContactFlowState": { "type": "enum", "members": { @@ -5280,6 +5402,23 @@ } } }, + "com.amazonaws.connect#ContactFlowStatus": { + "type": "enum", + "members": { + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" + } + }, + "SAVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAVED" + } + } + } + }, "com.amazonaws.connect#ContactFlowSummary": { "type": "structure", "members": { @@ -5312,6 +5451,12 @@ "traits": { "smithy.api#documentation": "The type of flow.
" } + }, + "ContactFlowStatus": { + "target": "com.amazonaws.connect#ContactFlowStatus", + "traits": { + "smithy.api#documentation": "The status of the contact flow.
" + } } }, "traits": { @@ -6128,6 +6273,12 @@ "smithy.api#required": {} } }, + "Status": { + "target": "com.amazonaws.connect#ContactFlowStatus", + "traits": { + "smithy.api#documentation": "Indicates the flow status as either SAVED
or PUBLISHED
. The\n PUBLISHED
status will initiate validation on the content. the SAVED
\n status does not initiate validation of the content. SAVED
|\n PUBLISHED
.
Describes the specified flow.
\nYou can also create and update flows using the Amazon Connect\n Flow language.
", + "smithy.api#documentation": "Describes the specified flow.
\nYou can also create and update flows using the Amazon Connect\n Flow language.
\nUse the $SAVED
alias in the request to describe the SAVED
content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is\n published, $SAVED
needs to be supplied to view saved content that has not been\n published.
In the response, Status indicates the flow status as either\n SAVED
or PUBLISHED
. The PUBLISHED
status will initiate\n validation on the content. SAVED
does not initiate validation of the content.\n SAVED
| PUBLISHED
\n
Describes the specified flow module.
", + "smithy.api#documentation": "Describes the specified flow module.
\nUse the $SAVED
alias in the request to describe the SAVED
content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is\n published, $SAVED
needs to be supplied to view saved content that has not been\n published.
Optional override for the expiry of the pre-signed S3 URL in seconds.
", + "smithy.api#documentation": "Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is\n 300.
", "smithy.api#httpQuery": "urlExpiryInSeconds" } }, @@ -15253,7 +15404,7 @@ "AssociatedResourceArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "The resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
\nThis value must be a valid ARN.
\nThe resource to which the attached file is (being) uploaded to. Cases are the only\n current supported resource.
" } }, "FileUseCaseType": { @@ -15950,20 +16101,20 @@ "Filters": { "target": "com.amazonaws.connect#FiltersV2List", "traits": { - "smithy.api#documentation": "The filters to apply to returned metrics. You can filter on the following resources:
\nQueues
\nRouting profiles
\nAgents
\nChannels
\nUser hierarchy groups
\nFeature
\nRouting step expression
\nAt least one filter must be passed from queues, routing profiles, agents, or user hierarchy\n groups.
\nTo filter by phone number, see Create a historical\n metrics report in the Amazon Connect Administrator's\n Guide.
\nNote the following limits:
\n\n Filter keys: A maximum of 5 filter keys are supported in\n a single request. Valid filter keys: QUEUE
| ROUTING_PROFILE
|\n AGENT
| CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
|\n AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
|\n AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
|\n FEATURE
| CASE_TEMPLATE_ARN
| CASE_STATUS
|\n contact/segmentAttributes/connect:Subtype
|\n ROUTING_STEP_EXPRESSION
\n
\n Filter values: A maximum of 100 filter values are\n supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the\n CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a\n GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total\n of 100 filter values, along with 3 channel filters.
\n contact_lens_conversational_analytics
is a valid filterValue for the\n FEATURE
filter key. It is available only to contacts analyzed by Contact Lens\n conversational analytics.
\n connect:Chat
, connect:SMS
, connect:Telephony
, and\n connect:WebRTC
are valid filterValue
examples (not exhaustive) for\n the contact/segmentAttributes/connect:Subtype filter
key.
\n ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000\n length. This filter is case and order sensitive. JSON string fields must be sorted in ascending\n order and JSON array order should be kept as is.
The filters to apply to returned metrics. You can filter on the following resources:
\nQueues
\nRouting profiles
\nAgents
\nChannels
\nUser hierarchy groups
\nFeature
\nRouting step expression
\nAt least one filter must be passed from queues, routing profiles, agents, or user hierarchy\n groups.
\nTo filter by phone number, see Create a historical\n metrics report in the Amazon Connect Administrator's\n Guide.
\nNote the following limits:
\n\n Filter keys: A maximum of 5 filter keys are supported in\n a single request. Valid filter keys: QUEUE
| ROUTING_PROFILE
|\n AGENT
| CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
|\n AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
|\n AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
|\n FEATURE
| CASE_TEMPLATE_ARN
| CASE_STATUS
|\n contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
\n | Q_CONNECT_ENABLED
\n
\n Filter values: A maximum of 100 filter values are\n supported in a single request. VOICE, CHAT, and TASK are valid filterValue
for the\n CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a\n GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total\n of 100 filter values, along with 3 channel filters.
\n contact_lens_conversational_analytics
is a valid filterValue for the\n FEATURE
filter key. It is available only to contacts analyzed by Contact Lens\n conversational analytics.
\n connect:Chat
, connect:SMS
, connect:Telephony
, and\n connect:WebRTC
are valid filterValue
examples (not exhaustive) for\n the contact/segmentAttributes/connect:Subtype filter
key.
\n ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000\n length. This filter is case and order sensitive. JSON string fields must be sorted in ascending\n order and JSON array order should be kept as is.
\n Q_CONNECT_ENABLED
. TRUE and FALSE are the only valid filterValues for the\n Q_CONNECT_ENABLED
filter key.
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
\nFALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
\nThis filter is available only for contact record-driven metrics.
\nThe grouping applied to the metrics that are returned. For example, when results are grouped\n by queue, the metrics returned are grouped by queue. The values that are returned apply to the\n metrics for each queue. They are not aggregated for all queues.
\nIf no grouping is specified, a summary of all metrics is returned.
\nValid grouping keys: QUEUE
| ROUTING_PROFILE
| AGENT
\n | CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
|\n AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
|\n AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
|\n CASE_TEMPLATE_ARN
| CASE_STATUS
|\n contact/segmentAttributes/connect:Subtype
|\n ROUTING_STEP_EXPRESSION
\n
The grouping applied to the metrics that are returned. For example, when results are grouped\n by queue, the metrics returned are grouped by queue. The values that are returned apply to the\n metrics for each queue. They are not aggregated for all queues.
\nIf no grouping is specified, a summary of all metrics is returned.
\nValid grouping keys: QUEUE
| ROUTING_PROFILE
| AGENT
\n | CHANNEL
| AGENT_HIERARCHY_LEVEL_ONE
|\n AGENT_HIERARCHY_LEVEL_TWO
| AGENT_HIERARCHY_LEVEL_THREE
|\n AGENT_HIERARCHY_LEVEL_FOUR
| AGENT_HIERARCHY_LEVEL_FIVE
|\n CASE_TEMPLATE_ARN
| CASE_STATUS
|\n contact/segmentAttributes/connect:Subtype
| ROUTING_STEP_EXPRESSION
|\n Q_CONNECT_ENABLED
\n
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. For now, this metric only\n supports the following as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average conversation duration\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
,\n DISCONNECT_REASON
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue
enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Maximum queued time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. This metric only supports the\n following filter keys as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nValid metric filter key: DISCONNECT_REASON
\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile,\n contact/segmentAttributes/connect:Subtype
\nUI name: Callback attempts\n
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. For now, this metric only\n supports the following as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average agent pause time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer talk time\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
,\n DISCONNECT_REASON
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD
\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued time\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: Not available
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD
. This metric only supports the\n following filter keys as INITIATION_METHOD
: INBOUND
|\n OUTBOUND
| CALLBACK
| API
\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate
key in Metric Level Filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts answered in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue
, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison
, you must enter LT
(for\n \"Less than\").
UI name: Contacts abandoned in X seconds\n
\nValid metric filter key: DISCONNECT_REASON
\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback attempts\n
\nSearches the flow modules in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-contact-flow-modules", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContactFlowModules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchContactFlowModulesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the\n Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#ContactFlowModuleSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#ContactFlowModuleSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return contact flow modules.
\nThe name
and description
fields support \"contains\" queries with a\n minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will result in invalid results.
The search criteria to be used to return contact flow modules.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of contact flows which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connect#SearchContactFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchContactFlowsRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchContactFlowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Searches the contact flows in an Amazon Connect instance, with optional\n filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-contact-flows", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ContactFlows", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchContactFlowsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the\n Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous response in\n the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#ContactFlowSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#ContactFlowSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return flows.
\nThe name
and description
fields support \"contains\" queries with a\n minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths\n outside of this range will result in invalid results.
Information about the contact flows.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of contact flows which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchContacts": { "type": "operation", "input": { @@ -31089,7 +31450,7 @@ "UrlExpiryInSeconds": { "target": "com.amazonaws.connect#URLExpiryInSeconds", "traits": { - "smithy.api#documentation": "Optional override for the expiry of the pre-signed S3 URL in seconds.
" + "smithy.api#documentation": "Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is\n 300.
" } }, "FileUseCaseType": { @@ -34296,7 +34657,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified flow.
\nYou can also create and update flows using the Amazon Connect\n Flow language.
", + "smithy.api#documentation": "Updates the specified flow.
\nYou can also create and update flows using the Amazon Connect\n Flow language.
\nUse the $SAVED
alias in the request to describe the SAVED
content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is\n published, $SAVED
needs to be supplied to view saved content that has not been\n published.
Updates specified flow module for the specified Amazon Connect instance.
", + "smithy.api#documentation": "Updates specified flow module for the specified Amazon Connect instance.
\nUse the $SAVED
alias in the request to describe the SAVED
content\n of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED
. Once a contact flow is\n published, $SAVED
needs to be supplied to view saved content that has not been\n published.
Completes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation or the UploadPartCopy\n operation. After successfully uploading all relevant parts of an upload, you call this\n CompleteMultipartUpload
operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts\n in ascending order by part number to create a new object. In the CompleteMultipartUpload \n request, you must provide the parts list and ensure that the parts list is complete.\n The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list,\n you must provide the PartNumber
value and the ETag
value that are returned after that part\n was uploaded.
The processing of a CompleteMultipartUpload request could take several minutes to\n finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK
response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. A request could fail after the\n initial 200 OK
response has been sent. This means that a 200 OK
response can\n contain either a success or an error. The error response might be embedded in the 200 OK
response. \n If you call this API operation directly, make sure to design\n your application to parse the contents of the response and handle it appropriately. If you\n use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply\n error handling per your configuration settings (including automatically retrying the\n request as appropriate). If the condition persists, the SDKs throw an exception (or, for\n the SDKs that don't use exceptions, they return an error).
Note that if CompleteMultipartUpload
fails, applications should be prepared\n to retry any failed requests (including 500 error responses). For more information, see Amazon S3 Error Best\n Practices.
You can't use Content-Type: application/x-www-form-urlencoded
for the \n CompleteMultipartUpload requests. Also, if you don't provide a\n Content-Type
header, CompleteMultipartUpload
can still return a 200\n OK
response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3\n User Guide.
\n\n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload\n and Permissions in the Amazon S3\n User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
Error Code: EntityTooSmall
\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\nHTTP Status Code: 400 Bad Request
\nError Code: InvalidPart
\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified ETag might not have\n matched the uploaded part's ETag.
\nHTTP Status Code: 400 Bad Request
\nError Code: InvalidPartOrder
\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\nHTTP Status Code: 400 Bad Request
\nError Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\nHTTP Status Code: 404 Not Found
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CompleteMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nRemoves an object from a bucket. The behavior depends on the bucket's versioning state:
\nIf bucket versioning is not enabled, the operation permanently deletes the object.
\nIf bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s versionId
in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.
If bucket versioning is suspended, the operation removes the object that has a null versionId
, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null versionId
, and all versions of the object have a versionId
, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a versionId
, you must include the object’s versionId
in the request. For more information about versioning-suspended buckets, see Deleting objects from versioning-suspended buckets.
\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
\n to the versionId
query parameter in the request.
\n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
To remove a specific version, you must use the versionId
query parameter. Using this\n query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3\n sets the response header x-amz-delete-marker
to true.
If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa
request\n header in the DELETE versionId
request. Requests that include\n x-amz-mfa
must use HTTPS. For more information about MFA Delete, see Using MFA Delete in the Amazon S3\n User Guide. To see sample\n requests that use versioning, see Sample\n Request.
\n Directory buckets - MFA delete is not supported by directory buckets.
\nYou can delete objects by explicitly calling DELETE Object or calling \n (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block\n users or accounts from removing or deleting objects from your bucket, you must deny them\n the s3:DeleteObject
, s3:DeleteObjectVersion
, and\n s3:PutLifeCycleConfiguration
actions.
\n Directory buckets - S3 Lifecycle is not supported by directory buckets.
\n\n General purpose bucket permissions - The following permissions are required in your policies when your \n DeleteObjects
request includes specific headers.
\n \n s3:DeleteObject
\n - To delete an object from a bucket, you must always have the s3:DeleteObject
permission.
\n \n s3:DeleteObjectVersion
\n - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion
permission.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following action is related to DeleteObject
:
\n PutObject\n
\nThis operation is not supported by directory buckets.
\nReturns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging
action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging
\n action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\nThe following actions are related to GetObjectTagging
:
\n DeleteObjectTagging\n
\n\n GetObjectAttributes\n
\n\n PutObjectTagging\n
\nThis operation is not supported by directory buckets.
\nReturns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\n To use this operation, you must have permission to perform the\n s3:ListBucketVersions
action. Be aware of the name difference.
A 200 OK
response can contain valid or invalid XML. Make sure to design\n your application to parse the contents of the response and handle it\n appropriately.
To use this operation, you must have READ access to the bucket.
\nThe following operations are related to ListObjectVersions
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nAdds an object to a bucket.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject
to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All\n objects written to the bucket by any account will be owned by the bucket owner.
\n\n Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
\n\n S3 Object Lock - To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\n\n S3 Versioning - When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID\n of that object being stored in Amazon S3. \n You can retrieve, replace, or delete any version of the object. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3\n User Guide. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nThis functionality is not supported for directory buckets.
\n\n General purpose bucket permissions - The following permissions are required in your policies when your \n PutObject
request includes specific headers.
\n \n s3:PutObject
\n - To successfully complete the PutObject
request, you must always have the s3:PutObject
permission on a bucket to add an object\n to it.
\n \n s3:PutObjectAcl
\n - To successfully change the objects ACL of your PutObject
request, you must have the s3:PutObjectAcl
.
\n \n s3:PutObjectTagging
\n - To successfully set the tag-set with your PutObject
request, you\n must have the s3:PutObjectTagging
.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - To ensure that data is not corrupted traversing the network, use the\n Content-MD5
header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, \n you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
\n Directory bucket - This functionality is not supported for directory buckets.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
For more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nThis operation is not supported by directory buckets.
\nThis action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\n \nYou must have the s3:GetObject
permission for this operation. Amazon S3\n Select does not support anonymous access. For more information about permissions,\n see Specifying Permissions in\n a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports\n querying objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more\n information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys)\n in the Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,\n so you don't need to specify anything. For more information about\n server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide.
\nGiven the response size is unknown, Amazon S3 Select streams the response as a\n series of messages and includes a Transfer-Encoding
header with\n chunked
as its value in the response. For more information, see\n Appendix:\n SelectObjectContent\n Response.
The SelectObjectContent
action does not support the following\n GetObject
functionality. For more information, see GetObject.
\n Range
: Although you can specify a scan range for an Amazon S3 Select\n request (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.\n
The GLACIER
, DEEP_ARCHIVE
, and\n REDUCED_REDUNDANCY
storage classes, or the\n ARCHIVE_ACCESS
and DEEP_ARCHIVE_ACCESS
access\n tiers of the INTELLIGENT_TIERING
storage class: You cannot\n query objects in the GLACIER
, DEEP_ARCHIVE
, or\n REDUCED_REDUNDANCY
storage classes, nor objects in the\n ARCHIVE_ACCESS
or DEEP_ARCHIVE_ACCESS
access\n tiers of the INTELLIGENT_TIERING
storage class. For more\n information about storage classes, see Using Amazon S3\n storage classes in the\n Amazon S3 User Guide.
For a list of special errors for this operation, see List of SELECT Object Content Error Codes\n
\nThe following operations are related to SelectObjectContent
:
\n GetObject\n
\n