Skip to content

list_routing_profile_manual_assignment_queues

list_routing_profile_manual_assignment_queues(
    instance_id: InstanceId,
    routing_profile_id: RoutingProfileId,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResult100] = None,
) -> ListRoutingProfileManualAssignmentQueuesResponse

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 by an agent who has access to the Worklist app. 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 Connect Customer agent workspace in the Connect Customer 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 Connect Customer endpoints and quotas.

Parameters:

  • instance_id (InstanceId) –

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

  • routing_profile_id (RoutingProfileId) –

    The identifier of the routing profile.

  • next_token (Optional[NextToken], default: None ) –

    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.

  • max_results (Optional[MaxResult100], default: None ) –

    The maximum number of results to return per page.

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def list_routing_profile_manual_assignment_queues(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    routing_profile_id: "capo_connect.types.routing_profile_id.RoutingProfileId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    next_token: Optional["capo_connect.types.next_token.NextToken"] = None,
    max_results: Optional["capo_connect.types.max_result100.MaxResult100"] = None,
) -> "capo_connect.types.list_routing_profile_manual_assignment_queues_response.ListRoutingProfileManualAssignmentQueuesResponse":
    """<p>Lists the manual assignment queues associated with a routing profile.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).</p> <p>For information about how manual contact assignment works in the agent workspace, see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html">Access the Worklist app in the Connect Customer agent workspace</a> in the <i>Connect Customer Administrator Guide</i>. </p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>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.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Connect Customer endpoints and quotas</a>.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        routing_profile_id: <p>The identifier of the routing profile.</p>
        next_token: <p>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.</p>
        max_results: <p>The maximum number of results to return per page.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.list_routing_profile_manual_assignment_queues_request.ListRoutingProfileManualAssignmentQueuesRequest]",
    ) -> OperationResponse[
        "capo_connect.types.list_routing_profile_manual_assignment_queues_response.ListRoutingProfileManualAssignmentQueuesResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.list_routing_profile_manual_assignment_queues

        output, http_response = (
            capo_connect._operations.amazon_connect_service.list_routing_profile_manual_assignment_queues.list_routing_profile_manual_assignment_queues(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListRoutingProfileManualAssignmentQueues"),
    )
    input_: capo_connect.types.list_routing_profile_manual_assignment_queues_request.ListRoutingProfileManualAssignmentQueuesRequest = {
        "instance_id": instance_id,
        "routing_profile_id": routing_profile_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output