Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListRoutingProfileManualAssignmentQueues

Lists the manual assignment queues associated with a routing profile.

Use cases

Following are common uses cases for this API:

This API returns list of queues where contacts can be manually assigned or picked. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).

For information about how manual contact assignment works in the agent workspace, see the Access the Worklist app in the Amazon Connect agent workspace in the Amazon Connect Administrator Guide.

Important things to know

This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.

Endpoints: See Amazon Connect endpoints and quotas.

Request Syntax


GET /routing-profiles/InstanceId/RoutingProfileId/manual-assignment-queues?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

MaxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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.

RoutingProfileId

The identifier of the routing profile.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string",
   "RoutingProfileManualAssignmentQueueConfigSummaryList": [ 
      { 
         "Channel": "string",
         "QueueArn": "string",
         "QueueId": "string",
         "QueueName": "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.

LastModifiedRegion

The AWS Region where this resource was last modified.

Type: String

Pattern: [a-z]{2}(-[a-z]+){1,2}(-[0-9])?

LastModifiedTime

The timestamp when this resource was last modified.

Type: Timestamp

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

RoutingProfileManualAssignmentQueueConfigSummaryList

Information about the manual assignment queues associated with the routing profile.

Type: Array of RoutingProfileManualAssignmentQueueConfigSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example request to retrieve the manual assignment queues

Provide instanceId and routingProfileId for which you want to retrieve the manual assignment queues. You can optionally provide MaxResults parameter.


PUT https://connect.us-west-2.amazonaws.com/routing-profiles/{{instance_id}}/{{routingProfileId}}/manual-assignment-queues HTTP/1.1 Content-type: application/json
{
     "MaxResults": 1
}

Example response to list the manual assignment queues

Lists the manual assignment queues associated with the routingProfileId. Includes only one result since MaxResults parameter was 1. Also includes a NextToken, which can be used as input to fetch the remaining results.


{
    "LastModifiedRegion": "us-west-2",
    "LastModifiedTime": 1.75735455979E9,
    "NextToken": "AQICAHjfUasjUykoODDhNKl2HebKOGiYdLPRfLHRCAwv4m2pxQFto9/8mR5l9ttjq9pNVQmNAAAByzCCAccGCSqGSIb3DQEHBqCCAbgwggG0AgEAMIIBrQYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzA10RtjnfHtBRMGfECARCAggF+PluTA4SojLX+eTvUKdEPCmi7jYLeUmMxLLKWWY2Q853Q0Mqd7rnPo1RKs/cILump20rk2lWa0cX894lTJDxNECkZnOh0EaD4MEd4hZ0eDvDOGzDc7IqHX29U9gtEjFc0Z6AZiBhRDqEHOMQB0egAN9m0HibtmcDzn00TPzBME6MWnBoZBCNiwCZEOpxLoFwc/U2/2oXixa3NFogkJAgRrVWcK5IKYx3DPN5e2rsk0mDylOZGneTNILeSt+zQ95m6bJj5Nm+wFbxr+mpxs8ZPTpwRVTjz/vThFmdmlLv42/uZCkXvq4IULyq2le98cq/nwTXnYtr3e3qQdQ4EHOi+Iettbv+p6TT3UxZIG/CETvGf0CP3uu9F64vG+iOWyDPtamaQjPRvZS+Wtb8awprNBVl9h8jkHZsM5C9+PbZoU7U9qqX67w96BSyxIXzsvs+8Oq5myvifbG+c1QxCnQWzlyXyHmKuRdRgE6rttiqOdw9J4DtwBlmFrC40V7FwCA==",
    "RoutingProfileManualAssignmentQueueConfigSummaryList": [
        {
            "Channel": "VOICE",
            "QueueArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/12345678-1234-5678-aabb-123456abcdef",
            "QueueId": "12345678-1234-5678-aabb-123456abcdef",
            "QueueName": "Q_NAME_1"
        }
    ]
}

Example request to fetch the remaining manual assignment queues associated with a routing profile

Use NextToken from previous response to fetch the remaining manual assignment queues associated with a routing profile.


PUT https://connect.us-west-2.amazonaws.com/routing-profiles/{{instance_id}}/{{routingProfileId}}/manual-assignment-queues HTTP/1.1 Content-type: application/json
{
    "MaxResults": 1,
    "NextToken": "AQICAHjfUasjUykoODDhNKl2HebKOGiYdLPRfLHRCAwv4m2pxQFto9/8mR5l9ttjq9pNVQmNAAAByzCCAccGCSqGSIb3DQEHBqCCAbgwggG0AgEAMIIBrQYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzA10RtjnfHtBRMGfECARCAggF+PluTA4SojLX+eTvUKdEPCmi7jYLeUmMxLLKWWY2Q853Q0Mqd7rnPo1RKs/cILump20rk2lWa0cX894lTJDxNECkZnOh0EaD4MEd4hZ0eDvDOGzDc7IqHX29U9gtEjFc0Z6AZiBhRDqEHOMQB0egAN9m0HibtmcDzn00TPzBME6MWnBoZBCNiwCZEOpxLoFwc/U2/2oXixa3NFogkJAgRrVWcK5IKYx3DPN5e2rsk0mDylOZGneTNILeSt+zQ95m6bJj5Nm+wFbxr+mpxs8ZPTpwRVTjz/vThFmdmlLv42/uZCkXvq4IULyq2le98cq/nwTXnYtr3e3qQdQ4EHOi+Iettbv+p6TT3UxZIG/CETvGf0CP3uu9F64vG+iOWyDPtamaQjPRvZS+Wtb8awprNBVl9h8jkHZsM5C9+PbZoU7U9qqX67w96BSyxIXzsvs+8Oq5myvifbG+c1QxCnQWzlyXyHmKuRdRgE6rttiqOdw9J4DtwBlmFrC40V7FwCA==“
}

Example response to list the remaining manual assignment queues

Excludes the manual assignment queues retrieved by previous request.


{
    "LastModifiedRegion": "us-west-2",
    "LastModifiedTime": 1.75735455979E9,
    "NextToken": null,
    "RoutingProfileManualAssignmentQueueConfigSummaryList": [
        {
            "Channel": "TASK",
            "QueueArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/12345678-1234-5678-aabb-123456abcdef",
            "QueueId": "12345678-1234-5678-aabb-123456abcdef",
            "QueueName": "Q_NAME_2"
        }
    ]
}