put_user_status ¶

def put_user_status(
    self,
    user_id: "capo_connect.types.user_id.UserId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    agent_status_id: "capo_connect.types.agent_status_id.AgentStatusId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> "capo_connect.types.put_user_status_response.PutUserStatusResponse":
    """<p>Changes the current status of a user or agent in Connect Customer. If the agent is currently handling a contact, this sets the agent's next status.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html">Agent status</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html">Set your next status</a> in the <i>Connect Customer Administrator Guide</i>.</p>

    Args:
        user_id: <p>The identifier of the user.</p>
        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>
        agent_status_id: <p>The identifier of the agent status.</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_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.put_user_status_request.PutUserStatusRequest]",
    ) -> OperationResponse[
        "capo_connect.types.put_user_status_response.PutUserStatusResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.put_user_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutUserStatus")
    )
    input_: capo_connect.types.put_user_status_request.PutUserStatusRequest = {
        "user_id": user_id,
        "instance_id": instance_id,
        "agent_status_id": agent_status_id,
    }

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