DisassociateRoutingProfileQueues
Disassociates a set of queues from a routing profile.
Request Syntax
POST /routing-profiles/InstanceId/RoutingProfileId/disassociate-queues HTTP/1.1 Content-type: application/json
{
"QueueReferences": [ {
"Channel": "string", "QueueId": "string"
} ]}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 158)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes RoutingProfileId (p. 158)
The identifier of the routing profile.
Required: Yes
Request Body
The request accepts the following data in JSON format.
QueueReferences (p. 158)
The queues to disassociate from this routing profile.
Type: Array of RoutingProfileQueueReference (p. 466) objects Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DisassociateSecurityKey
DisassociateSecurityKey
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
Request Syntax
DELETE /instance/InstanceId/security-key/AssociationId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
AssociationId (p. 160)
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes InstanceId (p. 160)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
See Also
InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetContactAttributes
GetContactAttributes
Retrieves the contact attributes for the specified contact.
Request Syntax
GET /contact/attributes/InstanceId/InitialContactId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
InitialContactId (p. 162)
The identifier of the initial contact.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes InstanceId (p. 162)
The identifier of the Amazon Connect instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "Attributes": {
"string" : "string"
} }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Attributes (p. 162)
Information about the attributes.
Type: String to string map
Errors
Key Length Constraints: Minimum length of 1. Maximum length of 32767.
Value Length Constraints: Minimum length of 0. Maximum length of 32767.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetCurrentMetricData
GetCurrentMetricData
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Request Syntax
POST /metrics/current/InstanceId HTTP/1.1 Content-type: application/json
{
"CurrentMetrics": [ {
"Groupings": [ "string" ], "MaxResults": number, "NextToken": "string"
}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 164)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
CurrentMetrics (p. 164)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
AGENTS_AFTER_CONTACT_WORK Unit: COUNT
Name in real-time metrics report: ACW
Request Body
AGENTS_AVAILABLE Unit: COUNT
Name in real-time metrics report: Available AGENTS_ERROR
Unit: COUNT
Name in real-time metrics report: Error AGENTS_NON_PRODUCTIVE
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time) AGENTS_ON_CALL
Unit: COUNT
Name in real-time metrics report: On contact AGENTS_ON_CONTACT
Unit: COUNT
Name in real-time metrics report: On contact AGENTS_ONLINE
Unit: COUNT
Name in real-time metrics report: Online AGENTS_STAFFED
Unit: COUNT
Name in real-time metrics report: Staffed CONTACTS_IN_QUEUE
Unit: COUNT
Name in real-time metrics report: In queue CONTACTS_SCHEDULED
Unit: COUNT
Name in real-time metrics report: Scheduled OLDEST_CONTACT_AGE
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS.
For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" },
"Value": 24113.0 }
The actual OLDEST_CONTACT_AGE is 24 seconds.
Request Body
Name in real-time metrics report: Oldest SLOTS_ACTIVE
Unit: COUNT
Name in real-time metrics report: Active SLOTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Availability Type: Array of CurrentMetric (p. 401) objects Required: Yes
Filters (p. 164)
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
Type: Filters (p. 408) object Required: Yes
Groupings (p. 164)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If no Grouping is included in the request, a summary of metrics is returned.
Type: Array of strings
Array Members: Maximum number of 2 items.
Valid Values: QUEUE | CHANNEL Required: No
MaxResults (p. 164)
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No NextToken (p. 164)
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
Type: String Required: No
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"DataSnapshotTime": number, "MetricResults": [
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
DataSnapshotTime (p. 167)
The time at which the metrics were retrieved and cached for pagination.
Type: Timestamp MetricResults (p. 167)
Information about the real-time metrics.
Type: Array of CurrentMetricResult (p. 403) objects NextToken (p. 167)
If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
Examples
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example
The following example retrieves the specified real-time metrics.