update_contact_routing_data ¶

def update_contact_routing_data(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    contact_id: "capo_connect.types.contact_id.ContactId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    queue_time_adjustment_seconds: Optional[
        "capo_connect.types.queue_time_adjustment_seconds.QueueTimeAdjustmentSeconds"
    ] = None,
    queue_priority: Optional[
        "capo_connect.types.queue_priority.QueuePriority"
    ] = None,
    routing_criteria: Optional[
        "capo_connect.types.routing_criteria_input.RoutingCriteriaInput"
    ] = None,
) -> "capo_connect.types.update_contact_routing_data_response.UpdateContactRoutingDataResponse":
    """<p>Updates routing priority and age on the contact (<b>QueuePriority</b> and <b>QueueTimeAdjustmentInSeconds</b>). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html">the Set routing priority / age flow block</a>.</p> <note> <p>Either <b>QueuePriority</b> or <b>QueueTimeAdjustmentInSeconds</b> should be provided within the request body, but not both.</p> </note>

    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>
        contact_id: <p>The identifier of the contact in this instance of Connect Customer. </p>
        queue_time_adjustment_seconds: <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.</p>
        queue_priority: <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.</p>
        routing_criteria: <p>Updates the routing criteria on the contact. These properties can be used to change how a contact is routed within the queue.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        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_active_region_exception.InvalidActiveRegionException: <p>This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.resource_conflict_exception.ResourceConflictException: <p>A resource already has that name.</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.update_contact_routing_data_request.UpdateContactRoutingDataRequest]",
    ) -> OperationResponse[
        "capo_connect.types.update_contact_routing_data_response.UpdateContactRoutingDataResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_contact_routing_data

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateContactRoutingData")
    )
    input_: capo_connect.types.update_contact_routing_data_request.UpdateContactRoutingDataRequest = {
        "instance_id": instance_id,
        "contact_id": contact_id,
    }
    if queue_time_adjustment_seconds is not None:
        input_["queue_time_adjustment_seconds"] = queue_time_adjustment_seconds
    if queue_priority is not None:
        input_["queue_priority"] = queue_priority
    if routing_criteria is not None:
        input_["routing_criteria"] = routing_criteria

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